yarfraw.core.datamodel
Class Cloud

java.lang.Object
  yarfraw.core.datamodel.Cloud

All Implemented Interfaces:

Serializable

public class Cloud
extends Object

This is only used by Rss 2.0.

It specifies a web service that supports the rssCloud interface which can be implemented in HTTP-POST, XML-RPC or SOAP 1.1. Its purpose is to allow processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds. In this example, to request notification on the channel it appears in, you would send an XML-RPC message to rpc.sys.com on port 80, with a path of /RPC2. The procedure to call is myCloud.rssPleaseNotify.
A full explanation of this element and the rssCloud interface is here.
http://cyber.law.harvard.edu/rss/soapMeetsRss.html#rsscloudInterface

Example: <cloud domain="rpc.sys.com" port="80" path="/RPC2" registerProcedure="pingMe" protocol="soap"/>

Author:

jliang

See Also:

Serialized Form

Field Summary

protected String	_about
protected String	_base
protected String	_lang
protected Map<QName,String>	_otherAttributes
protected List<Element>	_otherElements
protected String	_resource

Constructor Summary

Cloud()

Cloud(String domain, String port, String path, String registerProcedure, String protocol)

Method Summary

static Cloud	create()
boolean	equals(Object other)
String	getAbout() This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput).
String	getAttributeValueByLocalName(String localName) Search for attributes that are not in the spec by its local name.
String	getAttributeValueByQName(QName name) Search for attributes that are not in the spec by its QName.
String	getBase() This maps to the 'base' attribute that is common in all Atom 1.0 elements.
String	getDomain()
Element	getElementByLocalName(String localName) Search through the other element list and return the FIRST element that matches the input localName.
Element	getElementByNS(String namespaceURI, String localName) Search through the other element list and return the first element that matches both input the namespaceURI and the localName.
String	getLang() The language attribute indicates the language that is used by the enclosed element.
Locale	getLangAsLocale() The language attribute indicates the language that is used by the enclosed element.
Map<QName,String>	getOtherAttributes() Any other attribute that is not in the RSS specs.
List<Element>	getOtherElements() Other additional elements that are not in the Rss specs.
String	getPath()
String	getPort()
String	getProtocol()
String	getRegisterProcedure()
String	getResource() This maps to the optional 'resource' attribute that present in some Rss 1.0 elements.
int	hashCode()
Cloud	setDomain(String domain)
Cloud	setPath(String path)
void	setPort(String port)
Cloud	setProtocol(String protocol)
Cloud	setRegisterProcedure(String registerProcedure)
String	toString()
void	validate(FeedFormat format)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_base

protected String _base

_lang

protected String _lang

_resource

protected String _resource

_about

protected String _about

_otherAttributes

protected Map<QName,String> _otherAttributes

_otherElements

protected List<Element> _otherElements

Constructor Detail

Cloud

public Cloud()

Cloud

public Cloud(String domain,
             String port,
             String path,
             String registerProcedure,
             String protocol)

Method Detail

create

public static Cloud create()

getDomain

public String getDomain()

setDomain

public Cloud setDomain(String domain)

getPort

public String getPort()

setPort

public void setPort(String port)

getPath

public String getPath()

setPath

public Cloud setPath(String path)

getRegisterProcedure

public String getRegisterProcedure()

setRegisterProcedure

public Cloud setRegisterProcedure(String registerProcedure)

getProtocol

public String getProtocol()

setProtocol

public Cloud setProtocol(String protocol)

validate

public void validate(FeedFormat format)
              throws ValidationException

Throws:

ValidationException

getBase

public String getBase()

This maps to the 'base' attribute that is common in all Atom 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getLang

public String getLang()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- attribute value.

getLangAsLocale

public Locale getLangAsLocale()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- a new Locale Object by parsing the lang attribute.

getResource

public String getResource()

This maps to the optional 'resource' attribute that present in some Rss 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getAbout

public String getAbout()

This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput). Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getOtherElements

public List<Element> getOtherElements()

Other additional elements that are not in the Rss specs.

getElementByNS

public Element getElementByNS(String namespaceURI,
                              String localName)

Search through the other element list and return the first element that matches both input the namespaceURI and the localName.

Parameters:

namespaceURI - - namespaceURI of the element to be search for

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getElementByLocalName

public Element getElementByLocalName(String localName)

Search through the other element list and return the FIRST element that matches the input localName.

Parameters:

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Any other attribute that is not in the RSS specs.

getAttributeValueByLocalName

public String getAttributeValueByLocalName(String localName)

Search for attributes that are not in the spec by its local name.

Parameters:

localName - localName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

getAttributeValueByQName

public String getAttributeValueByQName(QName name)

Search for attributes that are not in the spec by its QName.

Parameters:

name - QName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object