|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Rss
public class Rss
The RSS Bean is used to retrieve, parse, and write RSS syndicated content.
The RSS Bean implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.
The bean contains a number of properties that map directly to RSS fields.
To receive a feed call the GetFeed
method with the URL or file to retrieve
specified in the URL parameter. The RSS bean can also generate
RSS feeds, which can be retrieved through the RSSData
property or written
through the WriteFile
method.
The RSS Bean supports all RSS feed properties
that are standard in versions 0.91, 0.92 and 2.0 of the RSS protocol through a
number of bean properties. It also supports non-standard properties as
specified in the RSS protocol through the 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
|
static int |
rssVersion091
|
static int |
rssVersion092
|
static int |
rssVersion200
|
static int |
rssVersionUndefined
|
Constructor Summary | |
---|---|
Rss()
Creates an instance of Rss Bean. |
|
Rss(java.lang.String runtimeLicense)
Creates an instance of Rss Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addCookie(java.lang.String cookieName,
java.lang.String cookieValue)
Adds a cookie and the corresponding value to the outgoing request headers. |
void |
addItem(java.lang.String title,
java.lang.String description,
java.lang.String link)
Inserts a new item into the beginning of an RSS feed. |
void |
addNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Adds a namespace to the Namespaces collection
. |
void |
addRssEventListener(RssEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
doEvents()
Processes events from the internal message queue. |
java.lang.String |
getAccept()
A list of acceptable MIME types for the request. |
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. |
RSSChannel |
getChannel()
The channel data for the feed. |
HTTPCookieList |
getCookies()
Collection of cookies. |
void |
getFeed(java.lang.String URL)
Fetches an RSS 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. |
RSSItemList |
getItems()
A collection of items in the current RSS feed. |
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)
Gets the value of a specific RSS feed item element or attribute. |
Proxy |
getProxy()
A set of properties related to proxy access. |
java.lang.String |
getReferer()
Referer URL/document (optional). |
java.lang.String |
getRSSData()
The complete text of the RSS XML file. |
int |
getRSSVersion()
The RSS protocol version of the current RSS feed. |
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. |
void |
getURL(java.lang.String URL)
Fetches an RSS feed. |
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. |
java.lang.String |
OPMLAttr(java.lang.String attrName)
Returns the value of the attribute specified in the parameter. |
void |
put(java.lang.String URL)
Sends data to the HTTP server using the HTTP PUT method. |
void |
readFile(java.lang.String fileName)
Loads an RSS file into the bean. |
void |
readOPML(java.lang.String OPMLFile)
Reads and parses an OPML file. |
void |
removeRssEventListener(RssEventListener l)
|
void |
reset()
Resets all properties of the bean. |
void |
setAccept(java.lang.String accept)
A list of acceptable MIME types for the request. |
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(RSSChannel channel)
The channel data for the feed. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
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 RSS 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 |
setRSSData(java.lang.String RSSData)
The complete text of the RSS XML file. |
void |
setRSSVersion(int RSSVersion)
The RSS protocol version of the current RSS feed. |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
setTransferredDataLimit(long transferredDataLimit)
The maximum of bytes of data to be transferred. |
void |
setUser(java.lang.String user)
A user name if authentication is to be used. |
void |
writeFile(java.lang.String filename)
Writes an RSS 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
public static final int rssVersionUndefined
public static final int rssVersion091
public static final int rssVersion092
public static final int rssVersion200
Constructor Detail |
---|
public Rss()
public Rss(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 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 RSSChannel getChannel()
This property contains fields which contain values for sub-elements of the RSS Channel
.
public void setChannel(RSSChannel channel) throws IPWorksException
This property contains fields which contain values for sub-elements of the RSS Channel
.
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 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 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 RSSItemList getItems()
This property contains a collection of items in the current
RSS channel. When an RSS feed is parsed by the
component, all of the items in the feed are stored
as rssitem
types in this collection.
This collection can also be populated before writing an RSS feed with WriteFile
.
This collection is indexed from 0 to size - 1.
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 RSS channel. Each version of the RSS protocol defines a specific set of standard RSS feed properties. However, the general RSS protocol allows non-standard fields to be added through XML namespaces.
When parsing an RSS feeds retrieved through the GetFeed
method, the bean will store all properties that are standard in version 2.0 of the RSS 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 RSS 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 RSS feed that contains non-standard properties you must use the SetProperty
method to set each non-standard property. The bean will ignore any property whose namespace is not defined when generating the RSSData
.
Please see the GetProperty
and SetProperty
methods for details on argument syntax.
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 getRSSData()
When retrieving RSS feeds through the GetFeed
or HTML through the GetURL
method, this property will
contain the complete original text of the feed. When writing an
RSS feed using the WriteFile
method, the bean RSSData
will be generated from the existing properties.
public void setRSSData(java.lang.String RSSData) throws IPWorksException
When retrieving RSS feeds through the GetFeed
or HTML through the GetURL
method, this property will
contain the complete original text of the feed. When writing an
RSS feed using the WriteFile
method, the bean RSSData
will be generated from the existing properties.
IPWorksException
public int getRSSVersion()
This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the bean will check this value and throw an error for missing required properties.
The following are the values currently recognized by the bean:
In order to set properties not defined in the given version, use the Namespaces
collection
to list and define namespaces and the GetProperty
and SetProperty
methods to list and define each non-standard property.
public void setRSSVersion(int RSSVersion) throws IPWorksException
This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the bean will check this value and throw an error for missing required properties.
The following are the values currently recognized by the bean:
In order to set properties not defined in the given version, use the Namespaces
collection
to list and define namespaces and the GetProperty
and SetProperty
methods to list and define each non-standard property.
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 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 addItem(java.lang.String title, java.lang.String description, java.lang.String link) throws IPWorksException
This method assumes that the items are new and more important than existing items and thus adds the item to the beginning of the current item list. This method requires the three standard fields Title , Description , and Link to be specified.
Example (Add a New Item)
RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com")
RSSControl.WriteFile(filename)
Example (Add a New Item using the Items Collection) RSSControl.Items.Add(New RSSItem("New Item Title", "Item Description"))
RSSControl.Items[0].Link = "http://www.itemsource.com"
RSSControl.WriteFile(filename)
IPWorksException
public void addNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws IPWorksException
Namespaces
collection
.
This method adds 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.
Items
collection
will be populated
when a feed is being parsed by the bean. This value
represents the number of items 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.
Items
.Count - 1.
Note: This config is write-only and no validation is performed on the specified data.
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 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 documents 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. If the LocalFile
property
has been set, the bean will write the transferred data
there.
The bean will then attempt to parse the RSS feed,
filling in the Channel and Item properties as it goes. The feed properties can be
accessed either directly through the named properties, or through
the GetProperty
and SetProperty
methods.
IPWorksException
public java.lang.String getProperty(java.lang.String propertyName) throws IPWorksException
This method is intended for extending functionality of the RSS bean. It will get the value for a specific item element or attribute of this RSS feed. Property is the XPath of the element or attribute according to the following convention: root/element@attribute . The @attribute part is optional, and the root field can be any of the four 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, this method will return the text portion of element . For example:
RSSControl.GetProperty("item[5]/guid@isPermaLink")
RSSControl.GetProperty("item[5]/link")
RSSControl.GetProperty("/channel/title")
Note : in order to add non-standard fields (i.e. fields
that are not defined in the RSS 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 getURL(java.lang.String URL) throws IPWorksException
This method fetches 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. If the LocalFile
property
has been set, the bean will write the transferred data
there.
The bean will not parse the data returned by the server. For more control over the retrieval of the item link, please use the HTTP bean.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public java.lang.String OPMLAttr(java.lang.String attrName) throws IPWorksException
This method may be used to get the value of
an attribute for an outline entry of an OPML document.
The attribute desired must be specified in the
parameter of this method. Also, this method
must be invoked inside the OPMLOutline
event.
IPWorksException
public void put(java.lang.String URL) throws IPWorksException
This method sends data to the HTTP server. The data is taken from PostData
and/or AttachedFile
properties. The server response text is received through the Transfer
event, and the HTTP response headers through the Header
event.
If LocalFile
is not empty the data (not the headers) is written there as well.
The user should normally have assigned correct
values to User
and Password
or Authorization
.
IPWorksException
public void readFile(java.lang.String fileName) throws IPWorksException
This method loads an RSS 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
public void readOPML(java.lang.String OPMLFile) throws IPWorksException
This method reads in the OPML file specified
by OPMLFile . The bean then
parses the file and returns the data to the user
in the OPMLHeader
and OPMLOutline
events.
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 RSS feed.
IPWorksException
public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws IPWorksException
This method is intended for extending functionality of the RSS bean. It will set the value for a specific field of this RSS 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:
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:
RSSControl.SetProperty("item[5]/guid@isPermaLink", "true")
Note : in order to add non-standard fields (i.e. fields
that are not defined in the RSS 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 RSS feed from the existing property values to Filename . The RSS feed will be pre- verified and if there are any missing required fields the bean throws an exception.
Example (Add a New Item)
RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com")
RSSControl.WriteFile(filename)
Example (Add a New Item using the Items Collection) RSSControl.Items.Add(New RSSItem("New Item Title", "Item Description"))
RSSControl.Items[0].Link = "http://www.itemsource.com"
RSSControl.WriteFile(filename)
IPWorksException
public void addRssEventListener(RssEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeRssEventListener(RssEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |