|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Atom
public class Atom
The Atom Bean is used to retrieve, parse, and update Atom content.
The Atom Bean implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).
The bean contains a number of properties that map directly to Atom fields.
To receive a feed, call the 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 Bean supports all standard Atom properties
and allows you to add your own through AddNamespace
or Namespaces
collection and the GetProperty
and SetProperty
methods.
Field Summary | |
---|---|
static int |
authBasic
|
static int |
authDigest
|
static int |
authNegotiate
|
static int |
authNone
|
static int |
authNtlm
|
static int |
authOAuth
|
static int |
authProprietary
|
static int |
frAlways
|
static int |
frNever
|
static int |
frSameScheme
|
Constructor Summary | |
---|---|
Atom()
Creates an instance of Atom Bean. |
|
Atom(java.lang.String runtimeLicense)
Creates an instance of Atom Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addAtomEventListener(AtomEventListener l)
|
void |
addCookie(java.lang.String cookieName,
java.lang.String cookieValue)
Adds a cookie and the corresponding value to the outgoing request headers. |
void |
addNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Adds a namespace to the Namespaces collection
. |
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
deleteResource(java.lang.String URL)
Deletes the resource at the specified URL. |
void |
doEvents()
Processes events from the internal message queue. |
java.lang.String |
getAccept()
A list of acceptable MIME types for the request. |
byte[] |
getAtomData()
The complete content of the Atom resource. |
java.lang.String |
getAuthorization()
The Authorization string to be sent to the server. |
int |
getAuthScheme()
The authentication scheme to use when server authorization is required. |
AtomChannel |
getChannel()
The feed elements of a feed. |
java.lang.String |
getContentType()
Content type for posts and puts. |
HTTPCookieList |
getCookies()
Collection of cookies. |
AtomEntryList |
getEntries()
A collection of entries in the current Atom feed. |
void |
getFeed(java.lang.String URL)
Fetches an Atom feed. |
Firewall |
getFirewall()
A set of properties related to firewall access. |
int |
getFollowRedirects()
Determines what happens when the server issues a redirect. |
java.lang.String |
getIfModifiedSince()
A date determining the maximum age of the desired document. |
java.lang.String |
getLocalFile()
The path to a local file for downloading. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
XMLNamespaceList |
getNamespaces()
A collection of namespaces in the current namespace stack. |
java.lang.String |
getOtherHeaders()
Other headers as determined by the user (optional). |
HeaderList |
getParsedHeaders()
Collection of headers returned from the last request. |
java.lang.String |
getPassword()
A password if authentication is to be used. |
java.lang.String |
getProperty(java.lang.String propertyName)
Fetches the value of a specific Atom feed element or attribute. |
Proxy |
getProxy()
A set of properties related to proxy access. |
java.lang.String |
getReferer()
Referer URL/document (optional). |
void |
getResource(java.lang.String URL)
Fetches a resource. |
java.lang.String |
getSlug()
A header added to the HTTP request. |
int |
getTimeout()
A timeout for the bean. |
byte[] |
getTransferredData()
The contents of the last response from the server. |
long |
getTransferredDataLimit()
The maximum of bytes of data to be transferred. |
java.lang.String |
getTransferredHeaders()
The full set of headers as received from the server. |
AtomEntry |
getUpdateEntry()
An Atom entry to be updated, deleted or created. |
java.lang.String |
getUpdateFile()
A resource to be updated, deleted or created. |
java.lang.String |
getUser()
A user name if authentication is to be used. |
void |
interrupt()
Interrupt the current method. |
boolean |
isConnected()
Shows whether the bean is connected. |
boolean |
isIdle()
The current status of the component. |
void |
postResource(java.lang.String URL)
Posts a resource to the specified URL. |
void |
put(java.lang.String URL)
Sends data to the HTTP server using the HTTP PUT method. |
void |
putResource(java.lang.String URL)
Puts a resource to the specified URL. |
void |
readFile(java.lang.String fileName)
Load an Atom file into the bean. |
void |
removeAtomEventListener(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 |
setAtomData(byte[] atomData)
The complete content of the Atom resource. |
void |
setAuthorization(java.lang.String authorization)
The Authorization string to be sent to the server. |
void |
setAuthScheme(int authScheme)
The authentication scheme to use when server authorization is required. |
void |
setChannel(AtomChannel channel)
The feed elements of a feed. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
void |
setContentType(java.lang.String contentType)
Content type for posts and puts. |
void |
setFirewall(Firewall firewall)
A set of properties related to firewall access. |
void |
setFollowRedirects(int followRedirects)
Determines what happens when the server issues a redirect. |
void |
setIfModifiedSince(java.lang.String ifModifiedSince)
A date determining the maximum age of the desired document. |
void |
setLocalFile(java.lang.String localFile)
The path to a local file for downloading. |
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setOtherHeaders(java.lang.String otherHeaders)
Other headers as determined by the user (optional). |
void |
setPassword(java.lang.String password)
A password if authentication is to be used. |
void |
setProperty(java.lang.String propertyName,
java.lang.String propertyValue)
Sets the value of a specific Atom feed property. |
void |
setProxy(Proxy proxy)
A set of properties related to proxy access. |
void |
setReferer(java.lang.String referer)
Referer URL/document (optional). |
void |
setSlug(java.lang.String slug)
A header added to the HTTP request. |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
setTransferredDataLimit(long transferredDataLimit)
The maximum of bytes of data to be transferred. |
void |
setUpdateEntry(AtomEntry updateEntry)
An Atom entry to be updated, deleted or created. |
void |
setUpdateFile(java.lang.String updateFile)
A resource to be updated, deleted or created. |
void |
setUser(java.lang.String user)
A user name if authentication is to be used. |
void |
writeFile(java.lang.String filename)
Write an Atom feed from the bean. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int authBasic
public static final int authDigest
public static final int authProprietary
public static final int authNone
public static final int authNtlm
public static final int authNegotiate
public static final int authOAuth
public static final int frNever
public static final int frAlways
public static final int frSameScheme
Constructor Detail |
---|
public Atom()
public Atom(java.lang.String runtimeLicense)
Method Detail |
---|
public java.lang.String getAccept()
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
public void setAccept(java.lang.String accept) throws IPWorksException
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
IPWorksException
public byte[] getAtomData()
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.
public void setAtomData(byte[] atomData) throws IPWorksException
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.
IPWorksException
public java.lang.String getAuthorization()
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
public void setAuthorization(java.lang.String authorization) throws IPWorksException
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
IPWorksException
public int getAuthScheme()
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User
and Password
properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
public void setAuthScheme(int authScheme) throws IPWorksException
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User
and Password
properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
IPWorksException
public AtomChannel getChannel()
This property contains the "feed" elements of an
ATOM feed. The Channel
property has fields which contain values for sub-elements of the "feed" element.
public void setChannel(AtomChannel channel) throws IPWorksException
This property contains the "feed" elements of an
ATOM feed. The Channel
property has fields which contain values for sub-elements of the "feed" element.
IPWorksException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksException
public java.lang.String getContentType()
If this property contains a non-empty string, a Content-Type HTTP request header is added to the
request. The purpose of the header is to show the contents
of the data during a PostResource
or PutResource
to the server.
public void setContentType(java.lang.String contentType) throws IPWorksException
If this property contains a non-empty string, a Content-Type HTTP request header is added to the
request. The purpose of the header is to show the contents
of the data during a PostResource
or PutResource
to the server.
IPWorksException
public HTTPCookieList getCookies()
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type httpcookie
) to this collection.
To see cookies that are set by the server, use the SetCookie
event, which displays the cookies and their properties as set by the server.
Those cookies are also added to Cookies
.
MaxHTTPCookies
can be used to control the maximum number of cookies saved.
This collection is indexed from 0 to size - 1.
public AtomEntryList getEntries()
This property is a collection of entries in the current
Atom feed. When an Atom feed is parsed by the
component, all of the items in the feed are stored
as AtomEntry
types in this collection.
To create a new Atom feed, this collection can also be populated before writing with WriteFile
or PutResource
.
This collection is indexed from 0 to size - 1.
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksException
public int getFollowRedirects()
This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds
with an "Object Moved" message. If this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server and port are different than
the existing one, User
and Password
are also reset to empty,
unless this property is set to frAlways (1), in which case
the same credentials are used to connect to the new server.
A Redirect
event is fired for every URL the product is redirected
to. In the case of automatic redirections, the Redirect
event is
a good place to set properties related to the new connection (e.g. new
authentication parameters).
The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.
public void setFollowRedirects(int followRedirects) throws IPWorksException
This property determines what happens when the server issues a redirect. Normally, the bean returns an error if the server responds
with an "Object Moved" message. If this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server and port are different than
the existing one, User
and Password
are also reset to empty,
unless this property is set to frAlways (1), in which case
the same credentials are used to connect to the new server.
A Redirect
event is fired for every URL the product is redirected
to. In the case of automatic redirections, the Redirect
event is
a good place to set properties related to the new connection (e.g. new
authentication parameters).
The default value is frNever (0). In this case, redirects are never followed, and the bean throws an exception instead.
IPWorksException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public java.lang.String getIfModifiedSince()
If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception
The format of the date value for IfModifiedSince
is detailed
in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.
public void setIfModifiedSince(java.lang.String ifModifiedSince) throws IPWorksException
If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception
The format of the date value for IfModifiedSince
is detailed
in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.
IPWorksException
public java.lang.String getLocalFile()
This property is used when getting a document.
If this property is empty then the received data is provided through TransferredData
and the Transfer
event.
public void setLocalFile(java.lang.String localFile) throws IPWorksException
This property is used when getting a document.
If this property is empty then the received data is provided through TransferredData
and the Transfer
event.
IPWorksException
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public XMLNamespaceList getNamespaces()
This property contains a list of the XML namespaces that exist in the current Atom channel. The general Atom protocol allows non-standard fields to be added through XML namespaces.
When parsing an Atom feed retrieved through the GetFeed
method,
the bean will store all properties that are standard in
version 2.0 of the Atom protocol, regardless of the version given
by the feed. For non-standard properties, it will verify that the
property has a namespace and that the namespace is defined
within the Atom feed. If a property's definition cannot be found,
the bean throws an exception. Non-standard fields can be
retrieved through the GetProperty
method.
When using the WriteFile
method to generate an Atom feed that
contains non-standard properties you must use the SetProperty
method.
Please see the GetProperty
and SetProperty
methods for
details on argument syntax.
If the Atom URL is not found in the namespace collection, it will be added as the default namespace when generating a feed. That namespace is "http://www.w3.org/2005/Atom".
This collection is indexed from 0 to size - 1.
public java.lang.String getOtherHeaders()
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
IPWorksException
public HeaderList getParsedHeaders()
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.
public java.lang.String getPassword()
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
config 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 bean will attempt to authenticate using the current user's credentials.
public void setPassword(java.lang.String password) throws IPWorksException
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
config 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 bean will attempt to authenticate using the current user's credentials.
IPWorksException
public Proxy getProxy()
This property contains fields describing the proxy through which the bean will attempt to connect.
public void setProxy(Proxy proxy) throws IPWorksException
This property contains fields describing the proxy through which the bean will attempt to connect.
IPWorksException
public java.lang.String getReferer()
If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
public void setReferer(java.lang.String referer) throws IPWorksException
If this property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
IPWorksException
public java.lang.String getSlug()
This property requests that the server use the header's value as part of any URLs that it would normally generate when creating the Entry or Media resources. Some servers ignore this header.
public void setSlug(java.lang.String slug) throws IPWorksException
This property requests that the server use the header's value as part of any URLs that it would normally generate when creating the Entry or Media resources. Some servers ignore this header.
IPWorksException
public int getTimeout()
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksException
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksException
public byte[] getTransferredData()
This property contains the contents of the last response from the server. If the LocalFile
is empty, the data is accumulated in TransferredData , and can also be received in the Transfer
event. Otherwise, this property returns an empty string.
TransferredDataLimit
controls the maximum amount of data accumulated in TransferredData
(by default there is no limit).
public long getTransferredDataLimit()
This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.
public void setTransferredDataLimit(long transferredDataLimit) throws IPWorksException
This property defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the bean will accumulate and parse. If this value is set to a number n which is greater than 0, the bean will only receive the first n bytes of data from the server.
IPWorksException
public java.lang.String getTransferredHeaders()
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.
public AtomEntry getUpdateEntry()
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.
public void setUpdateEntry(AtomEntry updateEntry) throws IPWorksException
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.
IPWorksException
public java.lang.String getUpdateFile()
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.
public void setUpdateFile(java.lang.String updateFile) throws IPWorksException
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.
IPWorksException
public java.lang.String getUser()
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 bean will attempt to authenticate using the current user's credentials.
public void setUser(java.lang.String user) throws IPWorksException
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 bean will attempt to authenticate using the current user's credentials.
IPWorksException
public void addCookie(java.lang.String cookieName, java.lang.String cookieValue) throws IPWorksException
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.
IPWorksException
public void addNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws IPWorksException
Namespaces
collection
.
This method is used to add a namespace to the Namespaces
collection
. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for 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.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
Entries
collection
is to be populated
when a feed is being parsed by the bean. This value
represents the number of entries that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
AllowHTTPCompression
is true, the bean adds an "Accept-Encoding: " header to the request
being sent to the server. By default, this header's value is "gzip, deflate". This config allows you
to change the value of the "Accept-Encoding" header.
NOTE: The bean only supports gzip and deflate decompression algorithms.AllowHTTPCompression
property. This setting is exposed here
for use by beans that inherit from HTTP.Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.This property is provided so that the HTTP bean can be
extended with other security schemes in addition to the
authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
Transfer
event, by BytesTransferred .IfModifiedSince
property. This setting is exposed here for use by beans that inherit from HTTP.OtherHeaders
to 'Connection: Keep-Alive'.
If false, the connection will be closed immediately after the server response is received.The default value for KeepAlive
is false.
TransferredHeaders
collection is to be populated
when a Header
event has been fired. This value
represents the number of headers that are to be saved in the collection.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
Cookies
collection
as a result of an HTTP request. This value represents the number of
cookies that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
FollowRedirects
is set to any value besides frNever the bean will follow redirects until
this maximum number of redirect attempts are made. The default value is 20.
\011Authorization
config, but for proxy authorization. If this
config contains a non-empty string, a Proxy-Authorization HTTP request header is added
to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified
by AuthScheme .TransferredData
buffer.If TransferredDataLimit
is set to 0, no limits are imposed.
UseChunkedEncoding
is true. This setting specifies the
chunk size in bytes to be used when posting data. The default value is 16384.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
setting is set to the corresponding address. If the search is not successful,
an error is returned.
NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
RemotePort
is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The
binding (address and port) is provided through the ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings
are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set automatically when FirewallType
is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.
TCPKeepAlive
will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.
LingerTime
is 0 (default), the
system will attempt to send pending data for a connection until the default
IP protocol timeout expires.
In the second scenario, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
is reached.
If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
IPWorksException
public void deleteResource(java.lang.String URL) throws IPWorksException
The bean will delete a resource at the specified URL.
IPWorksException
public void doEvents() throws IPWorksException
When DoEvents
is called, the bean processes any
available events. If no events are available, it waits for a
preset period of time, and then returns.
IPWorksException
public void getFeed(java.lang.String URL) throws IPWorksException
This method fetches the document. The document contents are delivered in the AtomData
property, as well as through the Transfer
event, and the HTTP response headers through the Header
event.
The bean will then attempt to parse the Atom feed,
filling in the Channel
and Entries
properties as it goes. The Channel
properties can also be accessed using the GetProperty
and SetProperty
methods if necessary.
IPWorksException
public java.lang.String getProperty(java.lang.String propertyName) throws IPWorksException
This method is intended for extending functionality of the Atom bean. It will fetch the value for a specific entry element or attribute of this Atom feed. Property is the XPath of the element or attribute according to the following convention: /feed/element@attribute or entry[x]/element@attribute . The @attribute part is optional.
entry[x] is the Channel
's xth entry (or any other root level child), where the indexer x starts at 1.
element is any child of the Channel
or an
entry, and attribute can be any attribute of that field.
If an attribute is not supplied, the GetProperty
method
will return the text portion of element . For example:
AtomControl.GetProperty("entry[5]/link@href")
AtomControl.GetProperty("entry[5]/author/name")
AtomControl.GetProperty("/feed/title")
Note : in order to add non-standard fields (i.e. fields
that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The
same applies for the attribute field. Use the Namespaces
collection
to define and list namespaces.
IPWorksException
public void getResource(java.lang.String URL) throws IPWorksException
This method fetches the resource. If LocalFile
is set, the document will be saved in the file specified. Otherwise, the document contents are delivered in the AtomData
property, as well as through the Transfer
event, and the HTTP response headers through the Header
event.
Unlike the GetFeed
method, after retrieval, the bean will not attempt to parse the data into the Channel
and Entries
properties.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void postResource(java.lang.String URL) throws IPWorksException
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
.
IPWorksException
public void put(java.lang.String URL) throws IPWorksException
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
.
IPWorksException
public void putResource(java.lang.String URL) throws IPWorksException
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
.
IPWorksException
public void readFile(java.lang.String fileName) throws IPWorksException
This method loads an Atom file and attempts to parse it,
filling in the Channel
and Entries
properties as it goes.
The Channel
properties can also be accessed using the GetProperty
and SetProperty
methods if necessary.
IPWorksException
public void reset() throws IPWorksException
This method resets all properties to the bean's default settings. This is an easy way to clear all of the property values before repopulating the Atom feed.
IPWorksException
public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws IPWorksException
This method is intended for extending functionality of the Atom bean. It will set the value for a specific field of this Atom feed. Property is the name of the property according to the following convention: root/element@attribute . The root field can be either of the two following values:
The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element . For example:
AtomControl.SetProperty("entry[5]/link@type", "text/html")
Note : in order to add non-standard fields (i.e. fields
that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The
same applies for the attribute field. Use the Namespaces
collection
to define and list namespaces.
IPWorksException
public void writeFile(java.lang.String filename) throws IPWorksException
This method will write an Atom feed from the existing property values to Filename . The Atom feed will be pre-verified and if any missing required fields are encountered, the bean throws an exception.
Example (Add an Item and Write)
AtomControl.Entries.Add(New AtomEntry())
AtomControl.Entries[0].Content = "New Item Description"
AtomControl.Entries[0].LinkHref = "http://itemurl"
AtomControl.WriteFile(filename)
IPWorksException
public void addAtomEventListener(AtomEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeAtomEventListener(AtomEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |