Get (HttpRequest function) - Revision history

JAL: /* See also */ add links

2016-03-16T00:10:21Z

JAL: add ID

2016-03-15T18:33:38Z

add ID

← Older revision		Revision as of 18:33, 15 March 2016
Line 166:		Line 166:
	%resp = %req:get(certificateCheck=foo, checkKeepAliveCertificate=true)		%resp = %req:get(certificateCheck=foo, checkKeepAliveCertificate=true)
	... </p>		... </p>
			<div id="exception-eg"></div>
	This variation of the preceding example shows that the <var class="term">certificateChecker</var> function may contain code to throw an exception:		<p>
			This variation of the preceding example shows that the <var class="term">certificateChecker</var> function (<code>foo</code>) may contain code to throw an exception:
			</p>
	<p class="code">class badCert Exception		<p class="code">class badCert Exception
	...		...

JAL: add error code

2015-12-08T21:14:16Z

add error code

Show changes

Mlarocca: /* Usage notes */

2014-07-29T19:04:52Z

Usage notes

← Older revision		Revision as of 19:04, 29 July 2014
Line 48:		Line 48:
	<li>While attempting the HTTP request, a socket/communication error occurred. Examples of such errors include failure to connect to the server host, and communication failure on a TCP/IP send or receive.		<li>While attempting the HTTP request, a socket/communication error occurred. Examples of such errors include failure to connect to the server host, and communication failure on a TCP/IP send or receive.

	For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, $~~STATUS~~ is set to 1, and $~~STATUSD~~ is set to one of these:		For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, $Status is set to 1, and $StatusD is set to one of these:
	<ul>		<ul>
	<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are shown below in [[#Get method return values\|"Get method return values"]].		<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are shown below in [[#Get method return values\|"Get method return values"]].
Line 55:		Line 55:
	The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.

	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$~~STATUS~~]]</var> and <var>[[$~~STATUSD~~]]</var>, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$Status]]</var> and <var>[[$StatusD]]</var>, or both).

	<blockquote class="note">'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).		<blockquote class="note">'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).

JAL at 19:41, 11 September 2013

2013-09-11T19:41:31Z

← Older revision		Revision as of 19:41, 11 September 2013
Line 55:		Line 55:
	The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.

	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking $STATUS and $STATUSD, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$STATUS]]</var> and <var>[[$STATUSD]]</var>, or both).

	'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).		<blockquote class="note">'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).
			<p>
	In general, it is risky to take action based on the distinction between the various non-zero error codes returned by this method.		In general, it is risky to take action based on the distinction between the various non-zero error codes returned by this method. </p>
			</blockquote>
	</ul>		</ul>
			<p>
	For more information about an error, you may want to issue a <var>[[JANUS TRACE]]</var> command with a value of 8 or 15 for the <var>CLSOCK</var> port that is handling your HTTP request.		For more information about an error, you may want to issue a <var>[[JANUS TRACE]]</var> command with a value of 8 or 15 for the <var>CLSOCK</var> port that is handling your HTTP request. </p>

	<li>Under <var class="product">Sirius Mods</var> versions before 7.1, certain "post-oriented" actions were not allowed with an HTTP GET, and resulted in request cancellation if detected by <var>Get</var> function error checking:		<li>Under <var class="product">Sirius Mods</var> versions before 7.1, certain "post-oriented" actions were not allowed with an HTTP GET, and resulted in request cancellation if detected by <var>Get</var> function error checking:
Line 83:		Line 84:
	==Get method return values==		==Get method return values==
	<table>		<table>
	<tr><th>Code</th><th>Meaning</th></tr>		<tr class="head"><th>Code</th><th>Meaning</th></tr>
	<tr><td>0</td>		<tr><td>0</td>
	<td>Communications was successful.</td></tr>		<td>Communications was successful.</td></tr>
Line 152:		Line 153:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about $STATUS and $STATUSD, see the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view Rocket Model 204 User Language Manual]</i>.
	<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method.
	</ul>		</ul>
	{{Template:HttpRequest:Get footer}}		{{Template:HttpRequest:Get footer}}

Dme: /* Syntax terms */

2013-04-15T12:31:22Z

Syntax terms

← Older revision		Revision as of 12:31, 15 April 2013
Line 13:		Line 13:
	</td></tr>		</td></tr>
	<tr><th><var>Port</var></th>		<tr><th><var>Port</var></th>
	<td>A string expression that identifies a previously defined <var>[[JANUS CLSOCK\|CLSOCK]]</var> port. The <var class="term">string</var> default is the <var>[[MASTER]]</var> port, if any is defined. ~~However, if~~ you omit <var class="term">string</var> and no <var>MASTER</var> port is defined, the request is canceled.		<td>A string expression that identifies a previously defined <var>[[JANUS CLSOCK\|CLSOCK]]</var> port. The <var class="term">string</var> default is the <var>[[MASTER]]</var> port, if any is defined. If you omit <var class="term">string</var> and no <var>MASTER</var> port is defined, the request is canceled.
	This is an optional and (as of <var class="product">[[Sirius Mods]]</var> version 7.2) [[Notation conventions for methods#Named parameters\|name allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important).		This is an optional and (as of <var class="product">[[Sirius Mods]]</var> version 7.2) [[Notation conventions for methods#Named parameters\|name allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important).
	</td></tr>		</td></tr>

JAL: /* See also */

2012-10-10T20:43:32Z

JAL2 at 20:51, 17 November 2011

2011-11-17T20:51:33Z

← Older revision		Revision as of 20:51, 17 November 2011
Line 21:		Line 21:
	</td></tr>		</td></tr>
	<tr><th><var>CertificateCheck</var></th>		<tr><th><var>CertificateCheck</var></th>
	<td>This optional ([[Notation conventions for methods#Named parameters\|name required]]) argument invokes an SSL certificate request from the ~~client~~ at the time of the method call.		<td>This optional ([[Notation conventions for methods#Named parameters\|name required]]) argument invokes an SSL certificate request from the server at the time of the method call.
	The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:		The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:
	<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>		<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>

	When a connection is established, the passed function is called with the certificate (copied to a <var>Longstring</var>) as its method object.		When a connection is established, the passed function is called with the certificate (binary content, ASN.1 encoded, copied to a <var>Longstring</var>) as its method object.
	<ul>		<ul>
	<li>If the function returns a <code>True</code>, the request is completed.		<li>If the function returns a <code>True</code>, the request is completed.
Line 77:		Line 77:

	<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.		<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.

	<li>Specifying a <code>CertificateCheck</code> function has no effect if issued over a Janus <var>[[SSL]]</var> port whose definition includes <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERT]]</var> or <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERTR]]</var>. These parameters request a client certificate at connection-establishment time, and a client certificate
	~~may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return).~~

	<li>For more information about the HTTP GET request format and about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.		<li>For more information about the HTTP GET request format and about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.

JAL2 at 16:42, 16 November 2011

2011-11-16T16:42:17Z

← Older revision		Revision as of 16:42, 16 November 2011
Line 77:		Line 77:

	<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.		<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.

			<li>Specifying a <code>CertificateCheck</code> function has no effect if issued over a Janus <var>[[SSL]]</var> port whose definition includes <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERT]]</var> or <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERTR]]</var>. These parameters request a client certificate at connection-establishment time, and a client certificate
			may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return).

	<li>For more information about the HTTP GET request format and about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.		<li>For more information about the HTTP GET request format and about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.

JAL2: /* Syntax terms */

2011-11-16T02:51:04Z

Syntax terms

← Older revision		Revision as of 02:51, 16 November 2011
Line 18:		Line 18:
	<tr><th><var>Cancel</var></th>		<tr><th><var>Cancel</var></th>
	<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.		<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.
	This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you ~~wish~~.		This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.
	</td></tr>		</td></tr>
	<tr><th><var>CertificateCheck</var></th>		<tr><th><var>CertificateCheck</var></th>
Line 29:		Line 29:
	<li>If the function returns a <code>True</code>, the request is completed.		<li>If the function returns a <code>True</code>, the request is completed.
	<li>If the function returns a <code>False</code>, the connection is closed and <var>HttpRequest</var> returns a null.		<li>If the function returns a <code>False</code>, the connection is closed and <var>HttpRequest</var> returns a null.
	~~The~~ <var>Cancel</var> argument setting ~~determines if the request is canceled~~.		In this case, the request is canceled unless the <var>Cancel</var> argument setting prevents it.
	</ul>		</ul>

← Older revision		Revision as of 00:10, 16 March 2016
Line 198:		Line 198:
	==See also==		==See also==
	<ul>		<ul>
	<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method. </li>

			<li>For methods that work with SSL certificates, for example letting you access certificate information, see <var>[[AppendCertificateInfo (Stringlist function)\|AppendCertificateInfo]]</var> and its related <var>Stringlist</var> methods, or see <var>[[X509CertificateToXmlDoc (String function)\|X509CertificateToXmlDoc]]</var> and its related <var>String</var> methods.
	</ul>		</ul>

	{{Template:HttpRequest:Get footer}}		{{Template:HttpRequest:Get footer}}

← Older revision		Revision as of 20:43, 10 October 2012
Line 152:		Line 152:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about $STATUS and $STATUSD, see the ~~<var class="product">Model 204</var>~~ <i>[http://~~cca-int~~.com/~~custsupp~~/~~zips~~/~~Userlang.zip~~ User Language Manual]</i>.		<li>For more information about $STATUS and $STATUSD, see the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view Rocket Model 204 User Language Manual]</i>.
	<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP GET using the <var>[[Send (HttpRequest function)\|Send]]</var> method.
	</ul>		</ul>
	{{Template:HttpRequest:Get footer}}		{{Template:HttpRequest:Get footer}}