IP*Works!

ipworks
Class Webform

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

public class Webform
extends java.lang.Object

The WebForm control 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 or set Action to webformSubmit . 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 encMultipartFormData
           
static int encQueryString
           
static int encURLEncoding
           
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
static int webformIdle
           
static int webformReset
           
static int webformSubmit
           
 
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)
           
 void fireConnected(int statusCode, java.lang.String description)
          Fired immediately after a connection completes (or fails).
 void fireDisconnected(int statusCode, java.lang.String description)
          Fired when a connection is closed.
 void fireEndTransfer()
          Fired when a document finishes transferring.
 void fireError(int errorCode, java.lang.String description)
          Information about errors during data delivery.
 void fireHeader(java.lang.String field, java.lang.String value)
          Fired every time a header line comes in.
 void fireSetCookie(java.lang.String name, java.lang.String value, java.lang.String expires, java.lang.String domain, java.lang.String path, boolean secure)
          Fired for every cookie set by the server.
 void fireStartTransfer()
          Fired when a document starts transferring (after the headers).
 void fireTransfer(int bytesTransferred, byte[] text)
          Fired while a document transfers (delivers document).
 int getAction()
          An action code for the control.
 java.lang.String getAuthorization()
          The Authorization string to be sent to the server.
 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.
 byte[] getFirewallData()
          Used to send other data to firewall.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used 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 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.
 int getMaxTransferredData()
          The maximum number of bytes to store in TransferredData .
 java.lang.String getOtherHeaders()
          Other headers as determined by the user (optional).
 java.lang.String getPassword()
          A password if Basic 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 component.
 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 Basic authentication is to be used.
 java.lang.String getUserAgent()
          Information about the user agent (browser).
 void interrupt()
          Interrupt the Action in progress (if any).
 boolean isConnected()
          Shows whether the component is connected.
 void removeWebformEventListener(WebformEventListener l)
           
 void reset()
          Reset HTTP headers and clear all form variables.
 void setAction(int action)
          An action code for the control.
 void setAuthorization(java.lang.String authorization)
          The Authorization string to be sent to the server.
 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 setFirewallData(byte[] firewallData)
          Used to send other data to firewall.
 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 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 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 setMaxTransferredData(int maxTransferredData)
          The maximum number of bytes to store in TransferredData .
 void setOtherHeaders(java.lang.String otherHeaders)
          Other headers as determined by the user (optional).
 void setPassword(java.lang.String password)
          A password if Basic 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 component.
 void setURL(java.lang.String URL)
          The URL to post information to.
 void setUser(java.lang.String user)
          A user name if Basic authentication is to be used.
 void setUserAgent(java.lang.String userAgent)
          Information about the user agent (browser).
 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

webformIdle

public static final int webformIdle

webformSubmit

public static final int webformSubmit

webformReset

public static final int webformReset

encURLEncoding

public static final int encURLEncoding

encMultipartFormData

public static final int encMultipartFormData

encQueryString

public static final int encQueryString

fwNone

public static final int fwNone

fwTunnel

public static final int fwTunnel

fwSOCKS4

public static final int fwSOCKS4

fwSOCKS5

public static final int fwSOCKS5
Constructor Detail

Webform

public Webform()
Method Detail

getAction

public int getAction()
An action code for the control. The following are the possible values for the Action property and the corresponding descriptions:
webformIdle (0)
Default action. It can also be used to interrupt the current operation.
webformSubmit (1)
A post request is sent to the URL with the specified variables and values.
webformReset (2)
Resets all the HTTP headers as well as LocalFile to "" (empty string) and clears all form variables. Use this property before creating a new request, so that headers from the previous request are not carried over to the next one.

After a successful submission, the control returns control, and the Action property converts to webuploadIdle .


setAction

public void setAction(int action)
               throws IPWorksException
An action code for the control. The following are the possible values for the Action property and the corresponding descriptions:
webformIdle (0)
Default action. It can also be used to interrupt the current operation.
webformSubmit (1)
A post request is sent to the URL with the specified variables and values.
webformReset (2)
Resets all the HTTP headers as well as LocalFile to "" (empty string) and clears all form variables. Use this property before creating a new request, so that headers from the previous request are not carried over to the next one.

After a successful submission, the control returns control, and the Action property converts to webuploadIdle .


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 control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.

If User and Password are specified, 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 control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.

If User and Password are specified, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".


isConnected

public boolean isConnected()
Shows whether the component is connected. Use this property to determine whether the control is connected to the remote host or not.


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


getCookieCount

public int getCookieCount()
Number of cookies in the current request. The cookie arrays such as CookieName and CookieValue maintain the cookies 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 such as CookieName and CookieValue maintain the cookies sent to the server.

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


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 such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


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 such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


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 such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


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 such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


getEncoding

public int getEncoding()
The encoding type for the form data. This property determines how the control 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 control 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).


getFirewallData

public byte[] getFirewallData()
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


setFirewallData

public void setFirewallData(byte[] firewallData)
                     throws IPWorksException
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


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


getFirewallPassword

public java.lang.String getFirewallPassword()
A password if authentication is to be used 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 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.


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.


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.


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.


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.


getFormVarNames

public java.lang.String getFormVarNames(int varIndex)
                                 throws IPWorksException
Array of form variable names for the current request. The size of the array is determined by the FormVarCount property. Element indexes start at 1.


setFormVarNames

public void setFormVarNames(int varIndex,
                            java.lang.String formVarNames)
                     throws IPWorksException
Array of form variable names for the current request. The size of the array is determined by the FormVarCount property. Element indexes start at 1.


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.


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.


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.


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 via the Action property. 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 via the Action property. If LocalFile is empty then the received data is provided through the parameters of the Transfer event.


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() Winsock 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 control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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() Winsock 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 control initiate connections (or accept in the case of server controls) only through that interface.

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


getMaxTransferredData

public int getMaxTransferredData()
The maximum number of bytes to store in TransferredData . The default value is 4096, allowing the control to accumulate the first 4K of data into the TransferredData buffer.

If MaxTransferredData is set to 0, no limits are imposed.


setMaxTransferredData

public void setMaxTransferredData(int maxTransferredData)
                           throws IPWorksException
The maximum number of bytes to store in TransferredData . The default value is 4096, allowing the control to accumulate the first 4K of data into the TransferredData buffer.

If MaxTransferredData is set to 0, no limits are imposed.


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 specs. 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 control 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 specs. 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 control beyond what is provided.


getPassword

public java.lang.String getPassword()
A password if Basic authentication is to be used. The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

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 Basic authentication is to be used. The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

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.


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


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.


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.


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.


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.


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.


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 setting the Action property, 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 component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


getTransferredData

public byte[] getTransferredData()
The contents of the last transfer. If the LocalFile is not empty, the data is not accumulated and TransferredData returns an empty string.

The MaxTransferredData property 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 control.


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 '
' in HTML forms.

This property must be set before the Action is set to webformSubmit .


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 '' in HTML forms.

This property must be set before the Action is set to webformSubmit .


getUser

public java.lang.String getUser()
A user name if Basic authentication is to be used. The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

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 Basic authentication is to be used. The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

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.


getUserAgent

public java.lang.String getUserAgent()
Information about the user agent (browser). Override the default with the name and version of your software.


setUserAgent

public void setUserAgent(java.lang.String userAgent)
                  throws IPWorksException
Information about the user agent (browser). Override the default with the name and version of your software.


fireConnected

public void fireConnected(int statusCode,
                          java.lang.String description)
Fired immediately after a connection completes (or fails). (Called internally to dispatch the event.)
See Also:
WebformConnectedEvent

fireDisconnected

public void fireDisconnected(int statusCode,
                             java.lang.String description)
Fired when a connection is closed. (Called internally to dispatch the event.)
See Also:
WebformDisconnectedEvent

fireEndTransfer

public void fireEndTransfer()
Fired when a document finishes transferring. (Called internally to dispatch the event.)
See Also:
WebformEndTransferEvent

fireError

public void fireError(int errorCode,
                      java.lang.String description)
Information about errors during data delivery. (Called internally to dispatch the event.)
See Also:
WebformErrorEvent

fireHeader

public void fireHeader(java.lang.String field,
                       java.lang.String value)
Fired every time a header line comes in. (Called internally to dispatch the event.)
See Also:
WebformHeaderEvent

fireSetCookie

public void fireSetCookie(java.lang.String name,
                          java.lang.String value,
                          java.lang.String expires,
                          java.lang.String domain,
                          java.lang.String path,
                          boolean secure)
Fired for every cookie set by the server. (Called internally to dispatch the event.)
See Also:
WebformSetCookieEvent

fireStartTransfer

public void fireStartTransfer()
Fired when a document starts transferring (after the headers). (Called internally to dispatch the event.)
See Also:
WebformStartTransferEvent

fireTransfer

public void fireTransfer(int bytesTransferred,
                         byte[] text)
Fired while a document transfers (delivers document). (Called internally to dispatch the event.)
See Also:
WebformTransferEvent

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.


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.


interrupt

public void interrupt()
               throws IPWorksException
Interrupt the Action in progress (if any). Calling this method is equivalent to setting the Action property to Idle (0) .


reset

public void reset()
           throws IPWorksException
Reset HTTP headers and clear all form variables. Calling this method is equivalent to setting the Action property to webformReset .


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.

Calling this method is equivalent to setting the Action property to webformSubmit .


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.

Calling this method is equivalent to setting the URL property to URL and then setting the Action property to webformSubmit .


addWebformEventListener

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

removeWebformEventListener

public void removeWebformEventListener(WebformEventListener l)

IP*Works!

Copyright (c) 2001 /n software inc. - All rights reserved.