name: SimpleHttpModule
class: autohit.call.modules.SimpleHttpModule
This is a simple http module that supports GET.
You must "start" a session before you can "get" anything. Each session will act as a separate client, just like a web browser. Setting your credentials is optional. Be sure to do a "done" when you are done with a session. The module is valid for more than one session, but only one at a time. You can have more than one instance of this module.
method |
"start" |
parameters: |
"address" (REQUIRED): Set the address of the target. Use the DN name only. |
"port" (OPTIONAL): Sets the port. It will default to 80. | |
returns: |
nothing |
description: |
Starts a session. |
method |
"starthttps" |
parameters: |
"address" (REQUIRED): Set the address of the target. Use the DN name only. |
"port" (OPTIONAL): Sets the port. It will default to 443. | |
returns: |
nothing |
description: |
Starts an https session. This will accept an unvalidated cert from the server. |
method |
"get" |
parameters: |
"url" (REQUIRED): Get a document form this
URL. It should include only the path portion of the URL. i.e."/goats/index.html" |
returns: |
A String representing the returned data, encoded per Method.getResponseBodyAsString() from the Apache HttpClient package. |
logs: |
The result line |
description: |
Does an http GET operation. If an authentication request is made by the server, the HttpClient with attempt to complete the authentication. It will use any credentials set by the 'set_credentials" method. |
method |
"post" |
parameters: |
"url" (REQUIRED): Get a document form this
URL. It should include only the path portion of the URL. i.e.."/goats/index.html" |
"table" (REQUIRED): A table in the persist that contains NV data for the post. Technically, it can be empty. Only values that are Strings are used. You can use the *_TABLE calls to construct the table in persist. | |
returns: |
A String representing the returned data, encoded per Method.getResponseBodyAsString() from the Apache HttpClient package. |
logs: |
The result line |
description: |
This does an http POST operation. If an authentication request is made by the server, the HttpClient with attempt to complete the authentication. It will use any credentials set by the 'set_credentials" method. |
method |
"done" |
parameters: |
none |
returns: |
nothing |
description: |
Closes a session and closes the client. |
method |
"timeout" |
parameters: |
"millis" (REQUIRED): The timeout period in milliseconds. |
returns: |
nothing |
description: |
Set the connection timeout period. A session must be started. If one isn't, you'll get a fault. |
AUTOHIT 2003
MODULES DOCUMENTATION
Copyright Erich P Gatejen (c) 1989,1997,2003,2004
See license for details.