Web Services - Revision history

Thomas Linder Puls: IISAPI removed

2024-09-11T09:45:48Z

IISAPI removed

← Older revision		Revision as of 11:45, 11 September 2024
Line 3:		Line 3:
	The emphasis is on the Visual Prolog back-end, which implement a JSON-RPC web service. The HTML/JavaScript code is mainly included to make the example self-contained and to illustrate how front-end code can interact with a Visual Prolog web service.		The emphasis is on the Visual Prolog back-end, which implement a JSON-RPC web service. The HTML/JavaScript code is mainly included to make the example self-contained and to illustrate how front-end code can interact with a Visual Prolog web service.

	It is described how the ~~same~~ service can:		It is described how the service can run as a stand-alone HTTP/HTTPS server

	* Run as a stand-alone HTTP/HTTPS server		Also notice that this tutorial will not consider SOAP at all.
	* Run embedded as an ISAPI extension in Microsoft Information Services (IIS)

	~~Notice that web services requires~~ the '''~~commercial edition~~''' ~~of Visual Prolog.~~		The tutorial corresponds to the '''webService''' examples.
	~~Also notice that this tutorial will not consider SOAP at all~~.

	~~The tutorial corresponds to the '''webRPC''' examples~~ in ~~the commercial edition (IDE: '''Help~~ -~~>Install Examples...''')~~.		A web service can as described here be implemented as a stand alone server. Tt can also be implemented as an IISAPI plug-in, but we recommend using a standalone instead of using an IISAPI plug-in.

	=== Overview ===		=== Overview ===
Line 235:		Line 233:
	<vp>reqQueue_file</vp> is a <vp>requestQueue_file</vp> which uses <vp>fileMapper</vp> to map the requests to a file name and an associated <vp>ContentType</vp>, the <vp>requestQueue_file</vp> will then handle the transfer of the file.		<vp>reqQueue_file</vp> is a <vp>requestQueue_file</vp> which uses <vp>fileMapper</vp> to map the requests to a file name and an associated <vp>ContentType</vp>, the <vp>requestQueue_file</vp> will then handle the transfer of the file.

	==== Server configuration: netsh ====		=== Server configuration: netsh ===

	The example runs smoothly because it uses port 5555 on localhost. Normally you will however want to run applications on port 80 for http and 443 for https, and that will cause some security problems.		The example runs smoothly because it uses port 5555 on localhost. Normally you will however want to run applications on port 80 for http and 443 for https, and that will cause some security problems.
Line 259:		Line 257:

	Notice that the example program is a console program. In an larger scale context it would seem better to create a genuine windows service. Visual Prolog has a template project for creating services, but that subject is outside the scope of this tutorial.		Notice that the example program is a console program. In an larger scale context it would seem better to create a genuine windows service. Visual Prolog has a template project for creating services, but that subject is outside the scope of this tutorial.

	~~=== IISAPI plug-in ===~~

	As illustrated by the <vp>jsonRpcService_isApi</vp> program the <vp>testService</vp> (supporting the <vp>rpcService</vp>) can also be used in an ISAPI dll, which can be used by the Internet Information Services to run the RPC requests.

	<vp>jsonRpcService_isApi</vp> does not deal with file requests, because it is more natural to leave that to the IIS itself. The dll code is actually rather trivial, the key issue is the IIS configuration.

	~~The configuration of the IIS has been put into its own tutorial, see [[IIS configuration]].~~

	=== Existing GUI program ===		=== Existing GUI program ===

Thomas Linder Puls: Serial number => ThumbPrint + certstorename=MY

2021-09-14T13:14:39Z

Serial number => ThumbPrint + certstorename=MY

← Older revision		Revision as of 15:14, 14 September 2021
Line 310:		Line 310:
	If run "Manage Computer Certificates" you will find it in "Personal\Certificates" and if you copy it to "Trusted Root Certificates\Certificates" (it must be both places) then you computer will trust it.		If run "Manage Computer Certificates" you will find it in "Personal\Certificates" and if you copy it to "Trusted Root Certificates\Certificates" (it must be both places) then you computer will trust it.

	Double clicking the certificate and viewing the details will reveal the ~~Serial Number~~ which is the identifier of the certificate.		Double clicking the certificate and viewing the details will reveal the ThumbPrint which is the identifier of the certificate.

	You will use this identifier to tie the certificate to the connection. This is done by adding an "sslcert" record with "netsh":		You will use this identifier to tie the certificate to the connection. This is done by adding an "sslcert" record with "netsh":

	netsh http add sslcert hostnameport=demo.localhost.xx:443 certhash=19bde81e1b443b28fe75553cc52e0d8ba99978f1 appid={00112233-4455-6677-8899-AABBCCDDEEFF}		netsh http add sslcert hostnameport=demo.localhost.xx:443 certhash=19bde81e1b443b28fe75553cc52e0d8ba99978f1 appid={00112233-4455-6677-8899-AABBCCDDEEFF} certstorename=MY

	The "certhash" identifies certificate (the ~~Serial number~~ in the certificate details), the purpose of the "appid" is a unclear to me but it is in any case a GUID.		The "certhash" identifies certificate (the ThumpPrint in the certificate details), the purpose of the "appid" is a unclear to me but it is in any case a GUID.

	To make test with "real" server names like "demo.localhost.xx" you can make an 127.0.0.1 entry in the "hosts" file (C:\Windows\System32\Drivers\etc\hosts):		To make test with "real" server names like "demo.localhost.xx" you can make an 127.0.0.1 entry in the "hosts" file (C:\Windows\System32\Drivers\etc\hosts):

Thomas Linder Puls: hosts

2020-12-14T22:17:43Z

hosts

← Older revision		Revision as of 00:17, 15 December 2020
Line 318:		Line 318:
	The "certhash" identifies certificate (the Serial number in the certificate details), the purpose of the "appid" is a unclear to me but it is in any case a GUID.		The "certhash" identifies certificate (the Serial number in the certificate details), the purpose of the "appid" is a unclear to me but it is in any case a GUID.

	To make test with "real" server names like "demo.localhost.xx" you can ~~edit the~~ make a 127.0.0.1 entry in the hosts file (C:\Windows\System32\Drivers\etc\hosts):		To make test with "real" server names like "demo.localhost.xx" you can make an 127.0.0.1 entry in the "hosts" file (C:\Windows\System32\Drivers\etc\hosts):
	...		...
	# localhost name resolution is handled within DNS itself.		# localhost name resolution is handled within DNS itself.

Thomas Linder Puls: netsh

2020-12-14T22:14:27Z

netsh

← Older revision		Revision as of 00:14, 15 December 2020
Line 229:		Line 229:
	In the example server we create two request queues each having a single URL group attached, and each of these URL groups having one URL pattern. Effectively:		In the example server we create two request queues each having a single URL group attached, and each of these URL groups having one URL pattern. Effectively:
	* <vp>reqQueue_rpc</vp> receives requests of the form '''http:<nowiki />//localhost:5555/jsonrpc/<something>''', and		* <vp>reqQueue_rpc</vp> receives requests of the form '''http:<nowiki />//localhost:5555/jsonrpc/<something>''', and
	* <vp>reqQueue_file</vp> receives requests of the form '''http:<nowiki />//localhost:5555~~/file~~/<something>''''		* <vp>reqQueue_file</vp> receives requests of the form '''http:<nowiki />//localhost:5555/<something>''''

	<vp>reqQueue_rpc</vp> is a <vp>requestQueue_rpc</vp> handles RPC requests by feeding them to our <vp>testService</vp>.		<vp>reqQueue_rpc</vp> is a <vp>requestQueue_rpc</vp> handles RPC requests by feeding them to our <vp>testService</vp>.
Line 248:		Line 248:

	{{Example\|This will give an idea of what to do (in a cmd prompt):		{{Example\|This will give an idea of what to do (in a cmd prompt):
	<source lang="text">>netsh http add urlacl http://www.something.com:80~~/file/ user=SMT\serviceuser~~		<source lang="text">>netsh http add urlacl http://www.something.com:80/ user=SMT\serviceuser</source>
	~~>netsh http add urlacl http://www.something.com:80/jsonrpc~~/ user=SMT\serviceuser</source>
	'''Notice''' that the cmd prompt be run "as Administrator" to make modifications.		'''Notice''' that the cmd prompt be run "as Administrator" to make modifications.
	If you just write "netsh" it will go into a prompt mode where change to http mode and then just write http commands		If you just write "netsh" it will go into a prompt mode where change to http mode and then just write http commands
	<source lang="text">>netsh		<source lang="text">>netsh
	netsh>http		netsh>http
	netsh http>add urlacl http://www.something.com:80~~/file/ user=SMT\serviceuser~~		netsh http>add urlacl http://www.something.com:80/ user=SMT\serviceuser
	~~netsh http>add urlacl http://www.something.com:80/jsonrpc~~/ user=SMT\serviceuser
	netsh http>exit</source>}}		netsh http>exit</source>}}

Thomas Linder Puls: remove file level

2020-12-14T22:10:33Z

remove file level

← Older revision		Revision as of 00:10, 15 December 2020
Line 17:		Line 17:
	In this section we will try to describe the overall picture of the entire application and the way it works. What takes place is actually rather complex, but fortunately most of the complexity is handled automatically. An understanding of the overall process including knowledge of some of the complexity will however make it easier to understand what needs to be done and why.		In this section we will try to describe the overall picture of the entire application and the way it works. What takes place is actually rather complex, but fortunately most of the complexity is handled automatically. An understanding of the overall process including knowledge of some of the complexity will however make it easier to understand what needs to be done and why.

	The overall work flow of the example application is as follows: The user browses (in a web browser) to the page '''http:<nowiki />//<server>~~/file~~/test.htm''' (or '''http:<nowiki />//<server>~~/file~~/calendar.htm'''), and the server returns the corresponding file to the browser. The browser evaluates the contents of the file, which may result in additional requests for several cascading style scripts (css) files, JavaScript (js) files, images, etc. Furthermore, the HTML file contains embedded JavaScript code, which will make remote procedure calls ('''RPC''') to the web server. The server will execute the corresponding procedures and return the result to the browser. Finally, the embedded JavaScript uses the returned data to update the HTML contents of the browser.		The overall work flow of the example application is as follows: The user browses (in a web browser) to the page '''http:<nowiki />//<server>/test.htm''' (or '''http:<nowiki />//<server>/calendar.htm'''), and the server returns the corresponding file to the browser. The browser evaluates the contents of the file, which may result in additional requests for several cascading style scripts (css) files, JavaScript (js) files, images, etc. Furthermore, the HTML file contains embedded JavaScript code, which will make remote procedure calls ('''RPC''') to the web server. The server will execute the corresponding procedures and return the result to the browser. Finally, the embedded JavaScript uses the returned data to update the HTML contents of the browser.

	The communication between the client and the server is performed by means of the HTTP (or HTTPS) protocol. So on the server side we need an HTTP server, which can both return files and implement remote procedure calls. The program in '''jsonRpcService_httpApi''' runs the service as a stand alone HTTP server that both handles file requests and implements the remote procedure calls. The program in '''jsonRpcService_isApi''' implements the remote procedure calls as an ISAPI plug-in, the IIS (Microsoft Internet Information Services) is configured to handle the file requests and to use the ISAPI for the remote procedure calls.		The communication between the client and the server is performed by means of the HTTP (or HTTPS) protocol. So on the server side we need an HTTP server, which can both return files and implement remote procedure calls. The program in '''jsonRpcService_httpApi''' runs the service as a stand alone HTTP server that both handles file requests and implements the remote procedure calls. The program in '''jsonRpcService_isApi''' implements the remote procedure calls as an ISAPI plug-in, the IIS (Microsoft Internet Information Services) is configured to handle the file requests and to use the ISAPI for the remote procedure calls.

Thomas Linder Puls: Additional notes on certificates

2020-12-14T22:08:41Z

Additional notes on certificates

@@ Line 295: / Line 295: @@
 === HTTPS ===
-HTTPS is the HTTP protocol used over a secure socket.  Both the IIS and the stand alone HTTP Server can use HTTPS.  To use HTTPS the server computer must have a certificate.  It is possible to create a certificate yourself, but a self created certificate is "untrusted" will therefore cause security notifications.  This is sufficient for testing and development purposes, but for real scale purposes you will have to aquire a trusted certificate.
+Finally a set if brief notes about Secure connections (SSL/TLS).
 In brief a trusted certificate have to be obtained from a trusted provider.  The trust lies in three things:
