|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Http
public class Http
The HTTP Bean can be used to retrieve documents from the World Wide Web.
The HTTP Bean implements a standard HTTP client through a simple plug-and-play interface as defined in RFCs 1945 and 2616 .
The bean contains a number of properties that map directly to HTTP request
headers. Files are received through events: Transfer
for contents, and Header
for HTTP headers. The StartTransfer
and EndTransfer
events are fired at the beginning and end
of transmission.
To receive a document call the Get
method with the URL parameter. Data can be POST-ed to the HTTP server by assigning it to
the PostData
property and then calling the Post
method.
The PUT method is also supported. You should specify the User
and Password
properties or alternatively the Authorization
and call the Put
method
with the specified URL . The AttachedFile
will be sent to the server.
The HTTP Bean supports the HTTP Basic authentication
scheme through the User
and Password
properties. Other authentication
schemes can be implemented by using the AuthScheme
property.
Field Summary | |
---|---|
static int |
authBasic
|
static int |
authDigest
|
static int |
authNegotiate
|
static int |
authNone
|
static int |
authNtlm
|
static int |
authOAuth
|
static int |
authProprietary
|
static int |
frAlways
|
static int |
frNever
|
static int |
frSameScheme
|
Constructor Summary | |
---|---|
Http()
Creates an instance of Http Bean. |
|
Http(java.lang.String runtimeLicense)
Creates an instance of Http Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addCookie(java.lang.String cookieName,
java.lang.String cookieValue)
Adds a cookie and the corresponding value to the outgoing request headers. |
void |
addHttpEventListener(HttpEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
delete(java.lang.String URL)
Deletes an object on the server. |
void |
doEvents()
Processes events from the internal message queue. |
void |
get(java.lang.String URL)
Fetch the document using the HTTP GET method. |
java.lang.String |
getAccept()
A list of acceptable MIME types for the request. |
java.lang.String |
getAttachedFile()
A file to append to PostData if the POST or PUT methods are used. |
java.lang.String |
getAuthorization()
The Authorization string to be sent to the server. |
int |
getAuthScheme()
The authentication scheme to use when server authorization is required. |
java.lang.String |
getContentType()
Content type for posts and puts. |
HTTPCookieList |
getCookies()
Collection of cookies. |
Firewall |
getFirewall()
A set of properties related to firewall access. |
int |
getFollowRedirects()
Determines what happens when the server issues a redirect. |
java.lang.String |
getFrom()
The email address of the HTTP agent (optional). |
java.lang.String |
getHTTPMethod()
The HTTP method used for the request. |
java.lang.String |
getIfModifiedSince()
A date determining the maximum age of the desired document. |
java.lang.String |
getLocalFile()
The path to a local file for downloading. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
java.lang.String |
getOtherHeaders()
Other headers as determined by the user (optional). |
HeaderList |
getParsedHeaders()
Collection of headers returned from the last request. |
java.lang.String |
getPassword()
A password if authentication is to be used. |
byte[] |
getPostData()
The data to post with the URL if the POST method is used. |
java.lang.String |
getPragma()
A browser/server specific header line (optional). |
Proxy |
getProxy()
A set of properties related to proxy access. |
java.lang.String |
getRange()
The byte-range to be sent to the server. |
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 response from the server. |
long |
getTransferredDataLimit()
The maximum of data to be transferred. |
java.lang.String |
getTransferredHeaders()
The full set of headers as received from the server. |
java.lang.String |
getURL()
The URL to fetch. |
java.lang.String |
getURLPath()
The path for the URL. |
int |
getURLPort()
The port for the URL. |
java.lang.String |
getURLScheme()
The scheme for the URL. |
java.lang.String |
getURLServer()
The server for the URL. |
java.lang.String |
getUser()
A user name if authentication is to be used. |
void |
head(java.lang.String URL)
Fetches the document headers using the HTTP HEAD method. |
void |
interrupt()
Interrupt the current method. |
boolean |
isAllowHTTPCompression()
Enables HTTP compression for receiving data. |
boolean |
isConnected()
Shows whether the bean is connected. |
boolean |
isIdle()
The current status of the component. |
void |
post(java.lang.String URL)
Posts data to the HTTP server using the HTTP POST method. |
void |
put(java.lang.String URL)
Sends data to the HTTP server using the HTTP PUT method. |
void |
removeHttpEventListener(HttpEventListener l)
|
void |
resetHeaders()
Resets all HTTP Headers, Cookies, LocalFile , and AttachedFile . |
void |
setAccept(java.lang.String accept)
A list of acceptable MIME types for the request. |
void |
setAllowHTTPCompression(boolean allowHTTPCompression)
Enables HTTP compression for receiving data. |
void |
setAttachedFile(java.lang.String attachedFile)
A file to append to PostData if the POST or PUT methods are used. |
void |
setAuthorization(java.lang.String authorization)
The Authorization string to be sent to the server. |
void |
setAuthScheme(int authScheme)
The authentication scheme to use when server authorization is required. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
void |
setContentType(java.lang.String contentType)
Content type for posts and puts. |
void |
setDownloadStream(java.io.OutputStream downloadStream)
Sets the stream to which the downloaded data from the server will be written. |
void |
setFirewall(Firewall firewall)
A set of properties related to firewall access. |
void |
setFollowRedirects(int followRedirects)
Determines what happens when the server issues a redirect. |
void |
setFrom(java.lang.String from)
The email address of the HTTP agent (optional). |
void |
setHTTPMethod(java.lang.String HTTPMethod)
The HTTP method used for the request. |
void |
setIfModifiedSince(java.lang.String ifModifiedSince)
A date determining the maximum age of the desired document. |
void |
setLocalFile(java.lang.String localFile)
The path to a local file for downloading. |
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setOtherHeaders(java.lang.String otherHeaders)
Other headers as determined by the user (optional). |
void |
setPassword(java.lang.String password)
A password if authentication is to be used. |
void |
setPostData(byte[] postData)
The data to post with the URL if the POST method is used. |
void |
setPragma(java.lang.String pragma)
A browser/server specific header line (optional). |
void |
setProxy(Proxy proxy)
A set of properties related to proxy access. |
void |
setRange(java.lang.String range)
The byte-range to be sent to the server. |
void |
setReferer(java.lang.String referer)
Referer URL/document (optional). |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
setTransferredDataLimit(long transferredDataLimit)
The maximum of data to be transferred. |
void |
setUploadStream(java.io.InputStream uploadStream)
Sets the stream to be uploaded to the server. |
void |
setURL(java.lang.String URL)
The URL to fetch. |
void |
setURLPath(java.lang.String URLPath)
The path for the URL. |
void |
setURLPort(int URLPort)
The port for the URL. |
void |
setURLScheme(java.lang.String URLScheme)
The scheme for the URL. |
void |
setURLServer(java.lang.String URLServer)
The server for the URL. |
void |
setUser(java.lang.String user)
A user name if authentication is to be used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int authBasic
public static final int authDigest
public static final int authProprietary
public static final int authNone
public static final int authNtlm
public static final int authNegotiate
public static final int authOAuth
public static final int frNever
public static final int frAlways
public static final int frSameScheme
Constructor Detail |
---|
public Http()
public Http(java.lang.String runtimeLicense)
Method Detail |
---|
public java.lang.String getAccept()
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
public void setAccept(java.lang.String accept) throws IPWorksException
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
IPWorksException
public boolean isAllowHTTPCompression()
This property enables HTTP compression for receiving data. When set to true, the bean will accept compressed data. It will then uncompress the data it has received. The bean will handle data compressed by both GZIP and Deflate compression algorithms.
When true, the bean adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding
config. The default value for this header is "gzip, deflate".
TransferredData
will contain the decompressed data received by the server, but the Transfer
event will report exactly what is received by the server (compressed data).
public void setAllowHTTPCompression(boolean allowHTTPCompression) throws IPWorksException
This property enables HTTP compression for receiving data. When set to true, the bean will accept compressed data. It will then uncompress the data it has received. The bean will handle data compressed by both GZIP and Deflate compression algorithms.
When true, the bean adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding
config. The default value for this header is "gzip, deflate".
TransferredData
will contain the decompressed data received by the server, but the Transfer
event will report exactly what is received by the server (compressed data).
IPWorksException
public java.lang.String getAttachedFile()
PostData
if the POST or PUT methods are used.
If this property contains a non-empty string, then if the HTTP 'POST' or 'PUT' methods are used (through the Post
or Put
methods), the contents of this property are appended to the HTTP request after any data in PostData
.
An HTTP 'Content-Length' header is also added to request. Its value is the cumulative length of the PostData
string and the file.
If you are attempting to upload a file to a receiving script, this property must be MIME encoded, or you should use the WEBUPLOAD component.
public void setAttachedFile(java.lang.String attachedFile) throws IPWorksException
PostData
if the POST or PUT methods are used.
If this property contains a non-empty string, then if the HTTP 'POST' or 'PUT' methods are used (through the Post
or Put
methods), the contents of this property are appended to the HTTP request after any data in PostData
.
An HTTP 'Content-Length' header is also added to request. Its value is the cumulative length of the PostData
string and the file.
If you are attempting to upload a file to a receiving script, this property must be MIME encoded, or you should use the WEBUPLOAD component.
IPWorksException
public java.lang.String getAuthorization()
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
public void setAuthorization(java.lang.String authorization) throws IPWorksException
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
IPWorksException
public int getAuthScheme()
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User
and Password
properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
public void setAuthScheme(int authScheme) throws IPWorksException
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User
and Password
properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
IPWorksException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksException
public java.lang.String getContentType()
If this property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents
of the data during a Post
or Put
to the server.
The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded" .
public void setContentType(java.lang.String contentType) throws IPWorksException
If this property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents
of the data during a Post
or Put
to the server.
The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded" .
IPWorksException
public HTTPCookieList getCookies()
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type httpcookie
) to this collection.
To see cookies that are set by the server, use the SetCookie
event, which displays the cookies and their properties as set by the server.
Those cookies are also added to Cookies
.
MaxHTTPCookies
can be used to control the maximum number of cookies saved.
This collection is indexed from 0 to size - 1.
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksException
public int getFollowRedirects()
This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds
with an "Object Moved" message. If this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server and port are different than
the existing one, User
and Password
are also reset to empty,
unless this property is set to frAlways (1), in which case
the same credentials are used to connect to the new server.
A Redirect
event is fired for every URL the product is redirected
to. In the case of automatic redirections, the Redirect
event is
a good place to set properties related to the new connection (e.g. new
authentication parameters).
The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.
public void setFollowRedirects(int followRedirects) throws IPWorksException
This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds
with an "Object Moved" message. If this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server and port are different than
the existing one, User
and Password
are also reset to empty,
unless this property is set to frAlways (1), in which case
the same credentials are used to connect to the new server.
A Redirect
event is fired for every URL the product is redirected
to. In the case of automatic redirections, the Redirect
event is
a good place to set properties related to the new connection (e.g. new
authentication parameters).
The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.
IPWorksException
public java.lang.String getFrom()
This property contains the email address of the HTTP agent (optional). If it contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.
public void setFrom(java.lang.String from) throws IPWorksException
This property contains the email address of the HTTP agent (optional). If it contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.
IPWorksException
public java.lang.String getHTTPMethod()
This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod
is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the bean.
public void setHTTPMethod(java.lang.String HTTPMethod) throws IPWorksException
This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod
is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the bean.
IPWorksException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public java.lang.String getIfModifiedSince()
If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception
The format of the date value for IfModifiedSince
is detailed
in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.
public void setIfModifiedSince(java.lang.String ifModifiedSince) throws IPWorksException
If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception
The format of the date value for IfModifiedSince
is detailed
in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.
IPWorksException
public java.lang.String getLocalFile()
This property is used when getting a document.
If this property is empty then the received data is provided through TransferredData
and the Transfer
event.
public void setLocalFile(java.lang.String localFile) throws IPWorksException
This property is used when getting a document.
If this property is empty then the received data is provided through TransferredData
and the Transfer
event.
IPWorksException
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public java.lang.String getOtherHeaders()
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
IPWorksException
public HeaderList getParsedHeaders()
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are
parsed into a collection of headers. Each header
in this collection contains information describing that header.
MaxHeaders
can be used to control the maximum number of headers saved.
This collection is indexed from 0 to size - 1.
public java.lang.String getPassword()
This property contains a password if authentication is to be used. If AuthScheme
is set to HTTP Basic Authentication, The User
and Password
are Base64 encoded and the result is put in the Authorization
config setting in the form "Basic [encoded-user-password]".
If AuthScheme
is set to HTTP Digest Authentication, the User
and Password
properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
public void setPassword(java.lang.String password) throws IPWorksException
This property contains a password if authentication is to be used. If AuthScheme
is set to HTTP Basic Authentication, The User
and Password
are Base64 encoded and the result is put in the Authorization
config setting in the form "Basic [encoded-user-password]".
If AuthScheme
is set to HTTP Digest Authentication, the User
and Password
properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
IPWorksException
public byte[] getPostData()
If this method is a non-empty string, then if the HTTP Post
method is used. The contents of this property are appended to the HTTP request after the HTTP headers.
An HTTP 'Content-Length' header is also added to the request. Its value is the length of the string in PostData
, or, if the AttachedFile
property has been set, the cumulative length of the string and the file. See the description of the AttachedFile
property for details.
If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded. The WebUpload component is specifically designed for this and will perform all of the MIME encoding for you automatically. The WebForm component can be used for any form data posting.
The most common example is posting of HTML form input data. In that case, the ContentType
property must be set to "application/x-www-form-urlencoded".
Example (Performing a Post)
HTTPControl.ContentType = "application/x-www-form-urlencoded"
HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
HTTPControl.Post(myurl)
public void setPostData(byte[] postData) throws IPWorksException
If this method is a non-empty string, then if the HTTP Post
method is used. The contents of this property are appended to the HTTP request after the HTTP headers.
An HTTP 'Content-Length' header is also added to the request. Its value is the length of the string in PostData
, or, if the AttachedFile
property has been set, the cumulative length of the string and the file. See the description of the AttachedFile
property for details.
If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded. The WebUpload component is specifically designed for this and will perform all of the MIME encoding for you automatically. The WebForm component can be used for any form data posting.
The most common example is posting of HTML form input data. In that case, the ContentType
property must be set to "application/x-www-form-urlencoded".
Example (Performing a Post)
HTTPControl.ContentType = "application/x-www-form-urlencoded"
HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
HTTPControl.Post(myurl)
IPWorksException
public java.lang.String getPragma()
If this property contains a non-empty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation and can be used to send/receive proprietary information to/from the server.
public void setPragma(java.lang.String pragma) throws IPWorksException
If this property contains a non-empty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation and can be used to send/receive proprietary information to/from the server.
IPWorksException
public Proxy getProxy()
This property contains fields describing the proxy through which the bean will attempt to connect.
public void setProxy(Proxy proxy) throws IPWorksException
This property contains fields describing the proxy through which the bean will attempt to connect.
IPWorksException
public java.lang.String getRange()
If this property contains a non-empty string, a Range HTTP request header is added to the request. This header tells the server to only send a certain range of bytes.
The format of this property consists of a range of bytes specified by two numbers separated by '-' (e.g. "0-499")
For example:
public void setRange(java.lang.String range) throws IPWorksException
If this property contains a non-empty string, a Range HTTP request header is added to the request. This header tells the server to only send a certain range of bytes.
The format of this property consists of a range of bytes specified by two numbers separated by '-' (e.g. "0-499")
For example:
IPWorksException
public java.lang.String getReferer()
If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
public void setReferer(java.lang.String referer) throws IPWorksException
If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
IPWorksException
public java.lang.String getStatusLine()
This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the bean, the error string is the same as the StatusLine
property.
The HTTP protocol specifies the structure of the StatusLine
as: [HTTP version] [Result Code] [Description].
public int getTimeout()
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksException
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksException
public byte[] getTransferredData()
This property contains the contents of the last response from the server. If the LocalFile
is empty, the data is accumulated in TransferredData , and can also be received in the Transfer
event. Otherwise, this property returns an empty string.
TransferredDataLimit
controls the maximum amount of data accumulated in TransferredData
(by default there is no limit).
public long getTransferredDataLimit()
This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData
property.
public void setTransferredDataLimit(long transferredDataLimit) throws IPWorksException
This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData
property.
IPWorksException
public java.lang.String getTransferredHeaders()
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.
public java.lang.String getURL()
This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme
, URLServer
, URLPort
, and URLPath
properties.
public void setURL(java.lang.String URL) throws IPWorksException
This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme
, URLServer
, URLPort
, and URLPath
properties.
IPWorksException
public java.lang.String getURLPath()
This property contains the path for the URL. The URL path as determined by parsing the value set in the URL
property.
public void setURLPath(java.lang.String URLPath) throws IPWorksException
This property contains the path for the URL. The URL path as determined by parsing the value set in the URL
property.
IPWorksException
public int getURLPort()
This property contains the port for the URL. The HTTP server port as determined by parsing the value set in the URL
property.
public void setURLPort(int URLPort) throws IPWorksException
This property contains the port for the URL. The HTTP server port as determined by parsing the value set in the URL
property.
IPWorksException
public java.lang.String getURLScheme()
This property contains the scheme for the URL. The URL scheme as determined by parsing the value set in the URL
property.
public void setURLScheme(java.lang.String URLScheme) throws IPWorksException
This property contains the scheme for the URL. The URL scheme as determined by parsing the value set in the URL
property.
IPWorksException
public java.lang.String getURLServer()
This property contains the server for the URL. The HTTP server name as determined by parsing the value set in the URL
property.
public void setURLServer(java.lang.String URLServer) throws IPWorksException
This property contains the server for the URL. The HTTP server name as determined by parsing the value set in the URL
property.
IPWorksException
public java.lang.String getUser()
This property contains a user name if authentication is to be used. If AuthScheme
is set to HTTP Basic Authentication, The User
and Password
are Base64 encoded and the result is put in the 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
public void setUser(java.lang.String user) throws IPWorksException
This property contains a user name if authentication is to be used. If AuthScheme
is set to HTTP Basic Authentication, The User
and Password
are Base64 encoded and the result is put in the 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
IPWorksException
public void addCookie(java.lang.String cookieName, java.lang.String cookieValue) throws IPWorksException
This property adds a cookie and the corresponding value to the outgoing request headers.
Please refer to the Cookies
property for more information on cookies and how they are managed.
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for 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.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
AllowHTTPCompression
is true, the bean adds an "Accept-Encoding: " header to the request
being sent to the server. By default, this header's value is "gzip, deflate". This config allows you
to change the value of the "Accept-Encoding" header.
NOTE: The bean only supports gzip and deflate decompression algorithms.AllowHTTPCompression
property. This setting is exposed here
for use by beans that inherit from HTTP.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]".
Transfer
event, by BytesTransferred .IfModifiedSince
property. This setting is exposed here for use by beans that inherit from HTTP.OtherHeaders
to 'Connection: Keep-Alive'.
If false, the connection will be closed immediately after the server response is received.The default value for KeepAlive
is false.
TransferredHeaders
collection is to be populated
when a Header
event has been fired. This value
represents the number of headers that are to be saved in the collection.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
Cookies
collection
as a result of an HTTP request. This value represents the number of
cookies that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
FollowRedirects
is set to any value besides frNever the bean will follow redirects until
this maximum number of redirect attempts are made. The default value is 20.
\011Authorization
config, but for proxy authorization. If this
config contains a non-empty string, a Proxy-Authorization HTTP request header is added
to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified
by AuthScheme .TransferredData
buffer.If TransferredDataLimit
is set to 0, no limits are imposed.
UseChunkedEncoding
is true. This setting specifies the
chunk size in bytes to be used when posting data. The default value is 16384.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
setting is set to the corresponding address. If the search is not successful,
an error is returned.
NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
RemotePort
is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The
binding (address and port) is provided through the ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings
are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set automatically when FirewallType
is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.
TCPKeepAlive
will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.
LingerTime
is 0 (default), the
system will attempt to send pending data for a connection until the default
IP protocol timeout expires.
In the second scenario, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
is reached.
If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
IPWorksException
public void delete(java.lang.String URL) throws IPWorksException
This method is used to delete an object at the URL specified by using the HTTP DELETE method. The server response text is received through the Transfer
event, and the HTTP response headers through the Header
event. If LocalFile
is not empty the data (not the headers) is written there as well. The user should normally have assigned correct values to User
and Password
or Authorization
.
IPWorksException
public void doEvents() throws IPWorksException
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
public void get(java.lang.String URL) throws IPWorksException
This property fetches the document using the HTTP GET method. The document contents are delivered through the Transfer
event, and the HTTP response headers through the Header
event.
If LocalFile
is not empty the data (not the headers) is written there as well.
IPWorksException
public void head(java.lang.String URL) throws IPWorksException
This method fetches the document headers using the HTTP HEAD method. The headers are received through the Header
event.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void post(java.lang.String URL) throws IPWorksException
This method posts data to the HTTP server using the HTTP POST method. The posted data is taken from PostData
and/or AttachedFile
properties. The server response text is received through the Transfer
event, and the HTTP response headers through the Header
event.
If LocalFile
is not empty the data (not the headers) is written there as well.
If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded, or you should use the WEBUPLOAD or WEBFORM component.
Example (Performing a Post)
HTTPControl.ContentType = "application/x-www-form-urlencoded"
HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
HTTPControl.Post(myurl)
IPWorksException
public void put(java.lang.String URL) throws IPWorksException
This method sends data to the HTTP server. The data is taken from PostData
and/or AttachedFile
properties. The server response text is received through the Transfer
event, and the HTTP response headers through the Header
event.
If LocalFile
is not empty the data (not the headers) is written there as well.
The user should normally have assigned correct
values to User
and Password
or Authorization
.
IPWorksException
public void resetHeaders() throws IPWorksException
LocalFile
, and AttachedFile
.
This method resets all the HTTP Headers as well as LocalFile
and AttachedFile
to "" (empty string). It also resets the Cookie collection
. Use this method before creating a new request, so that headers from the previous message are not carried over to the next one.
IPWorksException
public void setDownloadStream(java.io.OutputStream downloadStream) throws IPWorksException
This method sets the stream to which the downloaded data from the server will be written. If a download stream is set before the Get
method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
The bean will automatically close this stream if CloseStreamAfterTransfer
is true (default). If the stream is closed, you will need to call SetDownloadStream
again before calling Get
again.
The downloaded content will be written starting at the current position in the stream.
Note: SetDownloadStream
and LocalFile
will reset the other.
IPWorksException
public void setUploadStream(java.io.InputStream uploadStream) throws IPWorksException
This method sets the stream to be uploaded to the server. If an upload stream is set before the Post
or Put
method are called, the content of the stream will be read by the bean and uploaded to the server. The stream should be open and normally set to position 0.
The bean will automatically close this stream if CloseStreamAfterTransfer
is true (default). If the stream is closed, you will need to call SetUploadStream
again before calling Post
or Put
again.
The content of the stream will be read from the current position all the way to the end.
Note: SetUploadStream
and LocalFile
will reset the other.
IPWorksException
public void addHttpEventListener(HttpEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeHttpEventListener(HttpEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |