Package   Class  Tree  Deprecated  Index  Help 
IP*Works! SSL V9
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

ipworksssl
Class Atoms

java.lang.Object
  extended by ipworksssl.Atoms

public class Atoms
extends java.lang.Object

The AtomS Bean is used to retrieve, parse, and update Atom content.

The AtomS bean is the SSL-enabled equivalent of the IP*Works! Atom bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The ipworksssl.Atoms#config and {@link ipworksssl.Atoms#config configuration settings determine which protocols are enabled and at what security level. The {@link ipworksssl.Atoms#getSSLCert SSLCert} property is used to select a client certificate if the server is requesting client authentication. The {@link ipworksssl.Atoms#config configuration setting, together with the {@link ipworksssl.AtomsSSLServerAuthenticationEvent SSLServerAuthentication} event allow you to check the server identity and other security attributes. Finally, the {@link ipworksssl.AtomsSSLStatusEvent SSLStatus} event provides information about the SSL handshake.

The AtomS Bean implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).

The bean contains a number of properties that map directly to Atom fields. To receive a feed, call the {@link ipworksssl.Atoms#getFeed GetFeed} method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries collection using the {@link ipworksssl.Atoms#put Put} method.

The AtomS Bean supports all standard Atom properties and allows you to add your own through {@link ipworksssl.Atoms#addNamespace AddNamespace} or {@link ipworksssl.Atoms#getNamespaces Namespaces} collection and the {@link ipworksssl.Atoms#getProperty GetProperty} and {@link ipworksssl.Atoms#setProperty SetProperty} methods.

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
Atoms()
          Creates an instance of Atoms Bean.
Atoms(java.lang.String runtimeLicense)
          Creates an instance of Atoms Bean with specified run-time license.
 
Method Summary
 void addAtomsEventListener(AtomsEventListener l)
           
 void addCookie(java.lang.String cookieName, java.lang.String cookieValue)
          Adds a cookie and the corresponding value to the outgoing request headers.
 void addNamespace(java.lang.String prefix, java.lang.String namespaceURI)
          Adds a namespace to the Namespaces collection .
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a {@link ipworksssl.Atoms#config configuration setting.
 void deleteResource(java.lang.String URL)
          Deletes the resource at the specified URL.
 void doEvents()
          Processes events from the internal message queue.
 java.lang.String getAccept()
          A list of acceptable MIME types for the request.
 byte[] getAtomData()
          The complete content of the Atom resource.
 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.
 AtomChannel getChannel()
          The feed elements of a feed.
 java.lang.String getContentType()
          Content type for posts and puts.
 HTTPCookieList getCookies()
          Collection of cookies.
 AtomEntryList getEntries()
          A collection of entries in the current Atom feed.
 void getFeed(java.lang.String URL)
          Fetches an Atom feed.
 Firewall getFirewall()
          A set of properties related to firewall access.
 int getFollowRedirects()
          Determines what happens when the server issues a redirect.
 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.
 XMLNamespaceList getNamespaces()
          A collection of namespaces in the current namespace stack.
 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.
 java.lang.String getProperty(java.lang.String propertyName)
          Fetches the value of a specific Atom feed element or attribute.
 Proxy getProxy()
          A set of properties related to proxy access.
 java.lang.String getReferer()
          Referer URL/document (optional).
 void getResource(java.lang.String URL)
          Fetches a resource.
 java.lang.String getSlug()
          A header added to the HTTP request.
 Certificate getSSLAcceptServerCert()
          Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
 Certificate getSSLCert()
          The certificate to be used during SSL negotiation.
 Certificate getSSLServerCert()
          The server certificate for the last established connection.
 int getTimeout()
          A timeout for the bean.
 byte[] getTransferredData()
          The contents of the last response from the server.
 long getTransferredDataLimit()
          The maximum of bytes of data to be transferred.
 java.lang.String getTransferredHeaders()
          The full set of headers as received from the server.
 AtomEntry getUpdateEntry()
          An Atom entry to be updated, deleted or created.
 java.lang.String getUpdateFile()
          A resource to be updated, deleted or created.
 java.lang.String getUser()
          A user name if authentication is to be used.
 void interrupt()
          Interrupt the current method.
 boolean isConnected()
          Shows whether the bean is connected.
 boolean isIdle()
          The current status of the component.
 void postResource(java.lang.String URL)
          Posts a resource to the specified URL.
 void put(java.lang.String URL)
          Sends data to the HTTP server using the HTTP PUT method.
 void putResource(java.lang.String URL)
          Puts a resource to the specified URL.
 void readFile(java.lang.String fileName)
          Load an Atom file into the bean.
 void removeAtomsEventListener(AtomsEventListener l)
           
 void reset()
          Reset all properties of the bean.
 void setAccept(java.lang.String accept)
          A list of acceptable MIME types for the request.
 void setAtomData(byte[] atomData)
          The complete content of the Atom resource.
 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 setChannel(AtomChannel channel)
          The feed elements of a feed.
 void setConnected(boolean connected)
          Shows whether the bean is connected.
 void setContentType(java.lang.String contentType)
          Content type for posts and puts.
 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 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 setProperty(java.lang.String propertyName, java.lang.String propertyValue)
          Sets the value of a specific Atom feed property.
 void setProxy(Proxy proxy)
          A set of properties related to proxy access.
 void setReferer(java.lang.String referer)
          Referer URL/document (optional).
 void setSlug(java.lang.String slug)
          A header added to the HTTP request.
 void setSSLAcceptServerCert(Certificate SSLAcceptServerCert)
          Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
 void setSSLCert(Certificate SSLCert)
          The certificate to be used during SSL negotiation.
 void setTimeout(int timeout)
          A timeout for the bean.
 void setTransferredDataLimit(long transferredDataLimit)
          The maximum of bytes of data to be transferred.
 void setUpdateEntry(AtomEntry updateEntry)
          An Atom entry to be updated, deleted or created.
 void setUpdateFile(java.lang.String updateFile)
          A resource to be updated, deleted or created.
 void setUser(java.lang.String user)
          A user name if authentication is to be used.
 void writeFile(java.lang.String filename)
          Write an Atom feed from the bean.
 
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

authProprietary

public static final int authProprietary
See Also:
Constant Field Values

authNone

public static final int authNone
See Also:
Constant Field Values

authNtlm

public static final int authNtlm
See Also:
Constant Field Values

authNegotiate

public static final int authNegotiate
See Also:
Constant Field Values

authOAuth

public static final int authOAuth
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
Constructor Detail

Atoms

public Atoms()
Creates an instance of Atoms Bean.

Atoms

public Atoms(java.lang.String runtimeLicense)
Creates an instance of Atoms Bean with specified run-time license.

Method Detail

getAccept

public java.lang.String getAccept()
A list of acceptable MIME types for the request.

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.

setAccept

public void setAccept(java.lang.String accept)
               throws IPWorksSSLException
A list of acceptable MIME types for the request.

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.

Throws:
IPWorksSSLException

getAtomData

public byte[] getAtomData()
The complete content of the Atom resource.

This property will contain the bytes received when retrieving Atom feeds or a media type through the GetResource method. When writing an Atom feed using the WriteFile method, the AtomData will be generated from the existing properties.

setAtomData

public void setAtomData(byte[] atomData)
                 throws IPWorksSSLException
The complete content of the Atom resource.

This property will contain the bytes received when retrieving Atom feeds or a media type through the GetResource method. When writing an Atom feed using the WriteFile method, the AtomData will be generated from the existing properties.

Throws:
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.

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

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.

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

Throws:
IPWorksSSLException

getAuthScheme

public int getAuthScheme()
The authentication scheme to use when server authorization is required.

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 {@link ipworksssl.Atoms#config .

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksSSLException
The authentication scheme to use when server authorization is required.

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 {@link ipworksssl.Atoms#config .

Throws:
IPWorksSSLException

getChannel

public AtomChannel getChannel()
The feed elements of a feed.

This property contains the "feed" elements of an ATOM feed. The Channel property has fields which contain values for sub-elements of the "feed" element.

setChannel

public void setChannel(AtomChannel channel)
                throws IPWorksSSLException
The feed elements of a feed.

This property contains the "feed" elements of an ATOM feed. The Channel property has fields which contain values for sub-elements of the "feed" element.

Throws:
IPWorksSSLException

isConnected

public boolean isConnected()
Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksSSLException
Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

Throws:
IPWorksSSLException

getContentType

public java.lang.String getContentType()
Content type for posts and puts.

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 PostResource or PutResource to the server.

setContentType

public void setContentType(java.lang.String contentType)
                    throws IPWorksSSLException
Content type for posts and puts.

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 PostResource or PutResource to the server.

Throws:
IPWorksSSLException

getCookies

public HTTPCookieList getCookies()
Collection of cookies.

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 .

{@link ipworksssl.Atoms#config can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size - 1.

getEntries

public AtomEntryList getEntries()
A collection of entries in the current Atom feed.

This property is a collection of entries in the current Atom feed. When an Atom feed is parsed by the component, all of the items in the feed are stored as AtomEntry types in this collection.

To create a new Atom feed, this collection can also be populated before writing with WriteFile or PutResource .

This collection is indexed from 0 to size - 1.

getFirewall

public Firewall getFirewall()
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksSSLException
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:
IPWorksSSLException

getFollowRedirects

public int getFollowRedirects()
Determines what happens when the server issues a redirect.

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.

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksSSLException
Determines what happens when the server issues a redirect.

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.

Throws:
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 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.

setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)
                        throws IPWorksSSLException
A date determining the maximum age of the desired document.

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.

Throws:
IPWorksSSLException

getLocalFile

public java.lang.String getLocalFile()
The path to a local file for downloading. If the file exists, it is overwritten.

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.

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.

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.

Throws:
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 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.

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

Throws:
IPWorksSSLException

getNamespaces

public XMLNamespaceList getNamespaces()
A collection of namespaces in the current namespace stack.

This property contains a list of the XML namespaces that exist in the current Atom channel. The general Atom protocol allows non-standard fields to be added through XML namespaces.

When parsing an Atom feed retrieved through the GetFeed method, the bean will store all properties that are standard in version 2.0 of the Atom protocol, regardless of the version given by the feed. For non-standard properties, it will verify that the property has a namespace and that the namespace is defined within the Atom feed. If a property's definition cannot be found, the bean throws an exception. Non-standard fields can be retrieved through the GetProperty method.

When using the WriteFile method to generate an Atom feed that contains non-standard properties you must use the SetProperty method.

Please see the GetProperty and SetProperty methods for details on argument syntax.

If the Atom URL is not found in the namespace collection, it will be added as the default namespace when generating a feed. That namespace is "http://www.w3.org/2005/Atom".

This collection is indexed from 0 to size - 1.

getOtherHeaders

public java.lang.String getOtherHeaders()
Other headers as determined by the user (optional).

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.

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksSSLException
Other headers as determined by the user (optional).

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.

Throws:
IPWorksSSLException

getParsedHeaders

public HeaderList getParsedHeaders()
Collection of headers returned from the last request.

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.

{@link ipworksssl.Atoms#config can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size - 1.

getPassword

public java.lang.String getPassword()
A password if authentication is to be used.

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 ipworksssl.Atoms#config config setting in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksSSLException
A password if authentication is to be used.

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 ipworksssl.Atoms#config config setting in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:
IPWorksSSLException

getProxy

public Proxy getProxy()
A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

setProxy

public void setProxy(Proxy proxy)
              throws IPWorksSSLException
A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

Throws:
IPWorksSSLException

getReferer

public java.lang.String getReferer()
Referer URL/document (optional).

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.

setReferer

public void setReferer(java.lang.String referer)
                throws IPWorksSSLException
Referer URL/document (optional).

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.

Throws:
IPWorksSSLException

getSlug

public java.lang.String getSlug()
A header added to the HTTP request.

This property requests that the server use the header's value as part of any URLs that it would normally generate when creating the Entry or Media resources. Some servers ignore this header.

setSlug

public void setSlug(java.lang.String slug)
             throws IPWorksSSLException
A header added to the HTTP request.

This property requests that the server use the header's value as part of any URLs that it would normally generate when creating the Entry or Media resources. Some servers ignore this header.

Throws:
IPWorksSSLException

getSSLAcceptServerCert

public Certificate 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, this property may create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(Certificate 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, this property may create a security breach. Use it at your own risk.

Throws:
IPWorksSSLException

getSSLCert

public Certificate getSSLCert()
The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

setSSLCert

public void setSSLCert(Certificate SSLCert)
                throws IPWorksSSLException
The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Throws:
IPWorksSSLException

getSSLServerCert

public Certificate 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.

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 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 ipworksssl.Atoms#config configuration setting.

The default value for the {@link ipworksssl.Atoms#getTimeout 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 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 ipworksssl.Atoms#config configuration setting.

The default value for the {@link ipworksssl.Atoms#getTimeout Timeout} property is 60 (seconds).

Throws:
IPWorksSSLException

getTransferredData

public byte[] getTransferredData()
The contents of the last response from the server.

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

getTransferredDataLimit

public long getTransferredDataLimit()
The maximum of bytes of data to be transferred.

This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.

setTransferredDataLimit

public void setTransferredDataLimit(long transferredDataLimit)
                             throws IPWorksSSLException
The maximum of bytes of data to be transferred.

This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.

Throws:
IPWorksSSLException

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.

getUpdateEntry

public AtomEntry getUpdateEntry()
An Atom entry to be updated, deleted or created.

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is empty, UpdateEntry will be used to form the content of the HTTP request.

setUpdateEntry

public void setUpdateEntry(AtomEntry updateEntry)
                    throws IPWorksSSLException
An Atom entry to be updated, deleted or created.

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is empty, UpdateEntry will be used to form the content of the HTTP request.

Throws:
IPWorksSSLException

getUpdateFile

public java.lang.String getUpdateFile()
A resource to be updated, deleted or created.

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is set to a local file, the content of that file will be used to form the content of the HTTP request.

setUpdateFile

public void setUpdateFile(java.lang.String updateFile)
                   throws IPWorksSSLException
A resource to be updated, deleted or created.

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is set to a local file, the content of that file will be used to form the content of the HTTP request.

Throws:
IPWorksSSLException

getUser

public java.lang.String getUser()
A user name if authentication is to be used.

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 ipworksssl.Atoms#config property in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

setUser

public void setUser(java.lang.String user)
             throws IPWorksSSLException
A user name if authentication is to be used.

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 ipworksssl.Atoms#config property in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Atoms#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:
IPWorksSSLException

addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksSSLException
Adds a cookie and the corresponding value to the outgoing request headers.

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.

Throws:
IPWorksSSLException

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.String namespaceURI)
                  throws IPWorksSSLException
Adds a namespace to the Namespaces collection .

This method is used to add a namespace to the Namespaces collection . Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Throws:
IPWorksSSLException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksSSLException
Sets or retrieves a ipworksssl.Atoms#config configuration setting.

{@link ipworksssl.Atoms#config Config} is a generic method available in every bean. It is used to set and retrieve {@link ipworksssl.Atoms#config configuration settingsfor the bean.

These 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 {@link ipworksssl.Atoms#config 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 {@link ipworksssl.Atoms#config 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 {@link ipworksssl.Atoms#config Config} method.

Atom Configuration Settings

MaxEntries
Instructs the bean to save a maximum number of entries from the ATOM feed
This config should be set when the {@link ipworksssl.Atoms#getEntries Entries} collection is to be populated when a feed is being parsed by the bean. This value represents the number of entries 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.

HTTP Configuration Settings

AcceptEncoding
Used to tell the server which types of content encodings the client supports
When {@link ipworksssl.Atoms#getAllowHTTPCompression 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
This property enables HTTP compression for receiving data
This is the same as the {@link ipworksssl.Atoms#getAllowHTTPCompression AllowHTTPCompression} property. This setting is exposed here for use by beans that inherit from HTTP.
Authorization
The Authorization string to be sent to the server
If the {@link ipworksssl.Atoms#config 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 {@link ipworksssl.Atoms#getAuthScheme AuthScheme} property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred
Contains the number of bytes transferred in the response data
Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the {@link ipworksssl.AtomsTransferEvent Transfer} event, by BytesTransferred .
EncodeURL
If set to true the URL will be encoded by the bean
The default value is false. If set to true the URL passed to the bean will be URL encoded.
FollowRedirects
Determines what happens when the server issues a redirect
This option 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 1 (always), the new {@link ipworksssl.Atoms#getURL URL} for the object is retrieved automatically every time.If this property is set to 2 (Same Scheme), the new {@link ipworksssl.Atoms#getURL URL} is retrieved automatically only if the URL Scheme is the same, otherwise the bean throws an exception.

Note that following the HTTP specification, unless this option is set to 1 (Always), 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, {@link ipworksssl.Atoms#getUser User} and {@link ipworksssl.Atoms#getPassword Password} are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

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

The default value is 0 (Never). In this case, redirects are never followed, and the bean throws an exception instead.

Valid options are:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect
If set to true the bean will perform a GET on the new location
The default value is false. If set to true the bean will perform a GET on the new location. Otherwise it will use the same HTTP method again.
HTTPVersion
The version of HTTP used by the bean
Possible values include "1.0", and "1.1". The default is "1.1".
IfModifiedSince
A date determining the maximum age of the desired document
This is the same as the {@link ipworksssl.Atoms#getIfModifiedSince IfModifiedSince} property. This setting is exposed here for use by beans that inherit from HTTP.
KeepAlive
Determines whether the HTTP connection is closed after completion of the request
If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting {@link ipworksssl.Atoms#getOtherHeaders OtherHeaders} to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.The default value for {@link ipworksssl.Atoms#config is false.

MaxHeaders
Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired
This config should be set when the {@link ipworksssl.Atoms#getTransferredHeaders TransferredHeaders} collection is to be populated when a {@link ipworksssl.AtomsHeaderEvent 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.

MaxHTTPCookies
Instructs bean to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
This config should be set when populating the {@link ipworksssl.Atoms#getCookies 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.

MaxRedirectAttempts
Limits the number of redirects that are followed in a request
When {@link ipworksssl.Atoms#getFollowRedirects 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.
OtherHeaders
Other headers as determined by the user (optional)
This configuration option can be set to a string of headers to be appended to the HTTP request headers.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 configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail.

This configuration option is useful for extending the functionality of the bean beyond what is provided.

ProxyAuthorization
The authorization string to be sent to the proxy server
Similar to the {@link ipworksssl.Atoms#config 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 .
ProxyAuthScheme
The authorization scheme to be used for the proxy
This is the same as AuthScheme . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyPassword
A password if authentication is to be used for the proxy
This is the same as Password . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyPort
Port for the proxy server (default 80)
This is the same as Port . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyServer
Name or IP address of a proxy server (optional)
This is the same as Server . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyUser
A user name if authentication is to be used for the proxy
This is the same as User . This setting is provided for use by beans that do not directly expose Proxy properties.
TransferredDataLimit
The maximum number of incoming bytes to be stored by the bean
If {@link ipworksssl.Atoms#config is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the bean. If {@link ipworksssl.Atoms#config is set to 0, no limits are imposed.
TransferredHeaders
The full set of headers as received from the server
This configuration setting returns the complete set of raw headers as received from the server.
UseChunkedEncoding
Enables or Disables HTTP chunked encoding for transfers
If UseChunkedEncoding is set to true, the bean will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the bean will not use HTTP chunked encoding. The default value is false. Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

ChunkSize
Specifies the chunk size in bytes when using chunked encoding
This is only applicable when {@link ipworksssl.Atoms#config is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
UsePlatformHTTPClient
Whether or not to use the platform HTTP client
If True, the component will use the default HTTP client for the platform ( URLConnection in Java or WebRequest in .NET) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).
UserAgent
Information about the user agent (browser)
This is the value supplied in the HTTP User-Agent header. The default setting is "/n software IPWorks HTTP/S Component - www.nsoftware.com".Override the default with the name and version of your software.

KerberosSPN
The Service Principal Name for the Kerberos Domain Controller
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

IPPort Configuration Settings

ConnectionTimeout
Sets a separate timeout value for establishing a connection
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the bean will use {@link ipworksssl.Atoms#getTimeout Timeout} for establishing a connection and transmitting/receiving data.
FirewallAutoDetect
Tells the bean whether or not to automatically detect and use firewall system settings, if available
This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallHost
Name or IP address of firewall (optional)
If a {@link ipworksssl.Atoms#config is given, requested connections will be authenticated through the specified firewall when connecting.If the {@link ipworksssl.Atoms#config setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the {@link ipworksssl.Atoms#config 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.

FirewallListener
If true, the component binds to a SOCKS firewall as a server (IPPort only)
This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. {@link ipworksssl.Atoms#getRemoteHost RemoteHost} and {@link ipworksssl.Atoms#getRemotePort RemotePort} are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore {@link ipworksssl.Atoms#getRemoteHost RemoteHost} , and it is recommended that {@link ipworksssl.Atoms#getRemoteHost RemoteHost} be set to empty string in this case.

{@link ipworksssl.Atoms#getRemotePort 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 {@link ipworksssl.AtomsConnectionStatusEvent ConnectionStatus} event.

The connection to the firewall is made by calling the {@link ipworksssl.Atoms#connect Connect} method.

FirewallPassword
Password to be used if authentication is to be used when connecting through the firewall
If {@link ipworksssl.Atoms#config is specified, the {@link ipworksssl.Atoms#config and {@link ipworksssl.Atoms#config 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
The TCP port for the FirewallHost;
Note that the {@link ipworksssl.Atoms#config is set automatically when {@link ipworksssl.Atoms#config 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.

FirewallType
Determines the type of firewall to connect through
The appropriate values are as follows:
0
No firewall (default setting).
1
Connect through a tunneling proxy. {@link ipworksssl.Atoms#config is set to 80.
2
Connect through a SOCKS4 Proxy. {@link ipworksssl.Atoms#config is set to 1080.
3
Connect through a SOCKS5 Proxy. {@link ipworksssl.Atoms#config is set to 1080.
NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser
A user name if authentication is to be used connecting through a firewall
If the {@link ipworksssl.Atoms#config is specified, the {@link ipworksssl.Atoms#config and {@link ipworksssl.Atoms#config 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.

KeepAliveTime
The inactivity time in milliseconds before a TCP keep-alive packet is sent
When set, {@link ipworksssl.Atoms#config 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.

KeepAliveInterval
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received
When set, {@link ipworksssl.Atoms#config will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by {@link ipworksssl.Atoms#config . 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.

Linger
When set to True, connections are terminated gracefully
This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if {@link ipworksssl.Atoms#config 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, {@link ipworksssl.Atoms#config is a positive value, the system will attempt to send pending data until the specified {@link ipworksssl.Atoms#config 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.

LingerTime
Time in seconds to have the connection linger
LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.
LocalHost
The name of the local host through which connections are initiated or accepted
The {@link ipworksssl.Atoms#getLocalHost 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 {@link ipworksssl.Atoms#getLocalHost 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
The TCP port in the local host where the bean binds
This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by {@link ipworksssl.Atoms#getLocalPort LocalPort} after the connection is established.

{@link ipworksssl.Atoms#getLocalPort 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
The maximum amount of data to accumulate when no EOL is found
{@link ipworksssl.Atoms#config is the size of an internal buffer, which holds received data while waiting for an {@link ipworksssl.Atoms#getEOL EOL} string.If an {@link ipworksssl.Atoms#getEOL EOL} string is found in the input stream before {@link ipworksssl.Atoms#config bytes are received, the {@link ipworksssl.AtomsDataInEvent DataIn} event is fired with the EOL parameter set to True, and the buffer is reset.

If no {@link ipworksssl.Atoms#getEOL EOL} is found, and {@link ipworksssl.Atoms#config bytes are accumulated in the buffer, the {@link ipworksssl.AtomsDataInEvent DataIn} event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for {@link ipworksssl.Atoms#config is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate
The transfer rate limit in bytes per second
This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.
TCPKeepAlive
Determines whether or not the keep alive socket option is enabled
If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set {@link ipworksssl.Atoms#config and {@link ipworksssl.Atoms#config to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6
Whether or not to use IPv6
By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.
CloseStreamAfterTransfer
If true, the component will close the upload or download stream after the transfer
This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.
TcpNoDelay
Whether or not to delay when sending packets
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

SSL Configuration Settings

ReuseSSLSession
Determines if the SSL session is reused
If set to true, the component will reuse the context if and only if the following criteria are met:
  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the component is the same.

SSLCipherStrength
The minimum cipher strength used for bulk encryption
This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the {@link ipworksssl.AtomsSSLStatusEvent SSLStatus} event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Atoms#config config setting.

SSLEnabledProtocols
Used to enable/disable the supported security protocols
Used to enable/disable the supported security protocols.Not all supported protocols are enabled by default (the value of this setting is 192). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.2
3072 (Hex C00)
TLS1.1
768 (Hex 300)
TLS1
192 (Hex C0) (Default)
SSL3
48 (Hex 30)
SSL2
12 (Hex 0C)
Please note that although a number of sites still support SSL2, it is usually a good idea to disable it because of potential security vulnerabilities.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Atoms#config config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

SSLProvider
The name of the security provider to use
Change this setting to use security providers other than the system default.Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

SSLSecurityFlags
Flags that control certificate verification
The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
0x00000001
Ignore time validity status of certificate.
0x00000002
Ignore time validity status of CTL.
0x00000004
Ignore non-nested certificate times.
0x00000010
Allow unknown Certificate Authority.
0x00000020
Ignore wrong certificate usage.
0x00000100
Ignore unknown certificate revocation status.
0x00000200
Ignore unknown CTL signer revocation status.
0x00000400
Ignore unknown Certificate Authority revocation status.
0x00000800
Ignore unknown Root revocation status.
0x00008000
Allow test Root certificate.
0x00004000
Trust test Root certificate.
0x80000000
Ignore non-matching CN (certificate CN not-matching server name).
This functionality is currently not available in Java or when the provider is OpenSSL.

SSLContextProtocol
The protocol used when getting an SSLContext instance
Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.
SSLTrustManagerFactoryAlgorithm
The algorithm to be used to create a TrustManager through TrustManagerFactory
Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.
SSLEnabledCipherSuites
The cipher suite to be used in an SSL negotiation
The enabled cipher suites to be used in SSL negotiation.By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values: 

 obj.config("SSLEnabledCipherSuites=*");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values include:
  • SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_RC4_128_SHA
  • SSL_RSA_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_WITH_DES_CBC_SHA
  • SSL_RSA_WITH_NULL_MD5
  • SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
  • SSL_DHE_RSA_WITH_DES_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
  • SSL_RSA_WITH_NULL_SHA
  • SSL_DH_anon_WITH_RC4_128_MD5
  • SSL_RSA_WITH_RC4_128_MD5
  • SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_NULL_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_anon_WITH_RC4_128_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_EXPORT_WITH_RC4_40_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDH_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDH_anon_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_NULL_SHA256
  • TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
  • TLS_KRB5_WITH_RC4_128_MD5
  • TLS_ECDHE_ECDSA_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_RC4_128_SHA
  • TLS_EMPTY_RENEGOTIATION_INFO_SCSV
  • TLS_KRB5_WITH_3DES_EDE_CBC_MD5
  • TLS_KRB5_WITH_RC4_128_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_NULL_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_DES_CBC_MD5
  • TLS_KRB5_EXPORT_WITH_RC4_40_MD5
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
  • TLS_ECDH_anon_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_NULL_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA

SSLEnabledCipherSuites is used together with SSLCipherStrength .

Note: This configuration setting is available only in .NET and Java.

SSLAlgorithmList
A string that controls the cipher algorithms to be used by SSL
This configuration option takes a semicolon (;) delimited list of cipher algorithms to specify what algorithms may be used by SSL. This option can be used in conjunction with SSLEnabledProtocols to control which ciphers are used.For example: 
 obj.Config("SSLEnabledProtocols=3072"); // TLS1.2  (supports SHA_256)
   obj.Config("SSLAlgorithmList=CALG_SHA_256;CALG_MD5");
Possible values include:
  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF

This option is only valid in Windows.

Socket Configuration Settings

AbsoluteTimeout
Determines whether timeouts are inactivity timeouts or absolute timeouts
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.Note: This option is not valid for UDP ports.

FirewallData
Used to send extra data to the firewall
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
InBufferSize
The size in bytes of the incoming queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize
The size in bytes of the outgoing queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable
Tells the bean whether or not a message loop is available for processing events
In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

UseDaemonThreads
Whether threads created by the bean are daemon threads
If set to True, when the bean creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the bean will not set the Daemon property on the created thread.

Throws:
IPWorksSSLException

deleteResource

public void deleteResource(java.lang.String URL)
                    throws IPWorksSSLException
Deletes the resource at the specified URL.

The bean will delete a resource at the specified URL.

Throws:
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.

Throws:
IPWorksSSLException

getFeed

public void getFeed(java.lang.String URL)
             throws IPWorksSSLException
Fetches an Atom feed.

This method fetches the document. The document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers through the Header event.

The bean will then attempt to parse the Atom feed, filling in the Channel and Entries properties as it goes. The Channel properties can also be accessed using the GetProperty and SetProperty methods if necessary.

Throws:
IPWorksSSLException

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
                             throws IPWorksSSLException
Fetches the value of a specific Atom feed element or attribute.

This method is intended for extending functionality of the Atom bean. It will fetch the value for a specific entry element or attribute of this Atom feed. Property is the XPath of the element or attribute according to the following convention: /feed/element@attribute or entry[x]/element@attribute . The @attribute part is optional.

entry[x] is the Channel 's xth entry (or any other root level child), where the indexer x starts at 1.

element is any child of the Channel or an entry, and attribute can be any attribute of that field. If an attribute is not supplied, the GetProperty method will return the text portion of element . For example: 

 AtomControl.GetProperty("entry[5]/link@href")
   AtomControl.GetProperty("entry[5]/author/name")
   AtomControl.GetProperty("/feed/title")

Note : in order to add non-standard fields (i.e. fields that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces collection to define and list namespaces.

Throws:
IPWorksSSLException

getResource

public void getResource(java.lang.String URL)
                 throws IPWorksSSLException
Fetches a resource.

This method fetches the resource. If LocalFile is set, the document will be saved in the file specified. Otherwise, the document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers through the Header event.

Unlike the GetFeed method, after retrieval, the bean will not attempt to parse the data into the Channel and Entries properties.

Throws:
IPWorksSSLException

interrupt

public void interrupt()
               throws IPWorksSSLException
Interrupt the current method.

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

Throws:
IPWorksSSLException

postResource

public void postResource(java.lang.String URL)
                  throws IPWorksSSLException
Posts a resource to the specified URL.

This method will post a resource to the specified URL. It will either post a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry .

Throws:
IPWorksSSLException

put

public void put(java.lang.String URL)
         throws IPWorksSSLException
Sends data to the HTTP server using the HTTP PUT method.

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry .

Throws:
IPWorksSSLException

putResource

public void putResource(java.lang.String URL)
                 throws IPWorksSSLException
Puts a resource to the specified URL.

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry .

Throws:
IPWorksSSLException

readFile

public void readFile(java.lang.String fileName)
              throws IPWorksSSLException
Load an Atom file into the bean.

This method loads an Atom file and attempts to parse it, filling in the Channel and Entries properties as it goes. The Channel properties can also be accessed using the GetProperty and SetProperty methods if necessary.

Throws:
IPWorksSSLException

reset

public void reset()
           throws IPWorksSSLException
Reset all properties of the bean.

This method resets all properties to the bean's default settings. This is an easy way to clear all of the property values before repopulating the Atom feed.

Throws:
IPWorksSSLException

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws IPWorksSSLException
Sets the value of a specific Atom feed property.

This method is intended for extending functionality of the Atom bean. It will set the value for a specific field of this Atom feed. Property is the name of the property according to the following convention: root/element@attribute . The root field can be either of the two following values:

feed
This treats the channel as the root level, and element is any property of the channel. If an empty string ("") is supplied for the root field, the bean will assume channel as the root.
entry[x]
This treats the channel's x-th entry as the root level The field element is any property of an entry.

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element . For example: 

 AtomControl.SetProperty("entry[5]/link@type", "text/html")

Note : in order to add non-standard fields (i.e. fields that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces collection to define and list namespaces.

Throws:
IPWorksSSLException

writeFile

public void writeFile(java.lang.String filename)
               throws IPWorksSSLException
Write an Atom feed from the bean.

This method will write an Atom feed from the existing property values to Filename . The Atom feed will be pre-verified and if any missing required fields are encountered, the bean throws an exception.

Example (Add an Item and Write) 

 AtomControl.Entries.Add(New AtomEntry())
 AtomControl.Entries[0].Content = "New Item Description"
 AtomControl.Entries[0].LinkHref = "http://itemurl"
 AtomControl.WriteFile(filename)

Throws:
IPWorksSSLException

addAtomsEventListener

public void addAtomsEventListener(AtomsEventListener l)
                           throws java.util.TooManyListenersException
Throws:
java.util.TooManyListenersException

removeAtomsEventListener

public void removeAtomsEventListener(AtomsEventListener l)
Package   Class  Tree  Deprecated  Index  Help 
IP*Works! SSL V9
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright (c) 2015 /n software inc. - All rights reserved.