Atom Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks.Atom

Remarks

The Atom component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The Atom Component 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 component contains a number of properties that map directly to Atom fields. To receive a feed, call the GetFeed method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries collection using the Put method.

The Atom Component supports all standard Atom properties and allows you to add your own through AddNamespace or Namespaces collection and the GetProperty and SetProperty methods.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Accept Property (Atom Component)

This property includes a list of acceptable MIME types for the request.

Syntax

public String getAccept();


public void setAccept(String accept);

Default Value

""

Remarks

If this property contains a nonempty 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.

AtomData Property (Atom Component)

This is the complete content of the Atom resource.

Syntax

public byte[] getAtomData();


public void setAtomData(byte[] atomData);

Default Value

""

Remarks

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.

This property is not available at design time.

Authorization Property (Atom Component)

This property includes the Authorization string to be sent to the server.

Syntax

public String getAuthorization();


public void setAuthorization(String authorization);

Default Value

""

Remarks

If the Authorization property contains a nonempty 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 component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

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

AuthScheme Property (Atom Component)

The authentication scheme to use when server authentication is required.

Syntax

public int getAuthScheme();


public void setAuthScheme(int authScheme);

Enumerated values:
  public final static int authBasic = 0;

  public final static int authDigest = 1;

  public final static int authProprietary = 2;

  public final static int authNone = 3;

  public final static int authNtlm = 4;

  public final static int authNegotiate = 5;

  public final static int authOAuth = 6;

Default Value

0

Remarks

This property will tell the component 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 component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of User, Password, and Authorization.

Channel Property (Atom Component)

This includes the feed elements of a feed.

Syntax

public AtomChannel getChannel();


public void setChannel(AtomChannel channel);

Remarks

This property contains the "feed" elements of an ATOM feed. The Channel property has fields that contain values for subelements of the "feed" element.

Connected Property (Atom Component)

This shows whether the component is connected.

Syntax

public boolean isConnected();


public void setConnected(boolean connected);

Default Value

False

Remarks

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

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

ContentType Property (Atom Component)

This is the content type for posts and puts.

Syntax

public String getContentType();


public void setContentType(String contentType);

Default Value

"application/atom+xml"

Remarks

If this property contains a nonempty 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.

This property is not available at design time.

Cookies Property (Atom Component)

This property includes a collection of cookies.

Syntax

public HTTPCookieList getCookies();


public void setCookies(HTTPCookieList cookies);

Remarks

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 also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size -1.

This property is not available at design time.

Entries Property (Atom Component)

This includes a collection of entries in the current Atom feed.

Syntax

public AtomEntryList getEntries();


public void setEntries(AtomEntryList entries);

Remarks

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 also can be populated before writing with WriteFile or PutResource.

This collection is indexed from 0 to size -1.

Firewall Property (Atom Component)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

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

FollowRedirects Property (Atom Component)

This property determines what happens when the server issues a redirect.

Syntax

public int getFollowRedirects();


public void setFollowRedirects(int followRedirects);

Enumerated values:
  public final static int frNever = 0;

  public final static int frAlways = 1;

  public final static int frSameScheme = 2;

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the component 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 component throws an exception.

Note: 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 potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), 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 component throws an exception instead.

Idle Property (Atom Component)

The current status of the component.

Syntax

public boolean isIdle();

Default Value

True

Remarks

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

This property is read-only.

IfModifiedSince Property (Atom Component)

This property includes a date determining the maximum age of the desired document.

Syntax

public String getIfModifiedSince();


public void setIfModifiedSince(String ifModifiedSince);

Default Value

""

Remarks

If this property contains a nonempty 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 component 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.

This property is not available at design time.

LocalFile Property (Atom Component)

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

public String getLocalFile();


public void setLocalFile(String localFile);

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

LocalHost Property (Atom Component)

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

Syntax

public String getLocalHost();


public void setLocalHost(String localHost);

Default Value

""

Remarks

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 component initiate connections (or accept in the case of server components) only through that interface.

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

Namespaces Property (Atom Component)

This is a collection of Namespaces in the current Namespace stack.

Syntax

public XMLNamespaceList getNamespaces();


public void setNamespaces(XMLNamespaceList namespaces);

Remarks

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

When parsing an Atom feed retrieved through the GetFeed method, the component will store all properties that are standard in version 2.0 of the Atom protocol, regardless of the version given by the feed. For nonstandard 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 component throws an exception. Nonstandard fields can be retrieved through the GetProperty method.

When using the WriteFile method to generate an Atom feed that contains nonstandard 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.

This property is not available at design time.

OtherHeaders Property (Atom Component)

This property includes other headers as determined by the user (optional).

Syntax

public String getOtherHeaders();


public void setOtherHeaders(String otherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow 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 component beyond what is provided.

This property is not available at design time.

ParsedHeaders Property (Atom Component)

This property includes a collection of headers returned from the last request.

Syntax

public HeaderList getParsedHeaders();

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size -1.

This property is read-only and not available at design time.

Password Property (Atom Component)

This property includes a password if authentication is to be used.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

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

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Proxy Property (Atom Component)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

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

Referer Property (Atom Component)

This property includes the referer URL/document (optional).

Syntax

public String getReferer();


public void setReferer(String referer);

Default Value

""

Remarks

If this property contains a nonempty 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.

This property is not available at design time.

Slug Property (Atom Component)

A header added to the HTTP request.

Syntax

public String getSlug();


public void setSlug(String slug);

Default Value

""

Remarks

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

SSLAcceptServerCert Property (Atom Component)

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

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

SSLCert Property (Atom Component)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the component 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.

SSLProvider Property (Atom Component)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;

  public final static int sslpPlatform = 1;

  public final static int sslpInternal = 2;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (Atom Component)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (Atom Component)

A timeout for the component.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

Default Value

60

Remarks

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 component will wait for the operation to complete before returning control.

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

The default value for the Timeout property is 60 seconds.

TransferredData Property (Atom Component)

This property includes the contents of the last response from the server.

Syntax

public byte[] getTransferredData();

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can 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).

This property is read-only and not available at design time.

TransferredDataLimit Property (Atom Component)

This property includes the maximum number of bytes of data to be transferred.

Syntax

public long getTransferredDataLimit();


public void setTransferredDataLimit(long transferredDataLimit);

Default Value

0

Remarks

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

TransferredHeaders Property (Atom Component)

This property includes the full set of headers as received from the server.

Syntax

public String getTransferredHeaders();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

UpdateEntry Property (Atom Component)

This is an Atom entry to be updated, deleted, or created.

Syntax

public AtomEntry getUpdateEntry();


public void setUpdateEntry(AtomEntry updateEntry);

Remarks

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.

UpdateFile Property (Atom Component)

This is a resource to be updated, deleted, or created.

Syntax

public String getUpdateFile();


public void setUpdateFile(String updateFile);

Default Value

""

Remarks

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.

User Property (Atom Component)

This property includes a user name if authentication is to be used.

Syntax

public String getUser();


public void setUser(String user);

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

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

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

AddCookie Method (Atom Component)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

public void addCookie(String cookieName, String cookieValue);

Remarks

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.

AddNamespace Method (Atom Component)

This method adds a namespace to the Namespaces properties.

Syntax

public void addNamespace(String prefix, String namespaceURI);

Remarks

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

Config Method (Atom Component)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DeleteResource Method (Atom Component)

This method deletes the resource at the specified URL.

Syntax

public void deleteResource(String URL);

Remarks

The component will delete a resource at the specified URL.

DoEvents Method (Atom Component)

Processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

GetFeed Method (Atom Component)

This method fetches an Atom feed.

Syntax

public void getFeed(String URL);

Remarks

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.

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

GetProperty Method (Atom Component)

This method fetches the value of a specific Atom feed element or attribute.

Syntax

public String getProperty(String propertyName);

Remarks

This method is intended for extending functionality of the Atom component. 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: To add nonstandard 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.

GetResource Method (Atom Component)

This method fetches a resource.

Syntax

public void getResource(String URL);

Remarks

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

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

Interrupt Method (Atom Component)

Interrupt the current method.

Syntax

public void interrupt();

Remarks

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

PostResource Method (Atom Component)

This method posts a resource to the specified URL.

Syntax

public void postResource(String URL);

Remarks

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.

Put Method (Atom Component)

This method sends data to the HTTP server using the HTTP PUT method.

Syntax

public void put(String URL);

Remarks

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.

PutResource Method (Atom Component)

This method puts a resource to the specified URL.

Syntax

public void putResource(String URL);

Remarks

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.

ReadFile Method (Atom Component)

This method loads an Atom file into the component.

Syntax

public void readFile(String fileName);

Remarks

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

Reset Method (Atom Component)

This method resets all properties of the component.

Syntax

public void reset();

Remarks

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

SetProperty Method (Atom Component)

This method sets the value of a specific Atom feed property.

Syntax

public void setProperty(String propertyName, String propertyValue);

Remarks

This method is intended for extending functionality of the Atom component. 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:

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: To add nonstandard 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.

WriteFile Method (Atom Component)

This method is used to write an Atom feed from the component.

Syntax

public void writeFile(String filename);

Remarks

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

Connected Event (Atom Component)

This event is fired immediately after a connection completes (or fails).

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void connected(AtomConnectedEvent e) {}
  ...
}

public class AtomConnectedEvent {
  public int statusCode;

  public String description;

}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Atom Component)

This event is fired to indicate changes in the connection state.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void connectionStatus(AtomConnectionStatusEvent e) {}
  ...
}

public class AtomConnectionStatusEvent {
  public String connectionEvent;

  public int statusCode;

  public String description;

}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (Atom Component)

This event is fired when a connection is closed.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void disconnected(AtomDisconnectedEvent e) {}
  ...
}

public class AtomDisconnectedEvent {
  public int statusCode;

  public String description;

}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (Atom Component)

This event fires when a document finishes transferring.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void endTransfer(AtomEndTransferEvent e) {}
  ...
}

public class AtomEndTransferEvent {
  public int direction;

}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (Atom Component)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void error(AtomErrorEvent e) {}
  ...
}

public class AtomErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (Atom Component)

This event is fired every time a header line comes in.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void header(AtomHeaderEvent e) {}
  ...
}

public class AtomHeaderEvent {
  public String field;

  public String value;

}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (Atom Component)

This event fires once for each log message.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void log(AtomLogEvent e) {}
  ...
}

public class AtomLogEvent {
  public int logLevel;

  public String message;

  public String logType;

}

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (Atom Component)

This event is fired when a redirection is received from the server.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void redirect(AtomRedirectEvent e) {}
  ...
}

public class AtomRedirectEvent {
  public String location;

  public boolean accept;

}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Atom Component)

This event is fired for every cookie set by the server.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void setCookie(AtomSetCookieEvent e) {}
  ...
}

public class AtomSetCookieEvent {
  public String name;

  public String value;

  public String expires;

  public String domain;

  public String path;

  public boolean secure;

}

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (Atom Component)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void SSLServerAuthentication(AtomSSLServerAuthenticationEvent e) {}
  ...
}

public class AtomSSLServerAuthenticationEvent {
  public byte[] certEncoded;

  public String certSubject;

  public String certIssuer;

  public String status;

  public boolean accept;

}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Atom Component)

Fired when secure connection progress messages are available.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void SSLStatus(AtomSSLStatusEvent e) {}
  ...
}

public class AtomSSLStatusEvent {
  public String message;

}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (Atom Component)

This event fires when a document starts transferring (after the headers).

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void startTransfer(AtomStartTransferEvent e) {}
  ...
}

public class AtomStartTransferEvent {
  public int direction;

}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (Atom Component)

This event is fired when the HTTP status line is received from the server.

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void status(AtomStatusEvent e) {}
  ...
}

public class AtomStatusEvent {
  public String HTTPVersion;

  public int statusCode;

  public String description;

}

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (Atom Component)

This event is fired while a document transfers (delivers document).

Syntax

public class DefaultAtomEventListener implements AtomEventListener {
  ...
  public void transfer(AtomTransferEvent e) {}
  ...
}

public class AtomTransferEvent {
  public int direction;

  public long bytesTransferred;

  public int percentDone;

  public byte[] text;

}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

AtomChannel Type

The information about an Atom feed as it is received from the server.

Remarks

When an Atom feed is parsed by the component, each item is parsed into an AtomEntry type and other information about the feed are presented as AtomChannel.

Fields

Constructors

public AtomChannel();

AtomEntry Type

This is an Atom entry as it is received from the Atom feed.

Remarks

When an Atom feed is parsed by the component, each item is parsed into an AtomEntry type.

Fields

Constructors

public AtomEntry();

public AtomEntry( title);

public AtomEntry( title,  content);

public AtomEntry( title,  content,  linkHref);

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

public Firewall();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

public Header();

public Header( field,  value);

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public HTTPCookie();

public HTTPCookie( name,  value);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is "xmlns", and the Name field contains the default namespace.

Fields

Constructors

public XMLNamespace();

public XMLNamespace( name,  prefix);

Config Settings (Atom Component)

Atom Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (Atom Component)

ATOM Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors