ipworksssl
Class Rests

java.lang.Object
  ipworksssl.Rests

public class Rests
extends java.lang.Object

The RESTS Bean can be used to retrieve XML and JSON documents from the World Wide Web.

The RESTS Bean is the SSL-enabled equivalent of the IP*Works! REST Bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The ipworksssl.Rests#config and {@link ipworksssl.Rests#config configuration settings determine which protocols are enabled and at what security level. The {@link ipworksssl.Rests#getSSLCert SSLCert} property is used to select a client certificate if the server is requesting client authentication. The {@link ipworksssl.Rests#config configuration setting, together with the {@link ipworksssl.RestsSSLServerAuthenticationEvent SSLServerAuthentication} event allow you to check the server identity and other security attributes. Finally, the {@link ipworksssl.RestsSSLStatusEvent SSLStatus} event provides information about the SSL handshake.

The RESTS Bean implements a standard REST client with the added option of SSL security.

The bean contains a number of properties that map directly to HTTP request headers. All XML and JSON data received is parsed by the component and provided to the user through properties such as {@link ipworksssl.Rests#getXPath XPath} , {@link ipworksssl.Rests#getXElement XElement} , {@link ipworksssl.Rests#getXText XText} , etc. which allow traversal of the document structure. The {@link ipworksssl.RestsHeaderEvent Header} event will provide the HTTP headers as returned by the server.

To receive a document, call the {@link ipworksssl.Rests#get Get} method with the URL to retrieve specified in the URL parameter. The bean will automatically parse the XML or JSON data, depending on the content type that is returned. Call the {@link ipworksssl.Rests#delete Delete} method to delete a resource specified by the URL parameter.

The other two REST operations are for creating and updating resources. Some people wish to use the {@link ipworksssl.Rests#post Post} method for creating resources and the {@link ipworksssl.Rests#put Put} method for updating resources. Others choose to use the methods vice versa, or just one for both operations. So, you can POST XML or JSON data to the HTTP server by assigning it to the {@link ipworksssl.Rests#getPostData PostData} property and then calling the {@link ipworksssl.Rests#post Post} method. Alternatively, you may use the PUT method instead.

To add authorization credentials to an outgoing request, you should specify the {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} properties. The RESTS Bean supports Basic, Digest, and NTLM authentication through the {@link ipworksssl.Rests#getAuthScheme AuthScheme} property.

Field Summary

static int	authBasic
static int	authDigest
static int	authNegotiate
static int	authNone
static int	authNtlm
static int	authOAuth
static int	authProprietary
static int	frAlways
static int	frNever
static int	frSameScheme

Constructor Summary

Rests()
Creates an instance of Rests Bean.

Rests(java.lang.String runtimeLicense)
Creates an instance of Rests Bean with specified run-time license.

Method Summary

void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Adds a cookie and the corresponding value to the outgoing request headers.
void	addRestsEventListener(RestsEventListener l)
java.lang.String	attr(java.lang.String attrName) Returns the value of the specified attribute.
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a {@link ipworksssl.Rests#config configuration setting.
void	delete(java.lang.String URL) Deletes an object on the server.
void	doEvents() Processes events from the internal message queue.
void	get(java.lang.String URL) Fetches the document using the HTTP GET method.
java.lang.String	getAccept() A list of acceptable MIME types for the request.
java.lang.String	getAuthorization() The Authorization string to be sent to the server.
int	getAuthScheme() The authentication scheme to use when server authorization is required.
java.lang.String	getContentType() Content type for posts and puts.
HTTPCookieList	getCookies() Collection of cookies.
Firewall	getFirewall() A set of properties related to firewall access.
int	getFollowRedirects() Determines what happens when the server issues a redirect.
java.lang.String	getFrom() The email address of the HTTP agent (optional).
java.lang.String	getHTTPMethod() The HTTP method used for the request.
java.lang.String	getIfModifiedSince() A date determining the maximum age of the desired document.
java.lang.String	getLocalFile() The path to a local file for downloading.
java.lang.String	getLocalHost() The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
XMLNamespaceList	getNamespaces() A collection of namespaces in the current stack.
java.lang.String	getOtherHeaders() Other headers as determined by the user (optional).
HeaderList	getParsedHeaders() Collection of headers returned from the last request.
java.lang.String	getPassword() A password if authentication is to be used.
byte[]	getPostData() The data to post with the URL if the POST method is used.
Proxy	getProxy() A set of properties related to proxy access.
java.lang.String	getReferer() Referer URL/document (optional).
Certificate	getSSLAcceptServerCert() Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
Certificate	getSSLCert() The certificate to be used during SSL negotiation.
Certificate	getSSLServerCert() The server certificate for the last established connection.
java.lang.String	getStatusLine() The first line of the last server response.
int	getTimeout() A timeout for the bean.
byte[]	getTransferredData() The contents of the last response from the server.
long	getTransferredDataLimit() The maximum of bytes of data to be transferred.
java.lang.String	getTransferredHeaders() The full set of headers as received from the server.
java.lang.String	getURL() The URL to which information is posted.
java.lang.String	getUser() A user name if authentication is to be used.
XMLAttributeList	getXAttributes() A collection of attributes of the current element.
XMLElementList	getXChildren() Collection of child elements of the current element.
java.lang.String	getXElement() The name of the current element.
java.lang.String	getXErrorPath() An XPath to check the server response for errors.
java.lang.String	getXNamespace() The namespace of the current element.
java.lang.String	getXParent() The parent of the current element.
java.lang.String	getXPath() Provides a way to point to a specific element in the response.
java.lang.String	getXPrefix() The prefix of the current element.
java.lang.String	getXSubTree() A snapshot of the current element in the document.
java.lang.String	getXText() The text of the current element.
boolean	hasXPath(java.lang.String xpath) Determines whether a specific element exists in the document.
void	interrupt() Interrupt the current method.
boolean	isBuildDOM() When True, an internal object model of the XML document is created.
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
boolean	isValidate() When True, the parser checks that the document consists of well-formed XML.
void	post(java.lang.String URL) Posts data to the HTTP server using the HTTP POST method.
void	put(java.lang.String URL) Sends data to the HTTP server using the HTTP PUT method.
void	removeRestsEventListener(RestsEventListener l)
void	reset() Resets the bean
void	setAccept(java.lang.String accept) A list of acceptable MIME types for the request.
void	setAuthorization(java.lang.String authorization) The Authorization string to be sent to the server.
void	setAuthScheme(int authScheme) The authentication scheme to use when server authorization is required.
void	setBuildDOM(boolean buildDOM) When True, an internal object model of the XML document is created.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setContentType(java.lang.String contentType) Content type for posts and puts.
void	setFirewall(Firewall firewall) A set of properties related to firewall access.
void	setFollowRedirects(int followRedirects) Determines what happens when the server issues a redirect.
void	setFrom(java.lang.String from) The email address of the HTTP agent (optional).
void	setHTTPMethod(java.lang.String HTTPMethod) The HTTP method used for the request.
void	setIfModifiedSince(java.lang.String ifModifiedSince) A date determining the maximum age of the desired document.
void	setLocalFile(java.lang.String localFile) The path to a local file for downloading.
void	setLocalHost(java.lang.String localHost) The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
void	setOtherHeaders(java.lang.String otherHeaders) Other headers as determined by the user (optional).
void	setPassword(java.lang.String password) A password if authentication is to be used.
void	setPostData(byte[] postData) The data to post with the URL if the POST method is used.
void	setProxy(Proxy proxy) A set of properties related to proxy access.
void	setReferer(java.lang.String referer) Referer URL/document (optional).
void	setSSLAcceptServerCert(Certificate SSLAcceptServerCert) Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
void	setSSLCert(Certificate SSLCert) The certificate to be used during SSL negotiation.
void	setTimeout(int timeout) A timeout for the bean.
void	setTransferredDataLimit(long transferredDataLimit) The maximum of bytes of data to be transferred.
void	setURL(java.lang.String URL) The URL to which information is posted.
void	setUser(java.lang.String user) A user name if authentication is to be used.
void	setValidate(boolean validate) When True, the parser checks that the document consists of well-formed XML.
void	setXErrorPath(java.lang.String XErrorPath) An XPath to check the server response for errors.
void	setXPath(java.lang.String XPath) Provides a way to point to a specific element in the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authBasic

public static final int authBasic

See Also:

Constant Field Values

authDigest

public static final int authDigest

See Also:

Constant Field Values

authProprietary

public static final int authProprietary

See Also:

Constant Field Values

authNone

public static final int authNone

See Also:

Constant Field Values

authNtlm

public static final int authNtlm

See Also:

Constant Field Values

authNegotiate

public static final int authNegotiate

See Also:

Constant Field Values

authOAuth

public static final int authOAuth

See Also:

Constant Field Values

frNever

public static final int frNever

See Also:

Constant Field Values

frAlways

public static final int frAlways

See Also:

Constant Field Values

frSameScheme

public static final int frSameScheme

See Also:

Constant Field Values

Constructor Detail

Rests

public Rests()

Creates an instance of Rests Bean.

Rests

public Rests(java.lang.String runtimeLicense)

Creates an instance of Rests Bean with specified run-time license.

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

If this property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

setAccept

public void setAccept(java.lang.String accept)
               throws IPWorksSSLException

A list of acceptable MIME types for the request.

If this property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Throws:

IPWorksSSLException

getAuthorization

public java.lang.String getAuthorization()

The Authorization string to be sent to the server.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

setAuthorization

public void setAuthorization(java.lang.String authorization)
                      throws IPWorksSSLException

The Authorization string to be sent to the server.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Throws:

IPWorksSSLException

getAuthScheme

public int getAuthScheme()

The authentication scheme to use when server authorization is required.

This property will tell the bean which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the bean to clear the values of User , Password and {@link ipworksssl.Rests#config .

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksSSLException

The authentication scheme to use when server authorization is required.

This property will tell the bean which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the bean to clear the values of User , Password and {@link ipworksssl.Rests#config .

Throws:

IPWorksSSLException

isBuildDOM

public boolean isBuildDOM()

When True, an internal object model of the XML document is created.

Set BuildDOM to True when you need to browse the current document through XPath .

Validate is automatically set to True when BuildDOM is set to True.

setBuildDOM

public void setBuildDOM(boolean buildDOM)
                 throws IPWorksSSLException

When True, an internal object model of the XML document is created.

Set BuildDOM to True when you need to browse the current document through XPath .

Validate is automatically set to True when BuildDOM is set to True.

Throws:

IPWorksSSLException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksSSLException

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

Throws:

IPWorksSSLException

getContentType

public java.lang.String getContentType()

Content type for posts and puts.

If this property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a Post or Put to the server.

The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded" .

setContentType

public void setContentType(java.lang.String contentType)
                    throws IPWorksSSLException

Content type for posts and puts.

If this property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a Post or Put to the server.

The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded" .

Throws:

IPWorksSSLException

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type httpcookie ) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies are also added to Cookies .

{@link ipworksssl.Rests#config can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size - 1.

getFirewall

public Firewall getFirewall()

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksSSLException

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:

IPWorksSSLException

getFollowRedirects

public int getFollowRedirects()

Determines what happens when the server issues a redirect.

This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an exception.

Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this property is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksSSLException

Determines what happens when the server issues a redirect.

This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an exception.

Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this property is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.

Throws:

IPWorksSSLException

getFrom

public java.lang.String getFrom()

The email address of the HTTP agent (optional).

This property contains the email address of the HTTP agent (optional). If it contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

setFrom

public void setFrom(java.lang.String from)
             throws IPWorksSSLException

The email address of the HTTP agent (optional).

This property contains the email address of the HTTP agent (optional). If it contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

Throws:

IPWorksSSLException

getHTTPMethod

public java.lang.String getHTTPMethod()

The HTTP method used for the request.

This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the bean.

setHTTPMethod

public void setHTTPMethod(java.lang.String HTTPMethod)
                   throws IPWorksSSLException

The HTTP method used for the request.

This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the bean.

Throws:

IPWorksSSLException

isIdle

public boolean isIdle()

The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

getIfModifiedSince

public java.lang.String getIfModifiedSince()

A date determining the maximum age of the desired document.

If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)
                        throws IPWorksSSLException

A date determining the maximum age of the desired document.

If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

Throws:

IPWorksSSLException

getLocalFile

public java.lang.String getLocalFile()

The path to a local file for downloading. If the file exists, it is overwritten.

This property is used when getting a document.

If this property is empty then the received data is provided through TransferredData and the Transfer event.

setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksSSLException

The path to a local file for downloading. If the file exists, it is overwritten.

This property is used when getting a document.

If this property is empty then the received data is provided through TransferredData and the Transfer event.

Throws:

IPWorksSSLException

getLocalHost

public java.lang.String getLocalHost()

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksSSLException

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Throws:

IPWorksSSLException

getNamespaces

public XMLNamespaceList getNamespaces()

A collection of namespaces in the current stack.

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

The default namespace is found at index 0.

This property is not valid for JSON data.

This collection is indexed from 0 to size - 1.

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\ n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the bean beyond what is provided.

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksSSLException

Other headers as determined by the user (optional).

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\ n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the bean beyond what is provided.

Throws:

IPWorksSSLException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last request.

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each header in this collection contains information describing that header.

{@link ipworksssl.Rests#config can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size - 1.

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the ipworksssl.Rests#config config setting in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksSSLException

A password if authentication is to be used.

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the ipworksssl.Rests#config config setting in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:

IPWorksSSLException

getPostData

public byte[] getPostData()

The data to post with the URL if the POST method is used.

This property contains the data to post with the URL if the POST method is used. If this property contains a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP 'Content-Length' header is also added to the request. Its value is the length of the string in PostData .

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to "application/x-www-form-urlencoded".

Example (Performing a Post)

 HTTPControl.ContentType = "application/x-www-form-urlencoded"
 HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
 HTTPControl.Post(myurl) 

setPostData

public void setPostData(byte[] postData)
                 throws IPWorksSSLException

The data to post with the URL if the POST method is used.

This property contains the data to post with the URL if the POST method is used. If this property contains a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP 'Content-Length' header is also added to the request. Its value is the length of the string in PostData .

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to "application/x-www-form-urlencoded".

Example (Performing a Post)

 HTTPControl.ContentType = "application/x-www-form-urlencoded"
 HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
 HTTPControl.Post(myurl) 

Throws:

IPWorksSSLException

getProxy

public Proxy getProxy()

A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

setProxy

public void setProxy(Proxy proxy)
              throws IPWorksSSLException

A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

Throws:

IPWorksSSLException

getReferer

public java.lang.String getReferer()

Referer URL/document (optional).

If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

setReferer

public void setReferer(java.lang.String referer)
                throws IPWorksSSLException

Referer URL/document (optional).

If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

Throws:

IPWorksSSLException

getSSLAcceptServerCert

public Certificate getSSLAcceptServerCert()

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert)
                            throws IPWorksSSLException

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Throws:

IPWorksSSLException

getSSLCert

public Certificate getSSLCert()

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

setSSLCert

public void setSSLCert(Certificate SSLCert)
                throws IPWorksSSLException

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Throws:

IPWorksSSLException

getSSLServerCert

public Certificate getSSLServerCert()

The server certificate for the last established connection.

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

getStatusLine

public java.lang.String getStatusLine()

The first line of the last server response.

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the bean, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as: [HTTP version] [Result Code] [Description].

getTimeout

public int getTimeout()

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Rests#config configuration setting.

The default value for the {@link ipworksssl.Rests#getTimeout Timeout} property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksSSLException

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Rests#config configuration setting.

The default value for the {@link ipworksssl.Rests#getTimeout Timeout} property is 60 (seconds).

Throws:

IPWorksSSLException

getTransferredData

public byte[] getTransferredData()

The contents of the last response from the server.

This property contains the contents of the last response from the server. If the LocalFile is empty, the data is accumulated in TransferredData , and can also be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in this property (by default there is no limit).

getTransferredDataLimit

public long getTransferredDataLimit()

The maximum of bytes of data to be transferred.

This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.

setTransferredDataLimit

public void setTransferredDataLimit(long transferredDataLimit)
                             throws IPWorksSSLException

The maximum of bytes of data to be transferred.

This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.

Throws:

IPWorksSSLException

getTransferredHeaders

public java.lang.String getTransferredHeaders()

The full set of headers as received from the server.

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the bean.

getURL

public java.lang.String getURL()

The URL to which information is posted.

This property specifies the web page to which to post the form data. It is the same as the value specified by '<FORM ACTION=...>' in HTML forms.

setURL

public void setURL(java.lang.String URL)
            throws IPWorksSSLException

The URL to which information is posted.

This property specifies the web page to which to post the form data. It is the same as the value specified by '<FORM ACTION=...>' in HTML forms.

Throws:

IPWorksSSLException

getUser

public java.lang.String getUser()

A user name if authentication is to be used.

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the ipworksssl.Rests#config property in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

setUser

public void setUser(java.lang.String user)
             throws IPWorksSSLException

A user name if authentication is to be used.

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the ipworksssl.Rests#config property in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Rests#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:

IPWorksSSLException

isValidate

public boolean isValidate()

When True, the parser checks that the document consists of well-formed XML.

You can set Validate to False when you want to ignore XML format rules (e.g. while parsing HTML files).

setValidate

public void setValidate(boolean validate)
                 throws IPWorksSSLException

When True, the parser checks that the document consists of well-formed XML.

You can set Validate to False when you want to ignore XML format rules (e.g. while parsing HTML files).

Throws:

IPWorksSSLException

getXAttributes

public XMLAttributeList getXAttributes()

A collection of attributes of the current element.

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of xmlattribute types.

This collection is indexed from 0 to size - 1.

getXChildren

public XMLElementList getXChildren()

Collection of child elements of the current element.

The elements are provided in the collection in the same order they are found in the document.

This collection is indexed from 0 to size - 1.

getXElement

public java.lang.String getXElement()

The name of the current element.

The current element is specified via the XPath property.

getXErrorPath

public java.lang.String getXErrorPath()

An XPath to check the server response for errors.

This property contains an XPath to check the server response for errors. If the XPath exists, an exception will be thrown containing the value of the element at the path.

setXErrorPath

public void setXErrorPath(java.lang.String XErrorPath)
                   throws IPWorksSSLException

An XPath to check the server response for errors.

This property contains an XPath to check the server response for errors. If the XPath exists, an exception will be thrown containing the value of the element at the path.

Throws:

IPWorksSSLException

getXNamespace

public java.lang.String getXNamespace()

The namespace of the current element.

The current element is specified via the XPath property.

getXParent

public java.lang.String getXParent()

The parent of the current element.

The current element is specified via the XPath property.

getXPath

public java.lang.String getXPath()

Provides a way to point to a specific element in the response.

This property provides a way to point to a specific element in the response. This property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'

A particular element name.

[i]

The i-th subelement of the current element.

..

the parent of the current element.

When XPath is set to a valid path, XElement points to the name of the element, with XParent , XNamespace , XPrefix , XChildren , and XText providing other properties of the element. The attributes of the current element will be contained in the Attributes collection .

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath)

 
 

 
 
Document root 
RestControl.XPath = "/"
 
Specific Element 
RestControl.XPath = "/root/SubElement1/SubElement2/"
 
i-th Child 
RestControl.XPath = "/root/[i]"
 
  

For JSON data, this will be the path to a specified value within the document. Since arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. Thus, to reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser. Following is an example:

Simple JSON document

 {
   "firstlevel": {
     "one": "value",
     "two": ["first", "second"],
     "three": "value three"
   }
 } 

Example (Setting JSON XPath)

 
 

 
 
Document root 
RestControl.XPath = "/"
 
Specific Element 
RestControl.XPath = "/json/firstlevel/one/"
 
i-th Child 
RestControl.XPath = "/json/firstlevel/two/[i]/"
 
  

setXPath

public void setXPath(java.lang.String XPath)
              throws IPWorksSSLException

Provides a way to point to a specific element in the response.

This property provides a way to point to a specific element in the response. This property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'

A particular element name.

[i]

The i-th subelement of the current element.

..

the parent of the current element.

When XPath is set to a valid path, XElement points to the name of the element, with XParent , XNamespace , XPrefix , XChildren , and XText providing other properties of the element. The attributes of the current element will be contained in the Attributes collection .

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath)

 
 

 
 
Document root 
RestControl.XPath = "/"
 
Specific Element 
RestControl.XPath = "/root/SubElement1/SubElement2/"
 
i-th Child 
RestControl.XPath = "/root/[i]"
 
  

For JSON data, this will be the path to a specified value within the document. Since arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. Thus, to reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser. Following is an example:

Simple JSON document

 {
   "firstlevel": {
     "one": "value",
     "two": ["first", "second"],
     "three": "value three"
   }
 } 

Example (Setting JSON XPath)

 
 

 
 
Document root 
RestControl.XPath = "/"
 
Specific Element 
RestControl.XPath = "/json/firstlevel/one/"
 
i-th Child 
RestControl.XPath = "/json/firstlevel/two/[i]/"
 
  

Throws:

IPWorksSSLException

getXPrefix

public java.lang.String getXPrefix()

The prefix of the current element.

The current element is specified via the XPath property.

getXSubTree

public java.lang.String getXSubTree()

A snapshot of the current element in the document.

The current element is specified via the XPath property. In order for this property to work you must have the {@link ipworksssl.Rests#config set to true.

getXText

public java.lang.String getXText()

The text of the current element.

The current element is specified via the XPath property.

addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksSSLException

Adds a cookie and the corresponding value to the outgoing request headers.

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

Throws:

IPWorksSSLException

attr

public java.lang.String attr(java.lang.String attrName)
                      throws IPWorksSSLException

Returns the value of the specified attribute.

If the attribute does not exist, an empty string is returned if ipworksssl.Rests#config is set to false, otherwise an exception is thrown.

Please refer to the {@link ipworksssl.Rests#getXAttributes XAttributes} collection for more information.

Throws:

IPWorksSSLException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksSSLException

Sets or retrieves a ipworksssl.Rests#config configuration setting.

{@link ipworksssl.Rests#config Config} is a generic method available in every bean. It is used to set and retrieve {@link ipworksssl.Rests#config configuration settingsfor the bean.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Rests#config Config} method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a {@link ipworksssl.Rests#config configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Rests#config Config} method.

REST Configuration Settings

From

Allows the specification of the email address of the HTTP agent

When this config is set, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.NOTE: This functionality is only available in Java and .NET.

CacheContent

If true, the original XML is saved in a buffer

This config controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is true.

HTTP Configuration Settings

AcceptEncoding

Used to tell the server which types of content encodings the client supports

When {@link ipworksssl.Rests#getAllowHTTPCompression AllowHTTPCompression} is true, the bean adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The bean only supports gzip and deflate decompression algorithms.

AllowHTTPCompression

This property enables HTTP compression for receiving data

This is the same as the {@link ipworksssl.Rests#getAllowHTTPCompression AllowHTTPCompression} property. This setting is exposed here for use by beans that inherit from HTTP.

Authorization

The Authorization string to be sent to the server

If the {@link ipworksssl.Rests#config property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The {@link ipworksssl.Rests#getAuthScheme AuthScheme} property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred

Contains the number of bytes transferred in the response data

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the {@link ipworksssl.RestsTransferEvent Transfer} event, by BytesTransferred .

EncodeURL

If set to true the URL will be encoded by the bean

The default value is false. If set to true the URL passed to the bean will be URL encoded.

FollowRedirects

Determines what happens when the server issues a redirect

This option determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new {@link ipworksssl.Rests#getURL URL} for the object is retrieved automatically every time.If this property is set to 2 (Same Scheme), the new {@link ipworksssl.Rests#getURL URL} is retrieved automatically only if the URL Scheme is the same, otherwise the bean throws an exception.

Note that following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, {@link ipworksssl.Rests#getUser User} and {@link ipworksssl.Rests#getPassword Password} are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A {@link ipworksssl.RestsRedirectEvent Redirect} event is fired for every URL the product is redirected to. In the case of automatic redirections, the {@link ipworksssl.RestsRedirectEvent Redirect} event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the bean throws an exception instead.

Valid options are:

• 0 - Never
• 1 - Always
• 2 - Same Scheme

GetOn302Redirect

If set to true the bean will perform a GET on the new location

The default value is false. If set to true the bean will perform a GET on the new location. Otherwise it will use the same HTTP method again.

HTTPVersion

The version of HTTP used by the bean

Possible values include "1.0", and "1.1". The default is "1.1".

IfModifiedSince

A date determining the maximum age of the desired document

This is the same as the {@link ipworksssl.Rests#getIfModifiedSince IfModifiedSince} property. This setting is exposed here for use by beans that inherit from HTTP.

KeepAlive

Determines whether the HTTP connection is closed after completion of the request

If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting {@link ipworksssl.Rests#getOtherHeaders OtherHeaders} to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.The default value for {@link ipworksssl.Rests#config is false.

MaxHeaders

Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired

This config should be set when the {@link ipworksssl.Rests#getTransferredHeaders TransferredHeaders} collection is to be populated when a {@link ipworksssl.RestsHeaderEvent Header} event has been fired. This value represents the number of headers that are to be saved in the collection.To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxHTTPCookies

Instructs bean to save the amount of cookies specified that are returned by the server when a SetCookie event is fired

This config should be set when populating the {@link ipworksssl.Rests#getCookies Cookies} collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxRedirectAttempts

Limits the number of redirects that are followed in a request

When {@link ipworksssl.Rests#getFollowRedirects FollowRedirects} is set to any value besides frNever the bean will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

OtherHeaders

Other headers as determined by the user (optional)

This configuration option can be set to a string of headers to be appended to the HTTP request headers.The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\ n") .

Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail.

This configuration option is useful for extending the functionality of the bean beyond what is provided.

ProxyAuthorization

The authorization string to be sent to the proxy server

Similar to the {@link ipworksssl.Rests#config config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme .

ProxyAuthScheme

The authorization scheme to be used for the proxy

This is the same as AuthScheme . This setting is provided for use by beans that do not directly expose Proxy properties.

ProxyPassword

A password if authentication is to be used for the proxy

This is the same as Password . This setting is provided for use by beans that do not directly expose Proxy properties.

ProxyPort

Port for the proxy server (default 80)

This is the same as Port . This setting is provided for use by beans that do not directly expose Proxy properties.

ProxyServer

Name or IP address of a proxy server (optional)

This is the same as Server . This setting is provided for use by beans that do not directly expose Proxy properties.

ProxyUser

A user name if authentication is to be used for the proxy

This is the same as User . This setting is provided for use by beans that do not directly expose Proxy properties.

TransferredDataLimit

The maximum number of incoming bytes to be stored by the bean

If {@link ipworksssl.Rests#config is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the bean. If {@link ipworksssl.Rests#config is set to 0, no limits are imposed.

TransferredHeaders

The full set of headers as received from the server

This configuration setting returns the complete set of raw headers as received from the server.

UseChunkedEncoding

Enables or Disables HTTP chunked encoding for transfers

If UseChunkedEncoding is set to true, the bean will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the bean will not use HTTP chunked encoding. The default value is false. Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

ChunkSize

Specifies the chunk size in bytes when using chunked encoding

This is only applicable when {@link ipworksssl.Rests#config is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

UsePlatformHTTPClient

Whether or not to use the platform HTTP client

If True, the component will use the default HTTP client for the platform ( URLConnection in Java or WebRequest in .NET) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

UserAgent

Information about the user agent (browser)

This is the value supplied in the HTTP User-Agent header. The default setting is "/n software IPWorks HTTP/S Component - www.nsoftware.com".Override the default with the name and version of your software.

KerberosSPN

The Service Principal Name for the Kerberos Domain Controller

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

IPPort Configuration Settings

ConnectionTimeout

Sets a separate timeout value for establishing a connection

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the bean will use {@link ipworksssl.Rests#getTimeout Timeout} for establishing a connection and transmitting/receiving data.

FirewallAutoDetect

Tells the bean whether or not to automatically detect and use firewall system settings, if available

This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallHost

Name or IP address of firewall (optional)

If a {@link ipworksssl.Rests#config is given, requested connections will be authenticated through the specified firewall when connecting.If the {@link ipworksssl.Rests#config setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the {@link ipworksssl.Rests#config setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener

If true, the component binds to a SOCKS firewall as a server (IPPort only)

This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. {@link ipworksssl.Rests#getRemoteHost RemoteHost} and {@link ipworksssl.Rests#getRemotePort RemotePort} are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore {@link ipworksssl.Rests#getRemoteHost RemoteHost} , and it is recommended that {@link ipworksssl.Rests#getRemoteHost RemoteHost} be set to empty string in this case.

{@link ipworksssl.Rests#getRemotePort RemotePort} is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the {@link ipworksssl.RestsConnectionStatusEvent ConnectionStatus} event.

The connection to the firewall is made by calling the {@link ipworksssl.Rests#connect Connect} method.

FirewallPassword

Password to be used if authentication is to be used when connecting through the firewall

If {@link ipworksssl.Rests#config is specified, the {@link ipworksssl.Rests#config and {@link ipworksssl.Rests#config settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort

The TCP port for the FirewallHost;

Note that the {@link ipworksssl.Rests#config is set automatically when {@link ipworksssl.Rests#config is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType

Determines the type of firewall to connect through

The appropriate values are as follows:

0

No firewall (default setting).

1

Connect through a tunneling proxy. {@link ipworksssl.Rests#config is set to 80.

2

Connect through a SOCKS4 Proxy. {@link ipworksssl.Rests#config is set to 1080.

3

Connect through a SOCKS5 Proxy. {@link ipworksssl.Rests#config is set to 1080.

NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser

A user name if authentication is to be used connecting through a firewall

If the {@link ipworksssl.Rests#config is specified, the {@link ipworksssl.Rests#config and {@link ipworksssl.Rests#config settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime

The inactivity time in milliseconds before a TCP keep-alive packet is sent

When set, {@link ipworksssl.Rests#config will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval

The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received

When set, {@link ipworksssl.Rests#config will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by {@link ipworksssl.Rests#config . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger

When set to True, connections are terminated gracefully

This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if {@link ipworksssl.Rests#config is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, {@link ipworksssl.Rests#config is a positive value, the system will attempt to send pending data until the specified {@link ipworksssl.Rests#config is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime

Time in seconds to have the connection linger

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost

The name of the local host through which connections are initiated or accepted

The {@link ipworksssl.Rests#getLocalHost LocalHost} setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the {@link ipworksssl.Rests#getLocalHost LocalHost} setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort

The TCP port in the local host where the bean binds

This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by {@link ipworksssl.Rests#getLocalPort LocalPort} after the connection is established.

{@link ipworksssl.Rests#getLocalPort LocalPort} cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength

The maximum amount of data to accumulate when no EOL is found

{@link ipworksssl.Rests#config is the size of an internal buffer, which holds received data while waiting for an {@link ipworksssl.Rests#getEOL EOL} string.If an {@link ipworksssl.Rests#getEOL EOL} string is found in the input stream before {@link ipworksssl.Rests#config bytes are received, the {@link ipworksssl.RestsDataInEvent DataIn} event is fired with the EOL parameter set to True, and the buffer is reset.

If no {@link ipworksssl.Rests#getEOL EOL} is found, and {@link ipworksssl.Rests#config bytes are accumulated in the buffer, the {@link ipworksssl.RestsDataInEvent DataIn} event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for {@link ipworksssl.Rests#config is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate

The transfer rate limit in bytes per second

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

TCPKeepAlive

Determines whether or not the keep alive socket option is enabled

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set {@link ipworksssl.Rests#config and {@link ipworksssl.Rests#config to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6

Whether or not to use IPv6

By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.

CloseStreamAfterTransfer

If true, the component will close the upload or download stream after the transfer

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

TcpNoDelay

Whether or not to delay when sending packets

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

SSL Configuration Settings

ReuseSSLSession

Determines if the SSL session is reused

If set to true, the component will reuse the context if and only if the following criteria are met:

• The target host name is the same.
• The system cache entry has not expired (default timeout is 10 hours).
• The application process that calls the function is the same.
• The logon session is the same.
• The instance of the component is the same.

SSLCipherStrength

The minimum cipher strength used for bulk encryption

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the {@link ipworksssl.RestsSSLStatusEvent SSLStatus} event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Rests#config config setting.

SSLEnabledProtocols

Used to enable/disable the supported security protocols

Used to enable/disable the supported security protocols.Not all supported protocols are enabled by default (the value of this setting is 192). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.2

3072 (Hex C00)

TLS1.1

768 (Hex 300)

TLS1

192 (Hex C0) (Default)

SSL3

48 (Hex 30)

SSL2

12 (Hex 0C)

Please note that although a number of sites still support SSL2, it is usually a good idea to disable it because of potential security vulnerabilities.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Rests#config config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

SSLProvider

The name of the security provider to use

Change this setting to use security providers other than the system default.Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

SSLSecurityFlags

Flags that control certificate verification

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001

Ignore time validity status of certificate.

0x00000002

Ignore time validity status of CTL.

0x00000004

Ignore non-nested certificate times.

0x00000010

Allow unknown Certificate Authority.

0x00000020

Ignore wrong certificate usage.

0x00000100

Ignore unknown certificate revocation status.

0x00000200

Ignore unknown CTL signer revocation status.

0x00000400

Ignore unknown Certificate Authority revocation status.

0x00000800

Ignore unknown Root revocation status.

0x00008000

Allow test Root certificate.

0x00004000

Trust test Root certificate.

0x80000000

Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLContextProtocol

The protocol used when getting an SSLContext instance

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLTrustManagerFactoryAlgorithm

The algorithm to be used to create a TrustManager through TrustManagerFactory

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

SSLEnabledCipherSuites

The cipher suite to be used in an SSL negotiation

The enabled cipher suites to be used in SSL negotiation.By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values:

 obj.config("SSLEnabledCipherSuites=*");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); 

Possible values include:

• SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_RC4_128_SHA
• SSL_RSA_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_WITH_DES_CBC_SHA
• SSL_RSA_WITH_NULL_MD5
• SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
• SSL_DHE_RSA_WITH_DES_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
• SSL_RSA_WITH_NULL_SHA
• SSL_DH_anon_WITH_RC4_128_MD5
• SSL_RSA_WITH_RC4_128_MD5
• SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_ECDSA_WITH_NULL_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA256
• TLS_ECDH_anon_WITH_RC4_128_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_EXPORT_WITH_RC4_40_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_RC4_128_SHA
• TLS_ECDH_ECDSA_WITH_RC4_128_SHA
• TLS_ECDH_anon_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• TLS_RSA_WITH_NULL_SHA256
• TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
• TLS_KRB5_WITH_RC4_128_MD5
• TLS_ECDHE_ECDSA_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_RC4_128_SHA
• TLS_EMPTY_RENEGOTIATION_INFO_SCSV
• TLS_KRB5_WITH_3DES_EDE_CBC_MD5
• TLS_KRB5_WITH_RC4_128_SHA
• TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_NULL_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_DES_CBC_MD5
• TLS_KRB5_EXPORT_WITH_RC4_40_MD5
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
• TLS_ECDH_anon_WITH_AES_128_CBC_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_WITH_DES_CBC_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_NULL_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA

SSLEnabledCipherSuites is used together with SSLCipherStrength .

Note: This configuration setting is available only in .NET and Java.

SSLAlgorithmList

A string that controls the cipher algorithms to be used by SSL

This configuration option takes a semicolon (;) delimited list of cipher algorithms to specify what algorithms may be used by SSL. This option can be used in conjunction with SSLEnabledProtocols to control which ciphers are used.For example:

 obj.Config("SSLEnabledProtocols=3072"); // TLS1.2  (supports SHA_256)
   obj.Config("SSLAlgorithmList=CALG_SHA_256;CALG_MD5"); 

Possible values include:

• CALG_3DES
• CALG_3DES_112
• CALG_AES
• CALG_AES_128
• CALG_AES_192
• CALG_AES_256
• CALG_AGREEDKEY_ANY
• CALG_CYLINK_MEK
• CALG_DES
• CALG_DESX
• CALG_DH_EPHEM
• CALG_DH_SF
• CALG_DSS_SIGN
• CALG_ECDH
• CALG_ECDSA
• CALG_ECMQV
• CALG_HASH_REPLACE_OWF
• CALG_HUGHES_MD5
• CALG_HMAC
• CALG_KEA_KEYX
• CALG_MAC
• CALG_MD2
• CALG_MD4
• CALG_MD5
• CALG_NO_SIGN
• CALG_OID_INFO_CNG_ONLY
• CALG_OID_INFO_PARAMETERS
• CALG_PCT1_MASTER
• CALG_RC2
• CALG_RC4
• CALG_RC5
• CALG_RSA_KEYX
• CALG_RSA_SIGN
• CALG_SCHANNEL_ENC_KEY
• CALG_SCHANNEL_MAC_KEY
• CALG_SCHANNEL_MASTER_HASH
• CALG_SEAL
• CALG_SHA
• CALG_SHA1
• CALG_SHA_256
• CALG_SHA_384
• CALG_SHA_512
• CALG_SKIPJACK
• CALG_SSL2_MASTER
• CALG_SSL3_MASTER
• CALG_SSL3_SHAMD5
• CALG_TEK
• CALG_TLS1_MASTER
• CALG_TLS1PRF

This option is only valid in Windows.

Socket Configuration Settings

AbsoluteTimeout

Determines whether timeouts are inactivity timeouts or absolute timeouts

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.Note: This option is not valid for UDP ports.

FirewallData

Used to send extra data to the firewall

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize

The size in bytes of the incoming queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize

The size in bytes of the outgoing queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable

Tells the bean whether or not a message loop is available for processing events

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

UseDaemonThreads

Whether threads created by the bean are daemon threads

If set to True, when the bean creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the bean will not set the Daemon property on the created thread.

Throws:

IPWorksSSLException

delete

public void delete(java.lang.String URL)
            throws IPWorksSSLException

Deletes an object on the server.

This method is used to delete an object at the URL specified by using the HTTP DELETE method. The server response text is received through the Transfer event, and the HTTP response headers through the Header event. If LocalFile is not empty the data (not the headers) is written there as well. The user should normally have assigned correct values to User and Password or {@link ipworksssl.Rests#config .

Throws:

IPWorksSSLException

doEvents

public void doEvents()
              throws IPWorksSSLException

Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:

IPWorksSSLException

get

public void get(java.lang.String URL)
         throws IPWorksSSLException

Fetches the document using the HTTP GET method.

This method fetches the document using the HTTP GET method. The document contents are delivered to the component and parsed. The XPath , XElement , XText , etc. or the TransferredData property can then be used to traverse the data. The HTTP response headers are returned through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.

Throws:

IPWorksSSLException

hasXPath

public boolean hasXPath(java.lang.String xpath)
                 throws IPWorksSSLException

Determines whether a specific element exists in the document.

You can use the HasXPath method to determine if a particular XPath exists before setting it with XPath .

The XPath property implements a subset of the XML XPath specification, allowing you to point to specific elements in the document.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

Setting the XPath property to an XPath that does not exist will cause an error.

Throws:

IPWorksSSLException

interrupt

public void interrupt()
               throws IPWorksSSLException

Interrupt the current method.

If there is no method in progress, Interrupt simply returns, doing nothing.

Throws:

IPWorksSSLException

post

public void post(java.lang.String URL)
          throws IPWorksSSLException

Posts data to the HTTP server using the HTTP POST method.

This method posts data to the HTTP server using the HTTP POST method. The posted data is taken from the PostData property.

The server response text is parsed by the component, and may be accessed through properties like XPath , XElement , XText , etc. or the TransferredData property. The HTTP response headers are received through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.

Throws:

IPWorksSSLException

put

public void put(java.lang.String URL)
         throws IPWorksSSLException

Sends data to the HTTP server using the HTTP PUT method.

This method sends data to the HTTP server using the HTTP PUT method. The data is taken from the PostData property.

The server response text is parsed by the component, and may be accessed using properties like XPath , XElement , XText , etc. or the TransferredData property. The HTTP response headers are received through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.

The user should normally have assigned correct values to User and Password or {@link ipworksssl.Rests#config .

Throws:

IPWorksSSLException

reset

public void reset()
           throws IPWorksSSLException

Resets the bean

This method resets all HTTP headers to default values and resets the XML parser.

Throws:

IPWorksSSLException

addRestsEventListener

public void addRestsEventListener(RestsEventListener l)
                           throws java.util.TooManyListenersException

Throws:

java.util.TooManyListenersException

removeRestsEventListener

public void removeRestsEventListener(RestsEventListener l)