ipworks
Class Webform

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

public class Webform

extends java.lang.Object

The WebForm bean is used to POST data to interactive web pages or scripts (CGI, ASP, etc..), similar to what HTML forms do.

The inputs to the script are provided through the FormVarNames and FormVarValues properties. Once the inputs are defined, set the URL property to the address of the script and call the Submit method. Alternatively, you may call the SubmitTo method with URL as the parameter.

The output of the page or script is provided via the Transfer event.

The Encoding property allows you to specify the proper encoding for the form input (this is normally 'urlencoding').

Field Summary

static int	authBasic
static int	authDigest
static int	encMultipartFormData
static int	encQueryString
static int	encURLEncoding
static int	frAlways
static int	frNever
static int	frSameScheme
static int	fwNone
static int	fwSOCKS4
static int	fwSOCKS5
static int	fwTunnel

Constructor Summary

Webform()

Method Summary

void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Sets a cookie and the corresponding value.
void	addFormVar(java.lang.String varName, java.lang.String varValue) Adds a form variable and the corresponding value.
void	addWebformEventListener(WebformEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a beanconfiguration setting.
void	doEvents() Processes events from the internal message queue.
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 authorization scheme to be used when server authorization is to be performed.
java.lang.String	getContentType() Content type for posted data.
int	getCookieCount() Number of cookies in the current request.
java.lang.String	getCookieName(int cookieIndex) Array of cookie names.
java.lang.String	getCookieValue(int cookieIndex) Array of cookie values.
int	getEncoding() The encoding type for the form data.
java.lang.String	getFirewallHost() Name or IP address of firewall (optional).
java.lang.String	getFirewallPassword() A password if authentication is to be used when connecting through the firewall.
int	getFirewallPort() Port of the firewall to connect to.
int	getFirewallType() Determines the type of firewall to connect through.
java.lang.String	getFirewallUser() A user name if authentication is to be used connecting through a firewall.
int	getFollowRedirects() Determines what happens when the server issues a redirect.
int	getFormVarCount() Number of form variables for the current request.
java.lang.String	getFormVarNames(int varIndex) Array of form variable names for the current request.
java.lang.String	getFormVarValues(int varIndex) Array of form variable values for the current request.
java.lang.String	getFrom() The email address of the HTTP agent (optional).
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.
java.lang.String	getOtherHeaders() Other headers as determined by the user (optional).
java.lang.String	getPassword() A password if authentication is to be used.
java.lang.String	getProxyAuthorization() Similar to the Authorization property, but for proxy authorization.
java.lang.String	getProxyPassword() A password if Basic authentication is to be used for the proxy.
int	getProxyPort() Port for the proxy server (default 80).
java.lang.String	getProxyServer() Name or IP address of a proxy server (optional).
java.lang.String	getProxyUser() A user name if Basic authentication is to be used for the proxy.
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.
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.
void	interrupt() Interrupt the current method.
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
void	removeWebformEventListener(WebformEventListener l)
void	reset() Reset 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 authorization scheme to be used when server authorization is to be performed.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setContentType(java.lang.String contentType) Content type for posted data.
void	setCookieCount(int cookieCount) Number of cookies in the current request.
void	setCookieName(int cookieIndex, java.lang.String cookieName) Array of cookie names.
void	setCookieValue(int cookieIndex, java.lang.String cookieValue) Array of cookie values.
void	setEncoding(int encoding) The encoding type for the form data.
void	setFirewallHost(java.lang.String firewallHost) Name or IP address of firewall (optional).
void	setFirewallPassword(java.lang.String firewallPassword) A password if authentication is to be used when connecting through the firewall.
void	setFirewallPort(int firewallPort) Port of the firewall to connect to.
void	setFirewallType(int firewallType) Determines the type of firewall to connect through.
void	setFirewallUser(java.lang.String firewallUser) A user name if authentication is to be used connecting through a firewall.
void	setFollowRedirects(int followRedirects) Determines what happens when the server issues a redirect.
void	setFormVarCount(int formVarCount) Number of form variables for the current request.
void	setFormVarNames(int varIndex, java.lang.String formVarNames) Array of form variable names for the current request.
void	setFormVarValues(int varIndex, java.lang.String formVarValues) Array of form variable values for the current request.
void	setFrom(java.lang.String from) The email address of the HTTP agent (optional).
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	setProxyAuthorization(java.lang.String proxyAuthorization) Similar to the Authorization property, but for proxy authorization.
void	setProxyPassword(java.lang.String proxyPassword) A password if Basic authentication is to be used for the proxy.
void	setProxyPort(int proxyPort) Port for the proxy server (default 80).
void	setProxyServer(java.lang.String proxyServer) Name or IP address of a proxy server (optional).
void	setProxyUser(java.lang.String proxyUser) A user name if Basic authentication is to be used for the proxy.
void	setReferer(java.lang.String referer) Referer URL/document (optional).
void	setTimeout(int timeout) A timeout for the bean.
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	submit() Post current data to the URL specified by the URL property.
void	submitTo(java.lang.String URL) Post current data to the URL specified by the 'URL' parameter.

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

encURLEncoding

public static final int encURLEncoding

See Also:

Constant Field Values

encMultipartFormData

public static final int encMultipartFormData

See Also:

Constant Field Values

encQueryString

public static final int encQueryString

See Also:

Constant Field Values

fwNone

public static final int fwNone

See Also:

Constant Field Values

fwTunnel

public static final int fwTunnel

See Also:

Constant Field Values

fwSOCKS4

public static final int fwSOCKS4

See Also:

Constant Field Values

fwSOCKS5

public static final int fwSOCKS5

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

Webform

public Webform()

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

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.

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 IPWorksException

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.

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

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.

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.

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.

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.

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

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

getCookieCount

public int getCookieCount()

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

The SetCookie event displays the cookies set by the server and their properties.

setCookieCount

public void setCookieCount(int cookieCount)
                    throws IPWorksException

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

getCookieName

public java.lang.String getCookieName(int cookieIndex)
                               throws IPWorksException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

setCookieName

public void setCookieName(int cookieIndex,
                          java.lang.String cookieName)
                   throws IPWorksException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

getCookieValue

public java.lang.String getCookieValue(int cookieIndex)
                                throws IPWorksException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

setCookieValue

public void setCookieValue(int cookieIndex,
                           java.lang.String cookieValue)
                    throws IPWorksException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

getEncoding

public int getEncoding()

The encoding type for the form data.

This property determines how the bean encodes the form contents. It is equivalent to the 'ENCTYPE' attribute of an HTML form.

It can take one of the following values:

encURLEncoding (0)

This is the most common encoding for HTML form contents.

encMultipartFormData (1)

This is MIME encoding allowing transmission of binary data.

encQueryString (2)

This is an older form of encoding where the actual parameters are appended to the URL query string. (Generally not recommended because most servers limit the size of the URL to less than 1K or 2K).

setEncoding

public void setEncoding(int encoding)
                 throws IPWorksException

The encoding type for the form data.

This property determines how the bean encodes the form contents. It is equivalent to the 'ENCTYPE' attribute of an HTML form.

It can take one of the following values:

encURLEncoding (0)

This is the most common encoding for HTML form contents.

encMultipartFormData (1)

This is MIME encoding allowing transmission of binary data.

encQueryString (2)

This is an older form of encoding where the actual parameters are appended to the URL query string. (Generally not recommended because most servers limit the size of the URL to less than 1K or 2K).

IPWorksException

getFirewallHost

public java.lang.String getFirewallHost()

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.

setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.

IPWorksException

getFirewallPassword

public java.lang.String getFirewallPassword()

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

IPWorksException

getFirewallPort

public int getFirewallPort()

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

IPWorksException

getFirewallType

public int getFirewallType()

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

Connect through a tunneling proxy. FirewallPort is set to 80.

fwSOCKS4 (2)

Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.

fwSOCKS5 (3)

Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

Connect through a tunneling proxy. FirewallPort is set to 80.

fwSOCKS4 (2)

Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.

fwSOCKS5 (3)

Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

IPWorksException

getFirewallUser

public java.lang.String getFirewallUser()

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

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException

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

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

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

getFormVarCount

public int getFormVarCount()

Number of form variables for the current request.

The FormVarCount property provides the number of form variables that are to be posted with the current request. The FormVarNames array contains the variable names, and the FormVarValues array contains the variable values.

The array may be cleared at any time by setting the FormVarCount to 0.

setFormVarCount

public void setFormVarCount(int formVarCount)
                     throws IPWorksException

Number of form variables for the current request.

The FormVarCount property provides the number of form variables that are to be posted with the current request. The FormVarNames array contains the variable names, and the FormVarValues array contains the variable values.

The array may be cleared at any time by setting the FormVarCount to 0.

IPWorksException

getFormVarNames

public java.lang.String getFormVarNames(int varIndex)
                                 throws IPWorksException

Array of form variable names for the current request.

If you are emulating the behavior of an existing HTML web form, the FormVarNames are the name attributes of the <INPUT> tags in the form which you are emulating.

The size of the array is determined by the FormVarCount property. Element indexes start at 1.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.FormVarCount = 2
 WebFormControl.FormVarNames(1) = "formvarname1"
 WebFormControl.FormVarValues(1) = "formvarvalue1"
 WebFormControl.FormVarNames(2) = "formvarname2"
 WebFormControl.FormVarValues(2) = "formvarvalue2"
 WebFormControl.SubmitTo(url) 

is equivalent to

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo(url) 

IPWorksException

setFormVarNames

public void setFormVarNames(int varIndex,
                            java.lang.String formVarNames)
                     throws IPWorksException

Array of form variable names for the current request.

If you are emulating the behavior of an existing HTML web form, the FormVarNames are the name attributes of the <INPUT> tags in the form which you are emulating.

The size of the array is determined by the FormVarCount property. Element indexes start at 1.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.FormVarCount = 2
 WebFormControl.FormVarNames(1) = "formvarname1"
 WebFormControl.FormVarValues(1) = "formvarvalue1"
 WebFormControl.FormVarNames(2) = "formvarname2"
 WebFormControl.FormVarValues(2) = "formvarvalue2"
 WebFormControl.SubmitTo(url) 

is equivalent to

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo(url) 

IPWorksException

getFormVarValues

public java.lang.String getFormVarValues(int varIndex)
                                  throws IPWorksException

Array of form variable values for the current request.

The size of the array is determined by the FormVarCount property. Element indexes start at 1.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.FormVarCount = 2
 WebFormControl.FormVarNames(1) = "formvarname1"
 WebFormControl.FormVarValues(1) = "formvarvalue1"
 WebFormControl.FormVarNames(2) = "formvarname2"
 WebFormControl.FormVarValues(2) = "formvarvalue2"
 WebFormControl.SubmitTo(url) 

is equivalent to

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo(url) 

IPWorksException

setFormVarValues

public void setFormVarValues(int varIndex,
                             java.lang.String formVarValues)
                      throws IPWorksException

Array of form variable values for the current request.

The size of the array is determined by the FormVarCount property. Element indexes start at 1.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.FormVarCount = 2
 WebFormControl.FormVarNames(1) = "formvarname1"
 WebFormControl.FormVarValues(1) = "formvarvalue1"
 WebFormControl.FormVarNames(2) = "formvarname2"
 WebFormControl.FormVarValues(2) = "formvarvalue2"
 WebFormControl.SubmitTo(url) 

is equivalent to

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo(url) 

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

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.

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

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

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 the Authorization property 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 the Authorization property 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

getProxyAuthorization

public java.lang.String getProxyAuthorization()

Similar to the Authorization property, but for proxy authorization.

If the Authorization property 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 ProxyUser and ProxyPassword are specified, they are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

setProxyAuthorization

public void setProxyAuthorization(java.lang.String proxyAuthorization)
                           throws IPWorksException

Similar to the Authorization property, but for proxy authorization.

If the Authorization property 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 ProxyUser and ProxyPassword are specified, they are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

IPWorksException

getProxyPassword

public java.lang.String getProxyPassword()

A password if Basic authentication is to be used for the proxy.

The ProxyUser and ProxyPassword are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

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

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)
                      throws IPWorksException

A password if Basic authentication is to be used for the proxy.

The ProxyUser and ProxyPassword are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

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

IPWorksException

getProxyPort

public int getProxyPort()

Port for the proxy server (default 80).

The TCP port for the ProxyServer . See the description of the ProxyServer property for details.

setProxyPort

public void setProxyPort(int proxyPort)
                  throws IPWorksException

Port for the proxy server (default 80).

The TCP port for the ProxyServer . See the description of the ProxyServer property for details.

IPWorksException

getProxyServer

public java.lang.String getProxyServer()

Name or IP address of a proxy server (optional).

If a ProxyServer is given, then the HTTP request is sent to the proxy instead of the server specified in the URL .

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

setProxyServer

public void setProxyServer(java.lang.String proxyServer)
                    throws IPWorksException

Name or IP address of a proxy server (optional).

If a ProxyServer is given, then the HTTP request is sent to the proxy instead of the server specified in the URL .

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

IPWorksException

getProxyUser

public java.lang.String getProxyUser()

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

The ProxyUser and ProxyPassword are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

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

setProxyUser

public void setProxyUser(java.lang.String proxyUser)
                  throws IPWorksException

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

The ProxyUser and ProxyPassword are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".

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

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

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.

This property must be set before calling the Submit method.

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.

This property must be set before calling the Submit method.

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 the Authorization property 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 the Authorization property 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

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

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 CookieName and CookieValue properties for more information on cookies and how they are managed.

IPWorksException

addFormVar

public void addFormVar(java.lang.String varName,
                       java.lang.String varValue)
                throws IPWorksException

Adds a form variable and the corresponding value.

Please refer to the FormVarNames and FormVarValues properties for more information on form variables and how they are managed.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo(url) 

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

interrupt

public void interrupt()
               throws IPWorksException

Interrupt the current method.

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

IPWorksException

reset

public void reset()
           throws IPWorksException

Reset the bean

Reset resets all HTTP headers to default values and clears all form variables.

IPWorksException

submit

public void submit()
            throws IPWorksException

Post current data to the URL specified by the URL property.

A post request is sent to the URL with the specified variables and values. The response is given via the Transfer event, or the TransferredData property.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.Submit() 

IPWorksException

submitTo

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

Post current data to the URL specified by the 'URL' parameter.

A post request is sent to the URL with the specified variables and values. The response is given via the Transfer event, or the TransferredData property.

Example (Submit Post)

 WebFormControl.Reset()
 WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
 WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
 WebFormControl.SubmitTo("url") 

IPWorksException

addWebformEventListener

public void addWebformEventListener(WebformEventListener l)
                             throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeWebformEventListener

public void removeWebformEventListener(WebformEventListener l)