|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ipworks.Http
The HTTP class can be used to retrieve documents from the World Wide Web.
The HTTP class implements a standard HTTP client through a simple plug-and-play interface.
The class 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.
The URL property specifies the document to receive. To receive the document set the Action property to 'Get'. Data can be POST-ed to the HTTP server by assigning it to the PostData property and then setting the Action property to 'Post'.
The PUT method is also supported: the user should set the URL , User and Password or alternatively Authorization and set Action to 'Put'. The AttachedFile will be sent.
The HTTP class supports the HTTP Basic authentication scheme through the User and Password properties. Other authentication schemes can be implemented by using the Authorization property.
Field Summary | |
static int |
a_Get
|
static int |
a_Head
|
static int |
a_Idle
|
static int |
a_Post
|
static int |
a_Put
|
static int |
a_ResetHeaders
|
Constructor Summary | |
Http()
|
Method Summary | |
void |
addHttpEventListener(HttpEventListener 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(int direction)
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 |
fireStartTransfer(int direction)
Fired when a document starts transferring (after the headers). |
void |
fireTransfer(int direction,
int bytesTransferred,
byte[] text)
Fired while a document transfers (delivers document). |
java.lang.String |
getAccept()
A list of acceptable MIME types for the request. |
int |
getAction()
An action code for the component. |
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. |
java.lang.String |
getContentType()
Content type for posted data. |
java.lang.String |
getFrom()
The email address of the HTTP agent (optional). |
java.lang.String |
getHTTPVersion()
The version of HTTP used (default is HTTP/1.0). |
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. |
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. |
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). |
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 |
getReferer()
Referer URL/document (optional). |
java.lang.String |
getStatusLine()
The first line of the last server response. |
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 Basic authentication is to be used. |
java.lang.String |
getUserAgent()
Information about the user agent (browser). |
void |
removeHttpEventListener(HttpEventListener l)
|
void |
setAccept(java.lang.String accept)
A list of acceptable MIME types for the request. |
void |
setAction(int action)
An action code for the component. |
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 |
setContentType(java.lang.String contentType)
Content type for posted data. |
void |
setFrom(java.lang.String from)
The email address of the HTTP agent (optional). |
void |
setHTTPVersion(java.lang.String HTTPVersion)
The version of HTTP used (default is HTTP/1.0). |
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 |
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 |
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 |
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 |
setReferer(java.lang.String referer)
Referer URL/document (optional). |
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 Basic authentication is to be used. |
void |
setUserAgent(java.lang.String userAgent)
Information about the user agent (browser). |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int a_Idle
public static final int a_Get
public static final int a_Post
public static final int a_Head
public static final int a_ResetHeaders
public static final int a_Put
Constructor Detail |
public Http()
Method Detail |
public java.lang.String getAccept()
The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.
public void setAccept(java.lang.String accept) throws IPWorksException
The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.
public int getAction()
The following are the possible values for the Action property and the corresponding descriptions:
public void setAction(int action) throws IPWorksException
The following are the possible values for the Action property and the corresponding descriptions:
public java.lang.String getAttachedFile()
An HTTP 'Content-Length' header is also added to request. Its value is the cumulative length of the PostData string and the file.
public void setAttachedFile(java.lang.String attachedFile) throws IPWorksException
An HTTP 'Content-Length' header is also added to request. Its value is the cumulative length of the PostData string and the file.
public java.lang.String getAuthorization()
This property is provided so that the HTTP class 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
This property is provided so that the HTTP class 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 java.lang.String getContentType()
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
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 java.lang.String getFrom()
public void setFrom(java.lang.String from) throws IPWorksException
public java.lang.String getHTTPVersion()
public void setHTTPVersion(java.lang.String HTTPVersion) throws IPWorksException
public java.lang.String getIfModifiedSince()
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
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 java.lang.String getLocalHost()
If the class 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).
public java.lang.String getLocalFile()
public void setLocalFile(java.lang.String localFile) throws IPWorksException
public java.lang.String getOtherHeaders()
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 class beyond what is provided.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
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 class beyond what is provided.
public java.lang.String getPassword()
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
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 byte[] getPostData()
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.
public void setPostData(byte[] postData) throws IPWorksException
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.
public java.lang.String getPragma()
public void setPragma(java.lang.String pragma) throws IPWorksException
public int getProxyPort()
public void setProxyPort(int proxyPort) throws IPWorksException
public java.lang.String getProxyServer()
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
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 getReferer()
public void setReferer(java.lang.String referer) throws IPWorksException
public java.lang.String getStatusLine()
The HTTP protocol specifies the structure of the StatusLine as: [HTTP version] [Result Code] [Description].
public java.lang.String getURL()
public void setURL(java.lang.String URL) throws IPWorksException
public java.lang.String getURLPath()
public void setURLPath(java.lang.String URLPath) throws IPWorksException
public int getURLPort()
public void setURLPort(int URLPort) throws IPWorksException
public java.lang.String getURLScheme()
public void setURLScheme(java.lang.String URLScheme) throws IPWorksException
public java.lang.String getURLServer()
public void setURLServer(java.lang.String URLServer) throws IPWorksException
public java.lang.String getUser()
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
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)
HttpConnectedEvent
public void fireDisconnected(int statusCode, java.lang.String description)
HttpDisconnectedEvent
public void fireEndTransfer(int direction)
HttpEndTransferEvent
public void fireError(int errorCode, java.lang.String description)
HttpErrorEvent
public void fireHeader(java.lang.String field, java.lang.String value)
HttpHeaderEvent
public void fireStartTransfer(int direction)
HttpStartTransferEvent
public void fireTransfer(int direction, int bytesTransferred, byte[] text)
HttpTransferEvent
public void addHttpEventListener(HttpEventListener l) throws java.util.TooManyListenersException
public void removeHttpEventListener(HttpEventListener l)
|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |