|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ipworks.Webform
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 |
public static final int webformIdle
public static final int webformSubmit
public static final int webformReset
public static final int encURLEncoding
public static final int encMultipartFormData
public static final int encQueryString
public static final int fwNone
public static final int fwTunnel
public static final int fwSOCKS4
public static final int fwSOCKS5
Constructor Detail |
public Webform()
Method Detail |
public int getAction()
Action
property and
the corresponding descriptions:
URL
with the specified variables and values.
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 .
public void setAction(int action) throws IPWorksException
Action
property and
the corresponding descriptions:
URL
with the specified variables and values.
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 .
public java.lang.String getAuthorization()
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]".
public void setAuthorization(java.lang.String authorization) throws IPWorksException
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]".
public boolean isConnected()
public java.lang.String getContentType()
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" .
public void setContentType(java.lang.String contentType) throws IPWorksException
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" .
public int getCookieCount()
CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public void setCookieCount(int cookieCount) throws IPWorksException
CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public java.lang.String getCookieName(int cookieIndex) throws IPWorksException
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.
public void setCookieName(int cookieIndex, java.lang.String cookieName) throws IPWorksException
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.
public java.lang.String getCookieValue(int cookieIndex) throws IPWorksException
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.
public void setCookieValue(int cookieIndex, java.lang.String cookieValue) throws IPWorksException
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.
public int getEncoding()
It can take one of the following values:
public void setEncoding(int encoding) throws IPWorksException
It can take one of the following values:
public byte[] getFirewallData()
public void setFirewallData(byte[] firewallData) throws IPWorksException
public java.lang.String getFirewallHost()
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.
public void setFirewallHost(java.lang.String firewallHost) throws IPWorksException
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.
public java.lang.String getFirewallPassword()
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.
public void setFirewallPassword(java.lang.String firewallPassword) throws IPWorksException
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.
public int getFirewallPort()
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.
public void setFirewallPort(int firewallPort) throws IPWorksException
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.
public int getFirewallType()
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
public void setFirewallType(int firewallType) throws IPWorksException
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
public java.lang.String getFirewallUser()
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.
public void setFirewallUser(java.lang.String firewallUser) throws IPWorksException
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.
public int getFormVarCount()
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.
public void setFormVarCount(int formVarCount) throws IPWorksException
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.
public java.lang.String getFormVarNames(int varIndex) throws IPWorksException
FormVarCount
property. Element indexes start at 1.
public void setFormVarNames(int varIndex, java.lang.String formVarNames) throws IPWorksException
FormVarCount
property. Element indexes start at 1.
public java.lang.String getFormVarValues(int varIndex) throws IPWorksException
FormVarCount
property. Element indexes start at 1.
public void setFormVarValues(int varIndex, java.lang.String formVarValues) throws IPWorksException
FormVarCount
property. Element indexes start at 1.
public java.lang.String getFrom()
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.
public void setFrom(java.lang.String from) throws IPWorksException
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.
public java.lang.String getLocalFile()
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.
public void setLocalFile(java.lang.String localFile) throws IPWorksException
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.
public java.lang.String getLocalHost()
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.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
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.
public int getMaxTransferredData()
TransferredData
buffer.
If MaxTransferredData
is set to 0, no limits are imposed.
public void setMaxTransferredData(int maxTransferredData) throws IPWorksException
TransferredData
buffer.
If MaxTransferredData
is set to 0, no limits are imposed.
public java.lang.String getOtherHeaders()
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.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
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.
public java.lang.String getPassword()
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.
public void setPassword(java.lang.String password) throws IPWorksException
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.
public java.lang.String getProxyAuthorization()
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]".
public void setProxyAuthorization(java.lang.String proxyAuthorization) throws IPWorksException
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]".
public java.lang.String getProxyPassword()
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.
public void setProxyPassword(java.lang.String proxyPassword) throws IPWorksException
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.
public int getProxyPort()
ProxyServer
. See the
description of the ProxyServer
property for
details.
public void setProxyPort(int proxyPort) throws IPWorksException
ProxyServer
. See the
description of the ProxyServer
property for
details.
public java.lang.String getProxyServer()
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.
public void setProxyServer(java.lang.String proxyServer) throws IPWorksException
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.
public java.lang.String getProxyUser()
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.
public void setProxyUser(java.lang.String proxyUser) throws IPWorksException
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.
public java.lang.String getReferer()
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.
public void setReferer(java.lang.String referer) throws IPWorksException
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.
public java.lang.String getStatusLine()
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].
public int getTimeout()
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.
public void setTimeout(int timeout) throws IPWorksException
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.
public byte[] getTransferredData()
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
.
public java.lang.String getTransferredHeaders()
Header
event shows
the individual headers as parsed by the control.
public java.lang.String getURL()
public void setURL(java.lang.String URL) throws IPWorksException
public java.lang.String getUser()
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.
public void setUser(java.lang.String user) throws IPWorksException
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.
public java.lang.String getUserAgent()
public void setUserAgent(java.lang.String userAgent) throws IPWorksException
public void fireConnected(int statusCode, java.lang.String description)
WebformConnectedEvent
public void fireDisconnected(int statusCode, java.lang.String description)
WebformDisconnectedEvent
public void fireEndTransfer()
WebformEndTransferEvent
public void fireError(int errorCode, java.lang.String description)
WebformErrorEvent
public void fireHeader(java.lang.String field, java.lang.String value)
WebformHeaderEvent
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)
WebformSetCookieEvent
public void fireStartTransfer()
WebformStartTransferEvent
public void fireTransfer(int bytesTransferred, byte[] text)
WebformTransferEvent
public void addCookie(java.lang.String cookieName, java.lang.String cookieValue) throws IPWorksException
CookieName
and CookieValue
properties
for more information on cookies and how they are managed.
public void addFormVar(java.lang.String varName, java.lang.String varValue) throws IPWorksException
FormVarNames
and FormVarValues
properties
for more information on form variables and how they are managed.
public void interrupt() throws IPWorksException
Action
property
to Idle (0) .
public void reset() throws IPWorksException
Action
property to webformReset .
public void submit() throws IPWorksException
URL
with the
specified variables and values.
Calling this method is equivalent to setting the Action
property
to webformSubmit .
public void submitTo(java.lang.String URL) throws IPWorksException
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 .
public void addWebformEventListener(WebformEventListener l) throws java.util.TooManyListenersException
public void removeWebformEventListener(WebformEventListener l)
|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |