ipworks
Class Atom

java.lang.Object
  |
  +--ipworks.Atom

public class Atom

extends java.lang.Object

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

The Atom bean implements a standard Atom reader 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" draft (http://www.ietf.org/internet-drafts/draft-ietf-atompub-protocol-15.txt).

The bean 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 Atom collections using Get , Put , Post and Delete .

The Atom bean supports all standard Atom properties and allows you to use your own using the Namespaces collection and the GetProperty and SetProperty methods.

Field Summary

static int	authBasic
static int	authDigest
static int	authNone
static int	authNtlm
static int	authProprietary
static int	frAlways
static int	frNever
static int	frSameScheme

Constructor Summary

Atom()

Method Summary

void	addAtomEventListener(ipworks.AtomEventListener l)
void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Sets a cookie and the corresponding value.
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 beanconfiguration setting.
void	deleteResource(java.lang.String URL) Deletes a resource from specified URL.
java.lang.String	getAccept() A list of acceptable MIME types for the request.
byte[]	getAtomData() The complete content of the Atom resource.
int	getAuthScheme() The authorization scheme to be used when server authorization is to be performed.
ipworks.AtomChannel	getChannel() The root level of an atom feed.
java.lang.String	getContentType() Content type for posted data.
HTTPCookieList	getCookies() Collection of cookies.
AtomEntryList	getEntries() A collection of entries in the current Atom feed.
void	getFeed(java.lang.String URL) Fetch an Atom feed.
ipworks.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.
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 retrieval.
java.lang.String	getPassword() A password if authentication is to be used.
java.lang.String	getProperty(java.lang.String propertyName) Get the value of a specific Atom feed element or attribute.
ipworks.Proxy	getProxy() A set of properties related to proxy access.
java.lang.String	getReferer() Referer URL/document (optional).
void	getResource(java.lang.String URL) Fetch an ATOM resource.
java.lang.String	getSlug() A header added to the HTTP request.
int	getTimeout() A timeout for the bean.
byte[]	getTransferredData() The contents of the last transfer.
long	getTransferredDataLimit() The maximum of data to be transferred.
java.lang.String	getTransferredHeaders() The full set of headers as received from the server.
ipworks.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	removeAtomEventListener(ipworks.AtomEventListener 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	setAuthScheme(int authScheme) The authorization scheme to be used when server authorization is to be performed.
void	setChannel(ipworks.AtomChannel channel) The root level of an atom feed.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setContentType(java.lang.String contentType) Content type for posted data.
void	setCookies(HTTPCookieList cookies) Collection of cookies.
void	setEntries(AtomEntryList entries) A collection of entries in the current Atom feed.
void	setFirewall(ipworks.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	setNamespaces(XMLNamespaceList namespaces) A collection of namespaces in the current namespace stack.
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) Set the value of a specific Atom feed property.
void	setProxy(ipworks.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	setTimeout(int timeout) A timeout for the bean.
void	setTransferredDataLimit(long transferredDataLimit) The maximum of data to be transferred.
void	setUpdateEntry(ipworks.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

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

Atom

public Atom()

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

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

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

setAccept

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

A list of acceptable MIME types for the request.

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

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

IPWorksException

getAtomData

public byte[] getAtomData()

The complete content of the Atom resource.

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

getAuthScheme

public int getAuthScheme()

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

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

AuthScheme should be set to authNone (3) when no authentication is expected.

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

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

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

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException

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

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

AuthScheme should be set to authNone (3) when no authentication is expected.

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

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

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

IPWorksException

getChannel

public ipworks.AtomChannel getChannel()

The root level of an atom feed.

This property defines attributes for the root element of an atom feed. The root element is named "feed". The Channel property has fields which contain values for sub-elements of the Channel .

setChannel

public void setChannel(ipworks.AtomChannel channel)
                throws IPWorksException

The root level of an atom feed.

This property defines attributes for the root element of an atom feed. The root element is named "feed". The Channel property has fields which contain values for sub-elements of the Channel .

IPWorksException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

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

setConnected

public void setConnected(boolean connected)
                  throws IPWorksException

Shows whether the bean is connected.

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

IPWorksException

getContentType

public java.lang.String getContentType()

Content type for posted data.

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

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

setContentType

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

Content type for posted data.

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

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

IPWorksException

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

setCookies

public void setCookies(HTTPCookieList cookies)
                throws IPWorksException

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

IPWorksException

getEntries

public AtomEntryList getEntries()

A collection of entries in the current Atom feed.

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

This collection can also be populated before writing an Atom feed with WriteFile .

This collection is indexed from 0 to Count - 1.

setEntries

public void setEntries(AtomEntryList entries)
                throws IPWorksException

A collection of entries in the current Atom feed.

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

This collection can also be populated before writing an Atom feed with WriteFile .

This collection is indexed from 0 to Count - 1.

IPWorksException

getFirewall

public ipworks.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(ipworks.Firewall firewall)
                 throws IPWorksException

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.

IPWorksException

getFollowRedirects

public int getFollowRedirects()

Determines what happens when the server issues a redirect.

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

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

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

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

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

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

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksException

Determines what happens when the server issues a redirect.

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

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

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

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

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

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

IPWorksException

isIdle

public boolean isIdle()

The current status of the component.

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

getIfModifiedSince

public java.lang.String getIfModifiedSince()

A date determining the maximum age of the desired document.

If the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an IPWorksException raises an IPWorksException 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 IPWorksException

A date determining the maximum age of the desired document.

If the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an IPWorksException raises an IPWorksException exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

IPWorksException

getLocalFile

public java.lang.String getLocalFile()

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

The LocalFile property is used when getting a document.

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

setLocalFile

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

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

The LocalFile property is used when getting a document.

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

IPWorksException

getNamespaces

public XMLNamespaceList getNamespaces()

A collection of namespaces in the current namespace stack.

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

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 IPWorksException raises an IPWorksException 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 to set each non-standard property.

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

If the Atom uri 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 Count - 1.

setNamespaces

public void setNamespaces(XMLNamespaceList namespaces)
                   throws IPWorksException

A collection of namespaces in the current namespace stack.

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

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 IPWorksException raises an IPWorksException 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 to set each non-standard property.

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

If the Atom uri 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 Count - 1.

IPWorksException

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

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

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

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

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

setOtherHeaders

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

Other headers as determined by the user (optional).

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

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

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

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

IPWorksException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last retrieval.

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.

MaxHeaderscan be used to control the number of headers saved.

This collection is indexed from 0 to Count - 1.

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in theAuthorizationconfig 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.

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

setPassword

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

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

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

IPWorksException

getProxy

public ipworks.Proxy getProxy()

A set of properties related to proxy access.

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

setProxy

public void setProxy(ipworks.Proxy proxy)
              throws IPWorksException

A set of properties related to proxy access.

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

IPWorksException

getReferer

public java.lang.String getReferer()

Referer URL/document (optional).

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

setReferer

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

Referer URL/document (optional).

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

IPWorksException

getSlug

public java.lang.String getSlug()

A header added to the HTTP request.

The slug header requests that the server use the header's value as part of any URIs 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 IPWorksException

A header added to the HTTP request.

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

IPWorksException

getTimeout

public int getTimeout()

A timeout for the bean.

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

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

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

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

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

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

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

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

setTimeout

public void setTimeout(int timeout)
                throws IPWorksException

A timeout for the bean.

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

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

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

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

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

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

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

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

IPWorksException

getTransferredData

public byte[] getTransferredData()

The contents of the last transfer.

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

TheMaxTransferredDataconfiguration setting controls the amount of data accumulated in TransferredData .

getTransferredDataLimit

public long getTransferredDataLimit()

The maximum 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 IPWorksException

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

IPWorksException

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 ipworks.AtomEntry getUpdateEntry()

An Atom entry to be updated, deleted or created.

The bean allows you to create, update, and delete Atom resources using the Post , Put , Delete methods. These methods work on UpdateEntry or UpdateFile .

setUpdateEntry

public void setUpdateEntry(ipworks.AtomEntry updateEntry)
                    throws IPWorksException

An Atom entry to be updated, deleted or created.

The bean allows you to create, update, and delete Atom resources using the Post , Put , Delete methods. These methods work on UpdateEntry or UpdateFile .

IPWorksException

getUpdateFile

public java.lang.String getUpdateFile()

A resource to be updated, deleted or created.

The bean allows you to create, update, and delete Atom resources using the Post , Put , Delete methods. These methods work on UpdateEntry or UpdateFile .

setUpdateFile

public void setUpdateFile(java.lang.String updateFile)
                   throws IPWorksException

A resource to be updated, deleted or created.

The bean allows you to create, update, and delete Atom resources using the Post , Put , Delete methods. These methods work on UpdateEntry or UpdateFile .

IPWorksException

getUser

public java.lang.String getUser()

A user name if authentication is to be used.

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

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

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

setUser

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

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 theAuthorizationproperty in the form "Basic [encoded-user-password]".

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

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

IPWorksException

addCookie

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

Sets a cookie and the corresponding value.

Please refer to the Cookies property for more information on cookies and how they are managed.

IPWorksException

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.String namespaceURI)
                  throws IPWorksException

Adds a namespace to the Namespaces collection.

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

IPWorksException

config

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

Sets or retrieves a beanconfiguration setting.

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

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

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

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

IPWorksException

deleteResource

public void deleteResource(java.lang.String URL)
                    throws IPWorksException

Deletes a resource from specified URL.

The bean will delete a resource from the specified URL.

IPWorksException

getFeed

public void getFeed(java.lang.String URL)
             throws IPWorksException

Fetch an Atom feed.

Fetch the document using the HTTP GET method. The document contents are delivered in the RSSData 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 Feed and Entry properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

IPWorksException

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
                             throws IPWorksException

Get the value of a specific Atom feed element or attribute.

This method is intended for extending functionality of the Atom bean. It will get 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.

The entry[x] field is defined as the Channel 's xth entry as the root level where the indexer x starts at 1.

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

 RSSControl.GetProperty("entry[5]/link@href")
   RSSControl.GetProperty("entry[5]/author/name")
   RSSControl.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.

IPWorksException

getResource

public void getResource(java.lang.String URL)
                 throws IPWorksException

Fetch an ATOM resource.

Fetch the resource using the HTTP GET method. 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 Feed and Entries properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

IPWorksException

interrupt

public void interrupt()
               throws IPWorksException

Interrupt the current method.

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

IPWorksException

postResource

public void postResource(java.lang.String URL)
                  throws IPWorksException

Posts a resource to the specified URL.

The bean will create a resource at the specified URL. It will either create a media resource if UpdateFile is specified or create an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry .

IPWorksException

put

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

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

Send data to the HTTP server using the HTTP PUT method. The data is taken from PostData and/or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers through the Header event. If LocalFile is not empty the data (not the headers) is written there as well. The user should normally have assigned correct values to User and Password orAuthorization.

IPWorksException

putResource

public void putResource(java.lang.String URL)
                 throws IPWorksException

Puts a resource to the specified URL.

The bean will update a resource at the specified URL. It will either update a media resource if UpdateFile is specified or update an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry .

IPWorksException

readFile

public void readFile(java.lang.String fileName)
              throws IPWorksException

Load an Atom file into the bean.

The ReadFile method loads an Atom file and attempts to parse it, filling in the properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

IPWorksException

reset

public void reset()
           throws IPWorksException

Reset all properties of the bean.

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

IPWorksException

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws IPWorksException

Set 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 any of the four following values:

channel

This treats the channel as the root level, and element is any property of the channel. If the empty string ("") is supplied for the root field, the bean will assume channel as the root.

image

This treats the channel's image as the root level, and element is any property of an image.

textInput

This treats the channel's textInput as the root level, and element is any property of an textInput.

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]/guid@isPermaLink", "true") 

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.

IPWorksException

writeFile

public void writeFile(java.lang.String filename)
               throws IPWorksException

Write an Atom feed from the bean.

The WriteFile method will write an Atom feed from the existing property values to Filename . The Atom feed will be pre- verified and any missing required fields will result in an error.

Example (Add an Item and Write)

 //set Atom feed properties or read in an existing file
 ...
 //Add new item
 AtomControl.AddEntry("New Item Title")
 AtomControl.Entries[1].Description = "New Item Description"
 AtomControl.Entries[1].Href = "http://itemurl"
 //write out complete RSS feed to file
 AtomControl.WriteFile(filename) 

IPWorksException

addAtomEventListener

public void addAtomEventListener(ipworks.AtomEventListener l)
                          throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeAtomEventListener

public void removeAtomEventListener(ipworks.AtomEventListener l)