ipworksssl
Class Https

java.lang.Object
  |
  +--ipworksssl.Https

public class Https

extends java.lang.Object

The HTTPS bean can be used to retrieve documents from the World Wide Web.

The HTTPS bean is the SSL-enabled equivalent of the IP*Works! HTTP bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. TheSSLProviderconfiguration setting chooses a security provider subsystem. TheSSLEnabledProtocolsandSSLCipherStrengthconfiguration settings determine which protocols are enabled and at what security level. The SSLCertStore , SSLCertSubject , and SSLCertEncoded properties are used to select a client certificate if the server is requesting client authentication. TheSSLSecurityFlagsconfiguration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

The HTTPS bean implements a standard HTTP client through a simple plug-and-play interface as defined in RFCs 1945 and 2616 and the added option of SSL security.

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 to retrieve specified in the URL parameter. Alternatively, the URL property can specify the document to receive. To receive the document call the Get method. 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 HTTPS bean supports the HTTP Basic authentication scheme through the User and Password properties. Other authentication schemes can be implemented by using the Authorization property.

Optionally, the bean can use the Microsoft WinInet library to implement the HTTP functionality. This is triggered by theUseWinInetconfiguration setting. Although some of the functionality of the bean (such as, for example, fine grained control over SSL server authentication) is not available through the WinInet compatibility layer, this option provides access to the Microsoft Internet Explorer settings on the system (such as default proxy settings, etc..) and more compatibility with Internet Explorer in general. This option is only available for Windows platforms.

Field Summary

static int	authBasic
static int	authDigest
static int	frAlways
static int	frNever
static int	frSameScheme
static int	fwNone
static int	fwSOCKS4
static int	fwSOCKS5
static int	fwTunnel
static int	psAlways
static int	psAutomatic
static int	psNever
static int	psTunnel
static int	sstMachine
static int	sstPEMKey
static int	sstPFXBlob
static int	sstPFXFile
static int	sstUser

Constructor Summary

Https()

Method Summary

void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Sets a cookie and the corresponding value.
void	addHttpsEventListener(HttpsEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a beanconfiguration setting.
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 authorization scheme to be used when server authorization is to be performed.
java.lang.String	getContentType() Content type for posted data.
int	getCookieCount() Number of cookies in the current request.
java.lang.String	getCookieName(int cookieIndex) Array of cookie names.
java.lang.String	getCookieValue(int cookieIndex) Array of cookie values.
java.lang.String	getFirewallHost() Name or IP address of firewall (optional).
java.lang.String	getFirewallPassword() A password if authentication is to be used when connecting through the firewall.
int	getFirewallPort() Port of the firewall to connect to.
int	getFirewallType() Determines the type of firewall to connect through.
java.lang.String	getFirewallUser() A user name if authentication is to be used connecting through a firewall.
int	getFollowRedirects() Determines what happens when the server issues a redirect.
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).
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).
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).
int	getProxySSL() Determines when to use SSL for the connection to the proxy.
java.lang.String	getProxyUser() A user name if Basic authentication is to be used for the proxy.
java.lang.String	getRange() The byte-range to be sent to the server.
java.lang.String	getReferer() Referer URL/document (optional).
byte[]	getSSLAcceptServerCert() Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
byte[]	getSSLCertEncoded() The SSL certificate (PEM/base64 encoded).
byte[]	getSSLCertStore() The name of the certificate store for the client certificate.
java.lang.String	getSSLCertStorePassword() The password for the certificate store (if any).
int	getSSLCertStoreType() The type of certificate store for the client certificate.
java.lang.String	getSSLCertSubject() The subject of the certificate used for client authentication.
byte[]	getSSLServerCert() The server certificate for the last established connection.
java.lang.String	getSSLServerCertStatus() The verification status of the server certificate for the last established connection.
java.lang.String	getStatusLine() The first line of the last server response.
int	getTimeout() A timeout for the bean.
byte[]	getTransferredData() The contents of the last transfer.
java.lang.String	getTransferredHeaders() The full set of headers as received from the server.
java.lang.String	getURL() The URL to 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) Fetch the document headers using the HTTP HEAD method.
void	interrupt() Interrupt the current method.
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	removeHttpsEventListener(HttpsEventListener 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	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 authorization scheme to be used when server authorization is to be performed.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setContentType(java.lang.String contentType) Content type for posted data.
void	setCookieCount(int cookieCount) Number of cookies in the current request.
void	setCookieName(int cookieIndex, java.lang.String cookieName) Array of cookie names.
void	setCookieValue(int cookieIndex, java.lang.String cookieValue) Array of cookie values.
void	setFirewallHost(java.lang.String firewallHost) Name or IP address of firewall (optional).
void	setFirewallPassword(java.lang.String firewallPassword) A password if authentication is to be used when connecting through the firewall.
void	setFirewallPort(int firewallPort) Port of the firewall to connect to.
void	setFirewallType(int firewallType) Determines the type of firewall to connect through.
void	setFirewallUser(java.lang.String firewallUser) A user name if authentication is to be used connecting through a firewall.
void	setFollowRedirects(int followRedirects) Determines what happens when the server issues a redirect.
void	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	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	setProxySSL(int proxySSL) Determines when to use SSL for the connection to the proxy.
void	setProxyUser(java.lang.String proxyUser) A user name if Basic authentication is to be used for the proxy.
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	setSSLAcceptServerCert(byte[] SSLAcceptServerCert) Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
void	setSSLCertEncoded(byte[] SSLCertEncoded) The SSL certificate (PEM/base64 encoded).
void	setSSLCertStore(byte[] SSLCertStore) The name of the certificate store for the client certificate.
void	setSSLCertStorePassword(java.lang.String SSLCertStorePassword) The password for the certificate store (if any).
void	setSSLCertStoreType(int SSLCertStoreType) The type of certificate store for the client certificate.
void	setSSLCertSubject(java.lang.String SSLCertSubject) The subject of the certificate used for client authentication.
void	setTimeout(int timeout) A timeout for the bean.
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

authBasic

public static final int authBasic

See Also:

Constant Field Values

authDigest

public static final int authDigest

See Also:

Constant Field Values

fwNone

public static final int fwNone

See Also:

Constant Field Values

fwTunnel

public static final int fwTunnel

See Also:

Constant Field Values

fwSOCKS4

public static final int fwSOCKS4

See Also:

Constant Field Values

fwSOCKS5

public static final int fwSOCKS5

See Also:

Constant Field Values

frNever

public static final int frNever

See Also:

Constant Field Values

frAlways

public static final int frAlways

See Also:

Constant Field Values

frSameScheme

public static final int frSameScheme

See Also:

Constant Field Values

psAutomatic

public static final int psAutomatic

See Also:

Constant Field Values

psAlways

public static final int psAlways

See Also:

Constant Field Values

psNever

public static final int psNever

See Also:

Constant Field Values

psTunnel

public static final int psTunnel

See Also:

Constant Field Values

sstUser

public static final int sstUser

See Also:

Constant Field Values

sstMachine

public static final int sstMachine

See Also:

Constant Field Values

sstPFXFile

public static final int sstPFXFile

See Also:

Constant Field Values

sstPFXBlob

public static final int sstPFXBlob

See Also:

Constant Field Values

sstPEMKey

public static final int sstPEMKey

See Also:

Constant Field Values

Constructor Detail

Https

public Https()

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

setAccept

public void setAccept(java.lang.String accept)
               throws IPWorksSSLException

A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

IPWorksSSLException

getAttachedFile

public java.lang.String getAttachedFile()

A file to append to PostData if the POST or PUT methods are used.

If AttachedFile is a non-empty string, then if the HTTP 'POST' or 'PUT' methods are used (through the Post or Put methods), the contents of the AttachedFile 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, the AttachedFile must be MIME encoded, or you should use the WEBUPLOADS component.

setAttachedFile

public void setAttachedFile(java.lang.String attachedFile)
                     throws IPWorksSSLException

A file to append to PostData if the POST or PUT methods are used.

If AttachedFile is a non-empty string, then if the HTTP 'POST' or 'PUT' methods are used (through the Post or Put methods), the contents of the AttachedFile 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, the AttachedFile must be MIME encoded, or you should use the WEBUPLOADS component.

IPWorksSSLException

getAuthorization

public java.lang.String getAuthorization()

The Authorization string to be sent to the server.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

setAuthorization

public void setAuthorization(java.lang.String authorization)
                      throws IPWorksSSLException

The Authorization string to be sent to the server.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

IPWorksSSLException

getAuthScheme

public int getAuthScheme()

The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

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

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksSSLException

The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

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

IPWorksSSLException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksSSLException

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

IPWorksSSLException

getContentType

public java.lang.String getContentType()

Content type for posted data.

If the ContentType property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data being POST-ed to the server.

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to "application/x-www-form-urlencoded" .

setContentType

public void setContentType(java.lang.String contentType)
                    throws IPWorksSSLException

Content type for posted data.

If the ContentType property contains a non-empty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data being POST-ed to the server.

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to "application/x-www-form-urlencoded" .

IPWorksSSLException

getCookieCount

public int getCookieCount()

Number of cookies in the current request.

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

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

setCookieCount

public void setCookieCount(int cookieCount)
                    throws IPWorksSSLException

Number of cookies in the current request.

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

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

IPWorksSSLException

getCookieName

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

Array of cookie names.

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

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

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

IPWorksSSLException

setCookieName

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

Array of cookie names.

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

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

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

IPWorksSSLException

getCookieValue

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

Array of cookie values.

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

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

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

IPWorksSSLException

setCookieValue

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

Array of cookie values.

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

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

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

IPWorksSSLException

getFirewallHost

public java.lang.String getFirewallHost()

Name or IP address of firewall (optional).

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

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

setFirewallHost

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

Name or IP address of firewall (optional).

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

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

IPWorksSSLException

getFirewallPassword

public java.lang.String getFirewallPassword()

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

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

setFirewallPassword

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

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

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

IPWorksSSLException

getFirewallPort

public int getFirewallPort()

Port of the firewall to connect to.

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

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

setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksSSLException

Port of the firewall to connect to.

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

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

IPWorksSSLException

getFirewallType

public int getFirewallType()

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

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

fwSOCKS4 (2)

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

fwSOCKS5 (3)

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

setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksSSLException

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

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

fwSOCKS4 (2)

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

fwSOCKS5 (3)

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

IPWorksSSLException

getFirewallUser

public java.lang.String getFirewallUser()

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

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

setFirewallUser

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

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

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

IPWorksSSLException

getFollowRedirects

public int getFollowRedirects()

Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksSSLException

Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

IPWorksSSLException

getFrom

public java.lang.String getFrom()

The email address of the HTTP agent (optional).

If the From property contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

setFrom

public void setFrom(java.lang.String from)
             throws IPWorksSSLException

The email address of the HTTP agent (optional).

If the From property contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

IPWorksSSLException

getHTTPMethod

public java.lang.String getHTTPMethod()

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.

setHTTPMethod

public void setHTTPMethod(java.lang.String HTTPMethod)
                   throws IPWorksSSLException

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.

IPWorksSSLException

isIdle

public boolean isIdle()

The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

getIfModifiedSince

public java.lang.String getIfModifiedSince()

A date determining the maximum age of the desired document.

If the IfModifiedSince property contains a non-empty string, a If-Modified-Since HTTP request header is added to the request. The value of the 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 only.

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.

setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)
                        throws IPWorksSSLException

A date determining the maximum age of the desired document.

If the IfModifiedSince property contains a non-empty string, a If-Modified-Since HTTP request header is added to the request. The value of the 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 only.

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.

IPWorksSSLException

getLocalFile

public java.lang.String getLocalFile()

The path to a local file for downloading. If the file exists, it is overwritten. (optional)

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of the Transfer event.

setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksSSLException

The path to a local file for downloading. If the file exists, it is overwritten. (optional)

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of the Transfer event.

IPWorksSSLException

getLocalHost

public java.lang.String getLocalHost()

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksSSLException

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

IPWorksSSLException

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must of the format "header: value" as specified in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .

Use this property with caution. If OtherHeaders contains invalid headers, HTTP requests may fail.

The OtherHeaders property is useful for extending the functionality of the bean beyond what is provided.

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksSSLException

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must of the format "header: value" as specified in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .

Use this property with caution. If OtherHeaders contains invalid headers, HTTP requests may fail.

The OtherHeaders property is useful for extending the functionality of the bean beyond what is provided.

IPWorksSSLException

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

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

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksSSLException

A password if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

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

IPWorksSSLException

getPostData

public byte[] getPostData()

The data to post with the URL if the POST method is used.

If PostData is a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of the PostData 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) 

setPostData

public void setPostData(byte[] postData)
                 throws IPWorksSSLException

The data to post with the URL if the POST method is used.

If PostData is a non-empty string, then if the HTTP 'POST' method is used ( Post method), the contents of the PostData 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) 

IPWorksSSLException

getPragma

public java.lang.String getPragma()

A browser/server specific header line (optional).

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

setPragma

public void setPragma(java.lang.String pragma)
               throws IPWorksSSLException

A browser/server specific header line (optional).

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

IPWorksSSLException

getProxyAuthorization

public java.lang.String getProxyAuthorization()

Similar to the Authorization property, but for proxy authorization.

If the Authorization property contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server.

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

setProxyAuthorization

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

Similar to the Authorization property, but for proxy authorization.

If the Authorization property contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server.

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

IPWorksSSLException

getProxyPassword

public java.lang.String getProxyPassword()

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

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

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

setProxyPassword

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

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

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

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

IPWorksSSLException

getProxyPort

public int getProxyPort()

Port for the proxy server (default 80).

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

setProxyPort

public void setProxyPort(int proxyPort)
                  throws IPWorksSSLException

Port for the proxy server (default 80).

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

IPWorksSSLException

getProxyServer

public java.lang.String getProxyServer()

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

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

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned. Note: if WinInet is enabled through theUseWinInetconfiguration setting, set ProxyServer to "*" if you wish to use the default proxy settings on the system.

setProxyServer

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

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

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

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned. Note: if WinInet is enabled through theUseWinInetconfiguration setting, set ProxyServer to "*" if you wish to use the default proxy settings on the system.

IPWorksSSLException

getProxySSL

public int getProxySSL()

Determines when to use SSL for the connection to the proxy.

The applicable values are the following:

psAutomatic (0)

Default setting. The connection to the ProxyServer is SSL-enabled for 'https' URL -s, and non SSL-enabled for other URL -s.

psAlways (1)

The connection is always SSL-enabled.

psNever (2)

The connection is not SSL-enabled.

psTunnel (3)

The connection is through a tunneling (HTTP) proxy.

setProxySSL

public void setProxySSL(int proxySSL)
                 throws IPWorksSSLException

Determines when to use SSL for the connection to the proxy.

The applicable values are the following:

psAutomatic (0)

Default setting. The connection to the ProxyServer is SSL-enabled for 'https' URL -s, and non SSL-enabled for other URL -s.

psAlways (1)

The connection is always SSL-enabled.

psNever (2)

The connection is not SSL-enabled.

psTunnel (3)

The connection is through a tunneling (HTTP) proxy.

IPWorksSSLException

getProxyUser

public java.lang.String getProxyUser()

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

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

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

setProxyUser

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

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

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

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

IPWorksSSLException

getRange

public java.lang.String getRange()

The byte-range to be sent to the server.

If the Range 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:

First 500 bytes

0-499

Second 500 bytes

500-999

Final 500 bytes

-500

setRange

public void setRange(java.lang.String range)
              throws IPWorksSSLException

The byte-range to be sent to the server.

If the Range 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:

First 500 bytes

0-499

Second 500 bytes

500-999

Final 500 bytes

-500

IPWorksSSLException

getReferer

public java.lang.String getReferer()

Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

setReferer

public void setReferer(java.lang.String referer)
                throws IPWorksSSLException

Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

IPWorksSSLException

getSSLAcceptServerCert

public byte[] getSSLAcceptServerCert()

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, these property will create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(byte[] SSLAcceptServerCert)
                            throws IPWorksSSLException

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, these property will create a security breach. Use it at your own risk.

IPWorksSSLException

getSSLCertEncoded

public byte[] getSSLCertEncoded()

The SSL certificate (PEM/base64 encoded).

This property is used to assign a specific certificate for SSL client authentication (SSL server authentication in the case of the IPDaemonS bean). The SSLCertStore and SSLCertSubject properties may also be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate, otherwise SSLCertSubject is set to empty string.

setSSLCertEncoded

public void setSSLCertEncoded(byte[] SSLCertEncoded)
                       throws IPWorksSSLException

The SSL certificate (PEM/base64 encoded).

This property is used to assign a specific certificate for SSL client authentication (SSL server authentication in the case of the IPDaemonS bean). The SSLCertStore and SSLCertSubject properties may also be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate, otherwise SSLCertSubject is set to empty string.

IPWorksSSLException

getSSLCertStore

public byte[] getSSLCertStore()

The name of the certificate store for the client certificate.

The SSLCertStoreType property specifies the type of the certificate store specified by SSLCertStore . If the store is password protected, specify the password in SSLCertStorePassword .

SSLCertStore is used in conjunction with the SSLCertSubject property in order to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please refer to the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY

A certificate store holding personal certificates with their associated private keys.

CA

Certifying authority certificates.

ROOT

Root certificates.

SPC

Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

setSSLCertStore

public void setSSLCertStore(byte[] SSLCertStore)
                     throws IPWorksSSLException

The name of the certificate store for the client certificate.

The SSLCertStoreType property specifies the type of the certificate store specified by SSLCertStore . If the store is password protected, specify the password in SSLCertStorePassword .

SSLCertStore is used in conjunction with the SSLCertSubject property in order to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please refer to the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY

A certificate store holding personal certificates with their associated private keys.

CA

Certifying authority certificates.

ROOT

Root certificates.

SPC

Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

IPWorksSSLException

getSSLCertStorePassword

public java.lang.String getSSLCertStorePassword()

The password for the certificate store (if any).

If the certificate store is of a type that requires a password, the value of this property is used to open the certificate store.

setSSLCertStorePassword

public void setSSLCertStorePassword(java.lang.String SSLCertStorePassword)
                             throws IPWorksSSLException

The password for the certificate store (if any).

If the certificate store is of a type that requires a password, the value of this property is used to open the certificate store.

IPWorksSSLException

getSSLCertStoreType

public int getSSLCertStoreType()

The type of certificate store for the client certificate.

This property can take one of the following values:

0 (sstUser - default)

For Windows, this specifies that the certificate store is a certificate store owned by the current user. For Java, this specifies that the certificate store is the name of a JKS (Java Key Store) file. If the provider is OpenSSL, this specifies that the certificate store is a file that contains PEM encoded certificate and private key.

1 (sstMachine)

The certificate store is a machine store (not available in Java and when provider is OpenSSL).

2 (sstPFXFile)

The certificate store is the name of a PFX (PKCS12) file containing certificates. If the provider is OpenSSL, the file may contain only one certificate and private key.

3 (sstPFXBlob)

The certificate store is a string (binary or base64 encoded) representing a certificate store in PFX (PKCS12) format.This setting is currently not supported when the provider is OpenSSL.

4 (sstPEMKey)

The certificate store is a string or filename that contains a PEM encoded certificate and private key.This store type is currently not supported in Java.

setSSLCertStoreType

public void setSSLCertStoreType(int SSLCertStoreType)
                         throws IPWorksSSLException

The type of certificate store for the client certificate.

This property can take one of the following values:

0 (sstUser - default)

For Windows, this specifies that the certificate store is a certificate store owned by the current user. For Java, this specifies that the certificate store is the name of a JKS (Java Key Store) file. If the provider is OpenSSL, this specifies that the certificate store is a file that contains PEM encoded certificate and private key.

1 (sstMachine)

The certificate store is a machine store (not available in Java and when provider is OpenSSL).

2 (sstPFXFile)

The certificate store is the name of a PFX (PKCS12) file containing certificates. If the provider is OpenSSL, the file may contain only one certificate and private key.

3 (sstPFXBlob)

The certificate store is a string (binary or base64 encoded) representing a certificate store in PFX (PKCS12) format.This setting is currently not supported when the provider is OpenSSL.

4 (sstPEMKey)

The certificate store is a string or filename that contains a PEM encoded certificate and private key.This store type is currently not supported in Java.

IPWorksSSLException

getSSLCertSubject

public java.lang.String getSSLCertSubject()

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

 Control.CertSubject = "Test" 

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, the SSLCertSubject property is set to the full subject of the matching certificate.

setSSLCertSubject

public void setSSLCertSubject(java.lang.String SSLCertSubject)
                       throws IPWorksSSLException

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

 Control.CertSubject = "Test" 

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, the SSLCertSubject property is set to the full subject of the matching certificate.

IPWorksSSLException

getSSLServerCert

public byte[] getSSLServerCert()

The server certificate for the last established connection.

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

getSSLServerCertStatus

public java.lang.String getSSLServerCertStatus()

The verification status of the server certificate for the last established connection.

When the verification fails, SSLServerCertStatus contains a string that indicates the reason(s) why, otherwise, it contains the string "OK".

Please note that the value of SSLServerCertStatus must be considered as only a suggestion as to the validity of the certificate. Application software must use its own logic to determine whether to accept the certificate or not, by using the SSLServerCert to access other certificate properties, or other application-specific information.

SSLServerCertStatus is reset an empty string every time a new connection is attempted.

getStatusLine

public java.lang.String getStatusLine()

The first line of the last server response.

This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the bean, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as: [HTTP version] [Result Code] [Description].

getTimeout

public int getTimeout()

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksSSLException

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

IPWorksSSLException

getTransferredData

public byte[] getTransferredData()

The contents of the last transfer.

If the LocalFile is empty, the data is accumulated in TransferredData . Otherwise, TransferredData returns an empty string.

TheMaxTransferredDataconfiguration setting controls the amount of data accumulated in TransferredData .

getTransferredHeaders

public java.lang.String getTransferredHeaders()

The full set of headers as received from the server.

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the bean.

getURL

public java.lang.String getURL()

The URL to fetch.

The URL of the document. This value is parsed, and the results are put in the URLScheme , URLServer , URLPort , and URLPath properties.

setURL

public void setURL(java.lang.String URL)
            throws IPWorksSSLException

The URL to fetch.

The URL of the document. This value is parsed, and the results are put in the URLScheme , URLServer , URLPort , and URLPath properties.

IPWorksSSLException

getURLPath

public java.lang.String getURLPath()

The path for the URL.

The URL path as determined by parsing the value set in the URL property.

setURLPath

public void setURLPath(java.lang.String URLPath)
                throws IPWorksSSLException

The path for the URL.

The URL path as determined by parsing the value set in the URL property.

IPWorksSSLException

getURLPort

public int getURLPort()

The port for the URL.

The HTTP server port as determined by parsing the value set in the URL property.

setURLPort

public void setURLPort(int URLPort)
                throws IPWorksSSLException

The port for the URL.

The HTTP server port as determined by parsing the value set in the URL property.

IPWorksSSLException

getURLScheme

public java.lang.String getURLScheme()

The scheme for the URL.

The URL scheme as determined by parsing the value set in the URL property.

The supported schemes are "http" and "https".

setURLScheme

public void setURLScheme(java.lang.String URLScheme)
                  throws IPWorksSSLException

The scheme for the URL.

The URL scheme as determined by parsing the value set in the URL property.

The supported schemes are "http" and "https".

IPWorksSSLException

getURLServer

public java.lang.String getURLServer()

The server for the URL.

The HTTP server name as determined by parsing the value set in the URL property.

setURLServer

public void setURLServer(java.lang.String URLServer)
                  throws IPWorksSSLException

The server for the URL.

The HTTP server name as determined by parsing the value set in the URL property.

IPWorksSSLException

getUser

public java.lang.String getUser()

A user name if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

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

setUser

public void setUser(java.lang.String user)
             throws IPWorksSSLException

A user name if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

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

IPWorksSSLException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksSSLException

Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

IPWorksSSLException

addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksSSLException

Sets a cookie and the corresponding value.

Please refer to the CookieName and CookieValue properties for more information on cookies and how they are managed.

IPWorksSSLException

doEvents

public void doEvents()
              throws IPWorksSSLException

Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

IPWorksSSLException

get

public void get(java.lang.String URL)
         throws IPWorksSSLException

Fetch the document using the HTTP GET method.

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

IPWorksSSLException

head

public void head(java.lang.String URL)
          throws IPWorksSSLException

Fetch the document headers using the HTTP HEAD method.

Fetch the document headers using the HTTP HEAD method. The headers are received through the Header event.

IPWorksSSLException

interrupt

public void interrupt()
               throws IPWorksSSLException

Interrupt the current method.

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

IPWorksSSLException

post

public void post(java.lang.String URL)
          throws IPWorksSSLException

Posts data to the HTTP server using the HTTP POST 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 WEBUPLOADS or WEBFORMS component.

Example (Performing a Post)

 HTTPControl.ContentType = "application/x-www-form-urlencoded"
 HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
 HTTPControl.Post(myurl) 

IPWorksSSLException

put

public void put(java.lang.String URL)
         throws IPWorksSSLException

Sends data to the HTTP server using the HTTP PUT method.

Send data to the HTTP server using the HTTP PUT method. 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 .

IPWorksSSLException

resetHeaders

public void resetHeaders()
                  throws IPWorksSSLException

Resets all HTTP headers, cookies, LocalFile , and AttachedFile .

Resets all the HTTP headers as well as LocalFile and AttachedFile to "" (empty string). Also sets CookieCount to 0 (resets cookie arrays). Use this method before creating a new request, so that headers from the previous message are not carried over to the next one.

IPWorksSSLException

addHttpsEventListener

public void addHttpsEventListener(HttpsEventListener l)
                           throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeHttpsEventListener

public void removeHttpsEventListener(HttpsEventListener l)