Rss (IP*Works! Internet Toolkit)

Package

Class

Tree

Deprecated

Index

Help

IP*Works! V6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ipworks
Class Rss

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

public class Rss
extends java.lang.Object

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 NamespaceCount , Namespaces and NamespacePrefixes properties and the GetProperty and SetProperty methods.

Field Summary

static int authBasic


static int authDigest


static int frAlways


static int frNever


static int frSameScheme


static int fwNone


static int fwSOCKS4


static int fwSOCKS5


static int fwTunnel


static int rssVersion091


static int rssVersion092


static int rssVersion200


static int rssVersionUndefined


Constructor Summary

Rss()


Method Summary

void addItem(java.lang.String title, java.lang.String description, java.lang.String link)
          Insert 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 array.

void addRssEventListener(RssEventListener l)


java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a beanconfiguration setting.

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

int getAuthScheme()
          The authorization scheme to be used when server authorization is to be performed.

java.lang.String getChannelCategory()
          Location of the current RSS channel in a hierarchy.

java.lang.String getChannelCategoryDomain()
          URL indicating the definition of the current RSS channel's category.

java.lang.String getChannelCopyright()
          Copyright information for the current RSS channel (500 char max).

java.lang.String getChannelDescription()
          Text description of the current RSS feed (Required - 500 char max).

java.lang.String getChannelDocs()
          URL of the documentation for the format used in the current RSS channel.

java.lang.String getChannelLanguage()
          Language code for current RSS channel.

java.lang.String getChannelLastBuildDate()
          The date of the current RSS channel's most recent content change.

java.lang.String getChannelLink()
          URL of the website that corresponds with the RSS feed (Required - 500 char max).

java.lang.String getChannelManagingEditor()
          Email address of the current RSS channel's editor.

java.lang.String getChannelPubDate()
          The date of the current RSS channel's most recent publication.

java.lang.String getChannelTitle()
          The title of the current RSS Feed (Required - 40 char max).

java.lang.String getChannelWebMaster()
          Email address of the current RSS channel's webmaster.

void getFeed(java.lang.String URL)
          Fetch an RSS feed.

java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).

java.lang.String getFirewallPassword()
          A password if authentication is to be used when connecting through the firewall.

int getFirewallPort()
          Port of the firewall to connect to.

int getFirewallType()
          Determines the type of firewall to connect through.

java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.

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

java.lang.String getImageLink()
          URL associated with the channel's associated image.

java.lang.String getImageTitle()
          The title of the channel's associated image.

java.lang.String getImageURL()
          URL location of the channel's associated image.

java.lang.String getItemAuthor(int itemIndex)
          Email address of the current item's author.

java.lang.String getItemCategory(int itemIndex)
          Location of the current item within a hierarchy.

java.lang.String getItemCategoryDomain(int itemIndex)
          URL indicating the definition of the current item's category.

java.lang.String getItemComments(int itemIndex)
          URL location of the comments page for the current item.

int getItemCount()
          The number of items in the current RSS channel.

java.lang.String getItemDescription(int itemIndex)
          The content of the current item.

java.lang.String getItemGuid(int itemIndex)
          A unique string that identifies the current item.

java.lang.String getItemLink(int itemIndex)
          URL where the full text of the current item can be found.

java.lang.String getItemPubDate(int itemIndex)
          The date of the current item's most recent publication.

java.lang.String getItemSource(int itemIndex)
          Name of the RSS channel where the current item was originally published.

java.lang.String getItemSourceURL(int itemIndex)
          URL location of the XML-version of the current item's source.

java.lang.String getItemTitle(int itemIndex)
          The title or headline of the current item.

int getNamespaceCount()
          The number of currently-defined namespaces in this RSS channel.

java.lang.String getNamespacePrefixes(int namespaceIndex)
          The namespace prefixes associated with Namespaces .

java.lang.String getNamespaces(int namespaceIndex)
          The name or XML prefix associated with NamespacePrefixes .

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

java.lang.String getProperty(java.lang.String propertyName)
          Get the value of a specific RSS feed property.

java.lang.String getRSSData()
          The complete text of the RSS XML file.

int getRSSVersion()
          The RSS protocol version of the current RSS feed.

java.lang.String getTextInputDescription()
          The description for the current RSS channel's TextInput object.

java.lang.String getTextInputLink()
          Processor URL for the text of the current RSS channel's TextInput object.

java.lang.String getTextInputName()
          The name of the current RSS channel's TextInput object.

java.lang.String getTextInputTitle()
          The title of the current RSS channel's TextInput object.

int getTimeout()
          A timeout for the bean.

void getURL(java.lang.String URL)
          Fetch an RSS feed.

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

boolean isConnected()
          Shows whether the bean is connected.

boolean isIdle()
          The current status of the component.

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

void readFile(java.lang.String fileName)
          Load an RSS file into the bean.

void removeRssEventListener(RssEventListener l)


void reset()
          Reset all properties of the bean.

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

void setAuthScheme(int authScheme)
          The authorization scheme to be used when server authorization is to be performed.

void setChannelCategory(java.lang.String channelCategory)
          Location of the current RSS channel in a hierarchy.

void setChannelCategoryDomain(java.lang.String channelCategoryDomain)
          URL indicating the definition of the current RSS channel's category.

void setChannelCopyright(java.lang.String channelCopyright)
          Copyright information for the current RSS channel (500 char max).

void setChannelDescription(java.lang.String channelDescription)
          Text description of the current RSS feed (Required - 500 char max).

void setChannelDocs(java.lang.String channelDocs)
          URL of the documentation for the format used in the current RSS channel.

void setChannelLanguage(java.lang.String channelLanguage)
          Language code for current RSS channel.

void setChannelLastBuildDate(java.lang.String channelLastBuildDate)
          The date of the current RSS channel's most recent content change.

void setChannelLink(java.lang.String channelLink)
          URL of the website that corresponds with the RSS feed (Required - 500 char max).

void setChannelManagingEditor(java.lang.String channelManagingEditor)
          Email address of the current RSS channel's editor.

void setChannelPubDate(java.lang.String channelPubDate)
          The date of the current RSS channel's most recent publication.

void setChannelTitle(java.lang.String channelTitle)
          The title of the current RSS Feed (Required - 40 char max).

void setChannelWebMaster(java.lang.String channelWebMaster)
          Email address of the current RSS channel's webmaster.

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

void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).

void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used when connecting through the firewall.

void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.

void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.

void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.

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

void setImageLink(java.lang.String imageLink)
          URL associated with the channel's associated image.

void setImageTitle(java.lang.String imageTitle)
          The title of the channel's associated image.

void setImageURL(java.lang.String imageURL)
          URL location of the channel's associated image.

void setItemAuthor(int itemIndex, java.lang.String itemAuthor)
          Email address of the current item's author.

void setItemCategory(int itemIndex, java.lang.String itemCategory)
          Location of the current item within a hierarchy.

void setItemCategoryDomain(int itemIndex, java.lang.String itemCategoryDomain)
          URL indicating the definition of the current item's category.

void setItemComments(int itemIndex, java.lang.String itemComments)
          URL location of the comments page for the current item.

void setItemCount(int itemCount)
          The number of items in the current RSS channel.

void setItemDescription(int itemIndex, java.lang.String itemDescription)
          The content of the current item.

void setItemGuid(int itemIndex, java.lang.String itemGuid)
          A unique string that identifies the current item.

void setItemLink(int itemIndex, java.lang.String itemLink)
          URL where the full text of the current item can be found.

void setItemPubDate(int itemIndex, java.lang.String itemPubDate)
          The date of the current item's most recent publication.

void setItemSource(int itemIndex, java.lang.String itemSource)
          Name of the RSS channel where the current item was originally published.

void setItemSourceURL(int itemIndex, java.lang.String itemSourceURL)
          URL location of the XML-version of the current item's source.

void setItemTitle(int itemIndex, java.lang.String itemTitle)
          The title or headline of the current item.

void setNamespaceCount(int namespaceCount)
          The number of currently-defined namespaces in this RSS channel.

void setNamespacePrefixes(int namespaceIndex, java.lang.String namespacePrefixes)
          The namespace prefixes associated with Namespaces .

void setNamespaces(int namespaceIndex, java.lang.String namespaces)
          The name or XML prefix associated with NamespacePrefixes .

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

void setProperty(java.lang.String propertyName, java.lang.String propertyValue)
          Set the value of a specific RSS feed property.

void setRSSVersion(int RSSVersion)
          The RSS protocol version of the current RSS feed.

void setTextInputDescription(java.lang.String textInputDescription)
          The description for the current RSS channel's TextInput object.

void setTextInputLink(java.lang.String textInputLink)
          Processor URL for the text of the current RSS channel's TextInput object.

void setTextInputName(java.lang.String textInputName)
          The name of the current RSS channel's TextInput object.

void setTextInputTitle(java.lang.String textInputTitle)
          The title of the current RSS channel's TextInput object.

void setTimeout(int timeout)
          A timeout for the bean.

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

void writeFile(java.lang.String filename)
          Write 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

authBasic

public static final int authBasic

See Also:: Constant Field Values

authDigest

public static final int authDigest

See Also:: Constant Field Values

fwNone

public static final int fwNone

See Also:: Constant Field Values

fwTunnel

public static final int fwTunnel

See Also:: Constant Field Values

fwSOCKS4

public static final int fwSOCKS4

See Also:: Constant Field Values

fwSOCKS5

public static final int fwSOCKS5

See Also:: Constant Field Values

frNever

public static final int frNever

See Also:: Constant Field Values

frAlways

public static final int frAlways

See Also:: Constant Field Values

frSameScheme

public static final int frSameScheme

See Also:: Constant Field Values

rssVersionUndefined

public static final int rssVersionUndefined

See Also:: Constant Field Values

rssVersion091

public static final int rssVersion091

See Also:: Constant Field Values

rssVersion092

public static final int rssVersion092

See Also:: Constant Field Values

rssVersion200

public static final int rssVersion200

See Also:: Constant Field Values

Constructor Detail

Rss

public Rss()

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

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

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

setAccept

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

A list of acceptable MIME types for the request.

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

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

IPWorksException

getAuthScheme

public int getAuthScheme()

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

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

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

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

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException

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

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

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

IPWorksException

getChannelCategory

public java.lang.String getChannelCategory()

Location of the current RSS channel in a hierarchy.

The value of this field is a forward-slash-separated string that identifies a hierarchic location in a particular hierarchy. The conventions used to interpret an RSS channel's category depend upon the processor.

setChannelCategory

public void setChannelCategory(java.lang.String channelCategory)
                        throws IPWorksException

Location of the current RSS channel in a hierarchy.

IPWorksException

getChannelCategoryDomain

public java.lang.String getChannelCategoryDomain()

URL indicating the definition of the current RSS channel's category.

This points to a location that defines the category indicated by the ChannelCategory property.

setChannelCategoryDomain

public void setChannelCategoryDomain(java.lang.String channelCategoryDomain)
                              throws IPWorksException

URL indicating the definition of the current RSS channel's category.

This points to a location that defines the category indicated by the ChannelCategory property.

IPWorksException

getChannelCopyright

public java.lang.String getChannelCopyright()

Contains copyright information about the current RSS channel.

setChannelCopyright

public void setChannelCopyright(java.lang.String channelCopyright)
                         throws IPWorksException

Contains copyright information about the current RSS channel.

IPWorksException

getChannelDescription

public java.lang.String getChannelDescription()

Text description of the current RSS feed (Required - 500 char max).

ChannelDescription contains a short description of the channel contents.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

setChannelDescription

public void setChannelDescription(java.lang.String channelDescription)
                           throws IPWorksException

Text description of the current RSS feed (Required - 500 char max).

ChannelDescription contains a short description of the channel contents.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

IPWorksException

getChannelDocs

public java.lang.String getChannelDocs()

URL of the documentation for the format used in the current RSS channel.

This field should contain a URL for the documentation describing what format was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

setChannelDocs

public void setChannelDocs(java.lang.String channelDocs)
                    throws IPWorksException

URL of the documentation for the format used in the current RSS channel.

IPWorksException

getChannelLanguage

public java.lang.String getChannelLanguage()

Language code for current RSS channel.

This property is required for feeds that conform to version 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Examples include:

en \011: English
en-US: English (U.S. version)
ja \011: Japanese
sq \011: Albanian
fr-ca: French (Canada)
etc...

For a detailed explanation about language codes please refer to RFC 1766.

setChannelLanguage

public void setChannelLanguage(java.lang.String channelLanguage)
                        throws IPWorksException

Language code for current RSS channel.

This property is required for feeds that conform to version 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Examples include:

en \011: English
en-US: English (U.S. version)
ja \011: Japanese
sq \011: Albanian
fr-ca: French (Canada)
etc...

For a detailed explanation about language codes please refer to RFC 1766.

IPWorksException

getChannelLastBuildDate

public java.lang.String getChannelLastBuildDate()

The date of the current RSS channel's most recent content change.

This field contains the date of the current RSS channel's most recent content changes. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

setChannelLastBuildDate

public void setChannelLastBuildDate(java.lang.String channelLastBuildDate)
                             throws IPWorksException

The date of the current RSS channel's most recent content change.

IPWorksException

getChannelLink

public java.lang.String getChannelLink()

URL of the website that corresponds with the RSS feed (Required - 500 char max).

ChannelLink contains the URL that corresponds to the web site where the RSS channel is located.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

setChannelLink

public void setChannelLink(java.lang.String channelLink)
                    throws IPWorksException

URL of the website that corresponds with the RSS feed (Required - 500 char max).

ChannelLink contains the URL that corresponds to the web site where the RSS channel is located.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

IPWorksException

getChannelManagingEditor

public java.lang.String getChannelManagingEditor()

Email address of the current RSS channel's editor.

This field contains the email address or contact information for the current RSS channel's editor.

setChannelManagingEditor

public void setChannelManagingEditor(java.lang.String channelManagingEditor)
                              throws IPWorksException

Email address of the current RSS channel's editor.

This field contains the email address or contact information for the current RSS channel's editor.

IPWorksException

getChannelPubDate

public java.lang.String getChannelPubDate()

The date of the current RSS channel's most recent publication.

This field contains the date of the current RSS channel's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

setChannelPubDate

public void setChannelPubDate(java.lang.String channelPubDate)
                       throws IPWorksException

The date of the current RSS channel's most recent publication.

IPWorksException

getChannelTitle

public java.lang.String getChannelTitle()

The title of the current RSS Feed (Required - 40 char max).

ChannelTitle contains the title of the current RSS channel. Typically the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

setChannelTitle

public void setChannelTitle(java.lang.String channelTitle)
                     throws IPWorksException

The title of the current RSS Feed (Required - 40 char max).

ChannelTitle contains the title of the current RSS channel. Typically the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include ChannelLink , ChannelTitle , and ChannelDescription .

IPWorksException

getChannelWebMaster

public java.lang.String getChannelWebMaster()

Email address of the current RSS channel's webmaster.

This field contains the email address or contact information for the current RSS channel's webmaster.

setChannelWebMaster

public void setChannelWebMaster(java.lang.String channelWebMaster)
                         throws IPWorksException

Email address of the current RSS channel's webmaster.

This field contains the email address or contact information for the current RSS channel's webmaster.

IPWorksException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

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

setConnected

public void setConnected(boolean connected)
                  throws IPWorksException

Shows whether the bean is connected.

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

IPWorksException

getFirewallHost

public java.lang.String getFirewallHost()

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.

setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

IPWorksException

getFirewallPassword

public java.lang.String getFirewallPassword()

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException

A password if authentication is to be used when connecting through the firewall.

IPWorksException

getFirewallPort

public int getFirewallPort()

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

IPWorksException

getFirewallType

public int getFirewallType()

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0): No firewall (default setting).
fwTunnel (1): Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2): Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3): Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0): No firewall (default setting).
fwTunnel (1): Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2): Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3): Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

IPWorksException

getFirewallUser

public java.lang.String getFirewallUser()

A user name if authentication is to be used connecting through a firewall.

setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException

A user name if authentication is to be used connecting through a firewall.

IPWorksException

getFollowRedirects

public int getFollowRedirects()

Determines what happens when the server issues a redirect.

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

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

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

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

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

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

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksException

Determines what happens when the server issues a redirect.

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

IPWorksException

isIdle

public boolean isIdle()

The current status of the component.

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

getImageLink

public java.lang.String getImageLink()

URL associated with the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image. For graphical representations, this is the webpage that will be displayed if the image is clicked.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

setImageLink

public void setImageLink(java.lang.String imageLink)
                  throws IPWorksException

URL associated with the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image. For graphical representations, this is the webpage that will be displayed if the image is clicked.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

IPWorksException

getImageTitle

public java.lang.String getImageTitle()

The title of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

setImageTitle

public void setImageTitle(java.lang.String imageTitle)
                   throws IPWorksException

The title of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

IPWorksException

getImageURL

public java.lang.String getImageURL()

URL location of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

setImageURL

public void setImageURL(java.lang.String imageURL)
                 throws IPWorksException

URL location of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink: The link associated with the image.
ImageTitle: The title of the image.
ImageURL: URL where the image can be found.

IPWorksException

getItemAuthor

public java.lang.String getItemAuthor(int itemIndex)
                               throws IPWorksException

Email address of the current item's author.

This field contains the email address or contact information for the current item's author.

IPWorksException

setItemAuthor

public void setItemAuthor(int itemIndex,
                          java.lang.String itemAuthor)
                   throws IPWorksException

Email address of the current item's author.

This field contains the email address or contact information for the current item's author.

IPWorksException

getItemCategory

public java.lang.String getItemCategory(int itemIndex)
                                 throws IPWorksException

Location of the current item within a hierarchy.

The value of this field is a forward-slash-separated string that identifies a hierarchic location in a particular hierarchy. The conventions used to interpret an RSS item's category depend upon the processor.

IPWorksException

setItemCategory

public void setItemCategory(int itemIndex,
                            java.lang.String itemCategory)
                     throws IPWorksException

Location of the current item within a hierarchy.

IPWorksException

getItemCategoryDomain

public java.lang.String getItemCategoryDomain(int itemIndex)
                                       throws IPWorksException

URL indicating the definition of the current item's category.

This points to a location that defines the category indicated by the ItemCategory property.

IPWorksException

setItemCategoryDomain

public void setItemCategoryDomain(int itemIndex,
                                  java.lang.String itemCategoryDomain)
                           throws IPWorksException

URL indicating the definition of the current item's category.

This points to a location that defines the category indicated by the ItemCategory property.

IPWorksException

getItemComments

public java.lang.String getItemComments(int itemIndex)
                                 throws IPWorksException

URL location of the comments page for the current item.

If present, this should point to a page for comments related to the current item.

IPWorksException

setItemComments

public void setItemComments(int itemIndex,
                            java.lang.String itemComments)
                     throws IPWorksException

URL location of the comments page for the current item.

If present, this should point to a page for comments related to the current item.

IPWorksException

getItemCount

public int getItemCount()

The number of items in the current RSS channel.

This is the total number of items in the current RSS channel. All items are indexed from 1 to ItemCount

setItemCount

public void setItemCount(int itemCount)
                  throws IPWorksException

The number of items in the current RSS channel.

This is the total number of items in the current RSS channel. All items are indexed from 1 to ItemCount

IPWorksException

getItemDescription

public java.lang.String getItemDescription(int itemIndex)
                                    throws IPWorksException

The content of the current item.

This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

This is the description of the content of the current item. For abstracts, ItemLink should point to the complete text of the item.

IPWorksException

setItemDescription

public void setItemDescription(int itemIndex,
                               java.lang.String itemDescription)
                        throws IPWorksException

The content of the current item.

This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

This is the description of the content of the current item. For abstracts, ItemLink should point to the complete text of the item.

IPWorksException

getItemGuid

public java.lang.String getItemGuid(int itemIndex)
                             throws IPWorksException

A unique string that identifies the current item.

This is the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use ItemGuid to determine whether or not an item is new.

Aggregators should view this value as a string, but it is up to the source of the feed to guarantee its uniqueness. The value may be the URL link to the full text of the item in order to help guarantee that it is unique.

IPWorksException

setItemGuid

public void setItemGuid(int itemIndex,
                        java.lang.String itemGuid)
                 throws IPWorksException

A unique string that identifies the current item.

This is the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use ItemGuid to determine whether or not an item is new.

IPWorksException

getItemLink

public java.lang.String getItemLink(int itemIndex)
                             throws IPWorksException

URL where the full text of the current item can be found.

For headline or abstract items, this should be the location of the full text of the item.

IPWorksException

setItemLink

public void setItemLink(int itemIndex,
                        java.lang.String itemLink)
                 throws IPWorksException

URL where the full text of the current item can be found.

For headline or abstract items, this should be the location of the full text of the item.

IPWorksException

getItemPubDate

public java.lang.String getItemPubDate(int itemIndex)
                                throws IPWorksException

The date of the current item's most recent publication.

This field contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

IPWorksException

setItemPubDate

public void setItemPubDate(int itemIndex,
                           java.lang.String itemPubDate)
                    throws IPWorksException

The date of the current item's most recent publication.

This field contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

IPWorksException

getItemSource

public java.lang.String getItemSource(int itemIndex)
                               throws IPWorksException

Name of the RSS channel where the current item was originally published.

This property is the name of the RSS channel in which the item was originally published, derived from the channel's title. If ItemSource or ItemSourceURL are empty, they should be filled with the values in ChannelTitle and ChannelLink before forwarding the feed from a news aggregator to a weblog.

IPWorksException

setItemSource

public void setItemSource(int itemIndex,
                          java.lang.String itemSource)
                   throws IPWorksException

Name of the RSS channel where the current item was originally published.

IPWorksException

getItemSourceURL

public java.lang.String getItemSourceURL(int itemIndex)
                                  throws IPWorksException

URL location of the XML-version of the current item's source.

This is required if ItemSource is defined. It is a URL that points to the XML representation of the source of the current item.

IPWorksException

setItemSourceURL

public void setItemSourceURL(int itemIndex,
                             java.lang.String itemSourceURL)
                      throws IPWorksException

URL location of the XML-version of the current item's source.

This is required if ItemSource is defined. It is a URL that points to the XML representation of the source of the current item.

IPWorksException

getItemTitle

public java.lang.String getItemTitle(int itemIndex)
                              throws IPWorksException

The title or headline of the current item.

This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

ItemTitle should contain a short description of the item, or a headline if ItemDescription is defined.

IPWorksException

setItemTitle

public void setItemTitle(int itemIndex,
                         java.lang.String itemTitle)
                  throws IPWorksException

The title or headline of the current item.

This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

ItemTitle should contain a short description of the item, or a headline if ItemDescription is defined.

IPWorksException

getNamespaceCount

public int getNamespaceCount()

The number of currently-defined namespaces in this 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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

When parsing an RSS feed 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 IPWorksException raises an IPWorksException 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 first call the Config method with AllowNonRSS as the argument (i.e. Config("AllowNonRSS") ), and 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.

setNamespaceCount

public void setNamespaceCount(int namespaceCount)
                       throws IPWorksException

The number of currently-defined namespaces in this 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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

IPWorksException

getNamespacePrefixes

public java.lang.String getNamespacePrefixes(int namespaceIndex)
                                      throws IPWorksException

The namespace prefixes associated with Namespaces .

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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

IPWorksException

setNamespacePrefixes

public void setNamespacePrefixes(int namespaceIndex,
                                 java.lang.String namespacePrefixes)
                          throws IPWorksException

The namespace prefixes associated with Namespaces .

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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

IPWorksException

getNamespaces

public java.lang.String getNamespaces(int namespaceIndex)
                               throws IPWorksException

The name or XML prefix associated with NamespacePrefixes .

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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

IPWorksException

setNamespaces

public void setNamespaces(int namespaceIndex,
                          java.lang.String namespaces)
                   throws IPWorksException

The name or XML prefix associated with NamespacePrefixes .

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.

The following properties will be filled automatically when retrieving RSS feeds but must be filled manually when generating a feed that contains non-standard properties:

NamespaceCount: This is the total number of top-level XML namespaces defined in the current RSS feed. All namespaces are indexed from 1 to NamespaceCount .
NamespacePrefixes: The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .
Namespaces: Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

IPWorksException

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

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

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

setPassword

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

A password if authentication is to be used.

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

IPWorksException

getRSSData

public java.lang.String getRSSData()

The complete text of the RSS XML file.

When retrieving RSS feeds through the GetFeed or HTML through the GetURL method, this 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.

getRSSVersion

public int getRSSVersion()

The RSS protocol version of the current RSS feed.

RSSVersion is 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:

0: rssVersionUndefined
1: rssVersion091
2: rssVersion092
3: rssVersion200

In order to set properties not defined in the given version, use the NamespaceCount , Namespaces and NamespacePrefixes properties to list and define namespace,s and the GetProperty and SetProperty methods to list and define each non-standard property.

setRSSVersion

public void setRSSVersion(int RSSVersion)
                   throws IPWorksException

The RSS protocol version of the current RSS feed.

The following are the values currently recognized by the bean:

0: rssVersionUndefined
1: rssVersion091
2: rssVersion092
3: rssVersion200

IPWorksException