org.apache.wink.common.model.rss
Class RssCloud

java.lang.Object
  org.apache.wink.common.model.rss.RssCloud

public class RssCloud
extends java.lang.Object

Java class for "cloud" element of RSS 2.0 Specification.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="rssCloud">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="domain" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="port" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="registerProcedure" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="protocol" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

<cloud> sub-element of <channel>

<cloud> is an optional sub-element of <channel>.

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.

Example:

<cloud domain="rpc.sys.com" port="80" path="/RPC2" registerProcedure="myCloud.rssPleaseNotify" protocol="xml-rpc" />

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.

Field Summary

protected java.lang.String	domain
protected java.lang.String	path
protected int	port
protected java.lang.String	protocol
protected java.lang.String	registerProcedure

Constructor Summary

RssCloud()

Method Summary

java.lang.String	getDomain() Gets the value of the domain property.
java.lang.String	getPath() Gets the value of the path property.
int	getPort() Gets the value of the port property.
java.lang.String	getProtocol() Gets the value of the protocol property.
java.lang.String	getRegisterProcedure() Gets the value of the registerProcedure property.
void	setDomain(java.lang.String value) Sets the value of the domain property.
void	setPath(java.lang.String value) Sets the value of the path property.
void	setPort(int value) Sets the value of the port property.
void	setProtocol(java.lang.String value) Sets the value of the protocol property.
void	setRegisterProcedure(java.lang.String value) Sets the value of the registerProcedure property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

domain

protected java.lang.String domain

port

protected int port

path

protected java.lang.String path

registerProcedure

protected java.lang.String registerProcedure

protocol

protected java.lang.String protocol

Constructor Detail

RssCloud

public RssCloud()

Method Detail

getDomain

public java.lang.String getDomain()

Gets the value of the domain property.

Returns:

possible object is String

setDomain

public void setDomain(java.lang.String value)

Sets the value of the domain property.

Parameters:

value - allowed object is String

getPort

public int getPort()

Gets the value of the port property.

setPort

public void setPort(int value)

Sets the value of the port property.

getPath

public java.lang.String getPath()

Gets the value of the path property.

Returns:

possible object is String

setPath

public void setPath(java.lang.String value)

Sets the value of the path property.

Parameters:

value - allowed object is String

getRegisterProcedure

public java.lang.String getRegisterProcedure()

Gets the value of the registerProcedure property.

Returns:

possible object is String

setRegisterProcedure

public void setRegisterProcedure(java.lang.String value)

Sets the value of the registerProcedure property.

Parameters:

value - allowed object is String

getProtocol

public java.lang.String getProtocol()

Gets the value of the protocol property.

Returns:

possible object is String

setProtocol

public void setProtocol(java.lang.String value)

Sets the value of the protocol property.

Parameters:

value - allowed object is String