christophedelory.rss
Class Cloud

java.lang.Object
  christophedelory.rss.Cloud

public class Cloud
extends Object

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.

 <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.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Cloud()

Method Summary

String	getDomain() Returns the cloud's domain.
String	getPath() Returns the cloud's path.
int	getPort() Returns the port number.
String	getProtocol() Returns the protocol.
String	getRegisterProcedure() Returns the cloud's registration procedure.
void	setDomain(String domain) Initializes the cloud's domain.
void	setPath(String path) Initializes the cloud's path.
void	setPort(int port) Initializes the port number.
void	setProtocol(String protocol) Initializes the protocol.
void	setRegisterProcedure(String registerProcedure) Initializes the cloud's register procedure.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cloud

public Cloud()

Method Detail

setDomain

public void setDomain(String domain)

Initializes the cloud's domain.

Parameters:

domain - a domain. Shall not be null.

Throws:

NullPointerException - if domain is null.

See Also:

getDomain()

getDomain

public String getDomain()

Returns the cloud's domain. Example: "rpc.sys.com". No default value.

Returns:

the cloud's domain. May be null if not yet initialized.

See Also:

setDomain(java.lang.String)

setPort

public void setPort(int port)

Initializes the port number.

Parameters:

port - a port number.

See Also:

getPort()

getPort

public int getPort()

Returns the port number. Example: 80. Defaults to 0.

Returns:

a port number.

See Also:

setPort(int)

getPath

public String getPath()

Returns the cloud's path. Example: "/RPC2". No default value.

Returns:

the cloud's path. May be null if not yet initialized.

See Also:

setPath(java.lang.String)

setPath

public void setPath(String path)

Initializes the cloud's path.

Parameters:

path - a path. Shall not be null.

Throws:

NullPointerException - if path is null.

See Also:

getPath()

getRegisterProcedure

public String getRegisterProcedure()

Returns the cloud's registration procedure. Examples: "myCloud.rssPleaseNotify", "pingMe". No default value.

Returns:

a registration procedure. May be null if not yet initialized.

See Also:

setRegisterProcedure(java.lang.String)

setRegisterProcedure

public void setRegisterProcedure(String registerProcedure)

Initializes the cloud's register procedure.

Parameters:

registerProcedure - a registration procedure. Shall not be null.

Throws:

NullPointerException - if registerProcedure is null.

See Also:

getRegisterProcedure()

getProtocol

public String getProtocol()

Returns the protocol. Examples: "xml-rpc", "soap". No default value.

Returns:

a protocol. May be null if not yet initialized.

See Also:

setProtocol(java.lang.String)

setProtocol

public void setProtocol(String protocol)

Initializes the protocol.

Parameters:

protocol - a protocol. Shall not be null.

Throws:

NullPointerException - if protocol is null.

See Also:

getProtocol()