ipworks
Class Rest

java.lang.Object
  |
  +--ipworks.Rest

public class Rest

extends java.lang.Object

The REST bean can be used to retrieve xml documents from the World Wide Web.

The REST bean implements a standard REST client .

The bean contains a number of properties that map directly to HTTP request headers. All xml data received is parsed by the component and provided to the user through properties such as XPath , XElement , XText , etc. which allow traversal of the document structure. The Header event will provide the HTTP headers as returned by the server.

To receive an XML document, call the Get method with the URL to retrieve specified in the URL parameter. Call the 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 Post method for creating resources and the Put method for updating resources. However, others choose to use the methods vice versa, or just one for both operations. So, you can POST XML data to the HTTP server by assigning it to the PostData property and then calling the Post method. Alternatively, you may use the PUT method instead. You should specify the User and Password properties or alternatively theAuthorizationand call the Put method with the specified URL .

The REST bean supports the HTTP Basic authentication scheme through the User and Password properties. Other authentication schemes can be implemented by using the AuthScheme property.

Field Summary

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

Constructor Summary

Rest()

Method Summary

void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Sets a cookie and the corresponding value.
void	addRestEventListener(ipworks.RestEventListener 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 beanconfiguration 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) Fetch the document using the HTTP GET method.
java.lang.String	getAccept() A list of acceptable MIME types for the request.
int	getAuthScheme() The authorization scheme to be used when server authorization is to be performed.
java.lang.String	getContentType() Content type for posted data.
HTTPCookieList	getCookies() Collection of cookies.
ipworks.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 retrieval.
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.
ipworks.Proxy	getProxy() A set of properties related to proxy access.
java.lang.String	getReferer() Referer URL/document (optional).
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 transfer.
long	getTransferredDataLimit() The maximum 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 post information to.
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 in 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 document.
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.
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	removeRestEventListener(ipworks.RestEventListener l)
void	reset() Reset the bean
void	setAccept(java.lang.String accept) A list of acceptable MIME types for the request.
void	setAuthScheme(int authScheme) The authorization scheme to be used when server authorization is to be performed.
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 posted data.
void	setCookies(HTTPCookieList cookies) Collection of cookies.
void	setFirewall(ipworks.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	setNamespaces(XMLNamespaceList namespaces) A collection of namespaces in the current stack.
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(ipworks.Proxy proxy) A set of properties related to proxy access.
void	setReferer(java.lang.String referer) Referer URL/document (optional).
void	setTimeout(int timeout) A timeout for the bean.
void	setTransferredDataLimit(long transferredDataLimit) The maximum of data to be transferred.
void	setURL(java.lang.String URL) The URL to post information to.
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 in the server response for errors.
void	setXPath(java.lang.String XPath) Provides a way to point to a specific element in the document.

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

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

Rest

public Rest()

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

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

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

setAccept

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

A list of acceptable MIME types for the request.

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

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

IPWorksException

getAuthScheme

public int getAuthScheme()

The authorization scheme to be used when server authorization is to be performed.

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

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme 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), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password .

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException

The authorization scheme to be used when server authorization is to be performed.

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

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme 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), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password .

IPWorksException

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 IPWorksException

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.

IPWorksException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksException

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

IPWorksException

getContentType

public java.lang.String getContentType()

Content type for posted data.

If the ContentType 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 being POST-ed to the server.

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" .

setContentType

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

Content type for posted data.

If the ContentType 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 being POST-ed to the server.

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" .

IPWorksException

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

setCookies

public void setCookies(HTTPCookieList cookies)
                throws IPWorksException

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

IPWorksException

getFirewall

public ipworks.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(ipworks.Firewall firewall)
                 throws IPWorksException

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.

IPWorksException

getFollowRedirects

public int getFollowRedirects()

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 FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

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

Note that following the HTTP specification, unless FollowRedirects 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 FollowRedirects 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 a runtime error is generated instead.

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksException

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 FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

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

Note that following the HTTP specification, unless FollowRedirects 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 FollowRedirects 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 a runtime error is generated instead.

IPWorksException

getFrom

public java.lang.String getFrom()

The email address of the HTTP agent (optional).

If the From property 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 IPWorksException

The email address of the HTTP agent (optional).

If the From property 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.

IPWorksException

getHTTPMethod

public java.lang.String getHTTPMethod()

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 IPWorksException

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.

IPWorksException

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 the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the 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 IPWorksException raises an IPWorksException 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 IPWorksException

A date determining the maximum age of the desired document.

If the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the 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 IPWorksException raises an IPWorksException 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.

IPWorksException

getLocalFile

public java.lang.String getLocalFile()

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

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of the Transfer event.

setLocalFile

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

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

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of the Transfer event.

IPWorksException

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 multihomed 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 multihomed 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 IPWorksException

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 multihomed 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 multihomed 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.

IPWorksException

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 collection is indexed from 0 to Count - 1.

setNamespaces

public void setNamespaces(XMLNamespaceList namespaces)
                   throws IPWorksException

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 collection is indexed from 0 to Count - 1.

IPWorksException

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

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

setOtherHeaders

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

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

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

IPWorksException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last retrieval.

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.

MaxHeaderscan be used to control the number of headers saved.

This collection is indexed from 0 to Count - 1.

getPassword

public java.lang.String getPassword()

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 theAuthorizationconfig setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

setPassword

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

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 theAuthorizationconfig setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

IPWorksException

getPostData

public byte[] getPostData()

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

If PostData is a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of the PostData 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 IPWorksException

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

If PostData is a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of the PostData 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) 

IPWorksException

getProxy

public ipworks.Proxy getProxy()

A set of properties related to proxy access.

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

setProxy

public void setProxy(ipworks.Proxy proxy)
              throws IPWorksException

A set of properties related to proxy access.

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

IPWorksException

getReferer

public java.lang.String getReferer()

Referer URL/document (optional).

If the Referer 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 IPWorksException

Referer URL/document (optional).

If the Referer 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.

IPWorksException

getStatusLine

public java.lang.String getStatusLine()

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 IPWorksException raises an IPWorksException exception .

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

Optionally, the behaviour 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 theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksException

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 IPWorksException raises an IPWorksException exception .

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

Optionally, the behaviour 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 theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

IPWorksException

getTransferredData

public byte[] getTransferredData()

The contents of the last transfer.

If the LocalFile is empty, the data is accumulated in TransferredData . Otherwise, TransferredData returns an empty string.

TheMaxTransferredDataconfiguration setting controls the amount of data accumulated in TransferredData .

getTransferredDataLimit

public long getTransferredDataLimit()

The maximum 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 IPWorksException

The maximum 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.

IPWorksException

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 post information to.

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

setURL

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

The URL to post information to.

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

IPWorksException

getUser

public java.lang.String getUser()

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 theAuthorizationproperty in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

setUser

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

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 theAuthorizationproperty in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

IPWorksException

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 IPWorksException

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).

IPWorksException

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 Count - 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 Count - 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 in 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 IPWorksException

An XPath to check in the server response for errors.

If the XPath exists, an exception will be thrown containing the value of the element at the path.

IPWorksException

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 document.

XPath 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 collection provides the attributes of the current element.

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]"
 
  

setXPath

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

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

XPath 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 collection provides the attributes of the current element.

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]"
 
  

IPWorksException

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 theCacheContentset 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 IPWorksException

Sets a cookie and the corresponding value.

Please refer to the Cookies property for more information on cookies and how they are managed.

IPWorksException

attr

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

Returns the value of the specified attribute.

If the attribute does not exist, an empty string is returned.

Please refer to the XAttributes collection for more information.

IPWorksException

config

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

Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor the bean.

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 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 configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

IPWorksException

delete

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

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 orAuthorization.

IPWorksException

doEvents

public void doEvents()
              throws IPWorksException

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.

IPWorksException

get

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

Fetch the document using the HTTP GET method.

Fetch 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.

IPWorksException

interrupt

public void interrupt()
               throws IPWorksException

Interrupt the current method.

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

IPWorksException

post

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

Posts data to the HTTP server using the HTTP POST 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 access 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.

IPWorksException

put

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

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

Send 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 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 orAuthorization.

IPWorksException

reset

public void reset()
           throws IPWorksException

Reset the bean

Reset resets all HTTP headers to default values and resets the xml parser.

IPWorksException

addRestEventListener

public void addRestEventListener(ipworks.RestEventListener l)
                          throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeRestEventListener

public void removeRestEventListener(ipworks.RestEventListener l)