@@ Line 304: / Line 306: @@
 Notice that HTTPS by default uses port 443 (and HTTP uses port 80), and that you have to write "https" in the places where you would otherwise write "http" (e.g. '''https:<nowiki />//+:443/mypath''')
-It is outside the scope of this tutorial to consider certificates any further.
+For test purposes you can create self signed certificates using the power shell command "New-SelfSignedSertificate":
 === See also ===

Thomas Linder Puls: /* Visual Prolog Client */ grammar

2019-01-31T15:48:26Z

Visual Prolog Client: grammar

← Older revision		Revision as of 17:48, 31 January 2019
Line 280:		Line 280:
	=== Visual Prolog Client ===		=== Visual Prolog Client ===

	This tutorial and the mentioned examples has focused on the Visual Prolog server side, using a web browser as client side. But sometimes a Visual Prolog program may need to access a web service as client. The example <vp>jsonRpcClient</vp> ~~illustrated~~ how this can be done. The method is quite similar to the one used in JavaScript:		This tutorial and the mentioned examples has focused on the Visual Prolog server side, using a web browser as client side. But sometimes a Visual Prolog program may need to access a web service as client. The example <vp>jsonRpcClient</vp> illustrates how this can be done. The method is quite similar to the one used in JavaScript:

	* Create a <vp>jsonRpcRequest</vp> object, with method name and parameters		* Create a <vp>jsonRpcRequest</vp> object, with method name and parameters

Thomas Linder Puls: Fix

2017-11-07T09:39:57Z

Fix

← Older revision		Revision as of 11:39, 7 November 2017
Line 313:		Line 313:

	[[Category:Internet]]		[[Category:Internet]]
	~~[[Category:Tutorials]]~~

Thomas Linder Puls: Fix

2017-11-07T09:39:37Z

Fix

← Older revision		Revision as of 11:39, 7 November 2017
Line 46:		Line 46:
	The third member is one of these:		The third member is one of these:
	* <vp>result</vp> (implying that the call succeeded) The result of the procedure call		* <vp>result</vp> (implying that the call succeeded) The result of the procedure call
	* <vp>error</vp> (implying that the call ~~succeeded~~) An object describing the error which occurred		* <vp>error</vp> (implying that the call failed) An object describing the error which occurred

	=== Client side ===		=== Client side ===
Line 312:		Line 312:
	* Microsoft's [http://msdn.microsoft.com/en-us/library/windows/desktop/aa364510(v=vs.85).aspx HTTP Server API]		* Microsoft's [http://msdn.microsoft.com/en-us/library/windows/desktop/aa364510(v=vs.85).aspx HTTP Server API]

			[[Category:Internet]]
	[[Category:Tutorials]]		[[Category:Tutorials]]

Thomas Linder Puls: Reverted edits by Thomas Linder Puls (talk) to last revision by Søren Elverlin

2017-11-07T09:37:02Z

Reverted edits by Thomas Linder Puls (talk) to last revision by Søren Elverlin

← Older revision		Revision as of 11:37, 7 November 2017
Line 46:		Line 46:
	The third member is one of these:		The third member is one of these:
	* <vp>result</vp> (implying that the call succeeded) The result of the procedure call		* <vp>result</vp> (implying that the call succeeded) The result of the procedure call
	* <vp>error</vp> (implying that the call ~~failed~~) An object describing the error which occurred		* <vp>error</vp> (implying that the call succeeded) An object describing the error which occurred

	=== Client side ===		=== Client side ===
Line 312:		Line 312:
	* Microsoft's [http://msdn.microsoft.com/en-us/library/windows/desktop/aa364510(v=vs.85).aspx HTTP Server API]		* Microsoft's [http://msdn.microsoft.com/en-us/library/windows/desktop/aa364510(v=vs.85).aspx HTTP Server API]

	~~[[Category:Internet]]~~
	[[Category:Tutorials]]		[[Category:Tutorials]]