com.createtank.elemenope.transports
Class XmlRpcBroker

java.lang.Object
  com.createtank.elemenope.transports.XmlRpcBroker

All Implemented Interfaces:

Broker, ElemenopeComponent, ElemenopeConnectionEntity, org.apache.xmlrpc.XmlRpcHandler

Direct Known Subclasses:

XmlRpcElemenopeBroker

public class XmlRpcBroker
extends java.lang.Object
implements Broker, ElemenopeConnectionEntity, org.apache.xmlrpc.XmlRpcHandler

XML-RPC implementation of the elemenope Broker interface.

For use in creating a generic XML-RPC service, i.e. to allow connectivity from non-elemenope clients.

Author:

John Joseph Roets [joe@createtank.com]

Constructor Summary

XmlRpcBroker()
Creates a new instance of XmlRpcElemenopeBroker

Method Summary

void	connect()
void	connect(Connector connector) Connects to the server and adds handler.
void	disconnect()
java.lang.Object	execute(java.lang.String method, java.util.Vector params)
java.util.Map	getConnectionAttributes() gets connectivity attributes
java.lang.Object	receive(OperationType object) Receives an Object into the elemenope framework.
java.lang.Object	receive(java.lang.String operationType, java.lang.Object object) Receives an Object into the elemenope framework.
java.lang.Object	receive(java.lang.String operationType, java.lang.Object object, java.util.Map atts) Receives an Object into the elemenope framework.
void	releaseComponents() Should be called upon shutdown, in order for elemenope component classes clean up after themselves.
void	setComponents(ElemenopeComponents components) Passes all configured components to implementing Object.
void	setConfigurationAttributes(java.util.Map atts) sets configuration attributes
void	setConnectionAttributes(java.util.Map atts) sets connectivity attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRpcBroker

public XmlRpcBroker()

Creates a new instance of XmlRpcElemenopeBroker

Method Detail

receive

public java.lang.Object receive(OperationType object)
                         throws ElemenopeException

Description copied from interface: Broker

Receives an Object into the elemenope framework. Allows an Object which implements OperationType interface.

Specified by:

receive in interface Broker

Returns:

Object returned by resultant called Operation class

Throws:

ElemenopeException

receive

public java.lang.Object receive(java.lang.String operationType,
                                java.lang.Object object)
                         throws ElemenopeException

Description copied from interface: Broker

Receives an Object into the elemenope framework.

Must provide operation type explicitly.

Specified by:

receive in interface Broker

Parameters:

operationType - Configured name of operation type to call

object - Object to pass to Operation class

Returns:

Object returned by resultant called Operation class

Throws:

ElemenopeException

receive

public java.lang.Object receive(java.lang.String operationType,
                                java.lang.Object object,
                                java.util.Map atts)
                         throws ElemenopeException

Description copied from interface: Broker

Receives an Object into the elemenope framework.

Must provide operation type explicitly.

Specified by:

receive in interface Broker

Parameters:

operationType - Configured name of operation type to call

object - Object to pass to Operation class

atts - attributes for this message (used for asynch bpm attributes)

Returns:

Object returned by resultant called Operation class

Throws:

ElemenopeException

setComponents

public void setComponents(ElemenopeComponents components)

Description copied from interface: ElemenopeComponent

Passes all configured components to implementing Object.

Should ususally be called at the end of the initialization cycle, when all components have been instantiated.

Specified by:

setComponents in interface ElemenopeComponent

setConnectionAttributes

public void setConnectionAttributes(java.util.Map atts)
                             throws ElemenopeException

Description copied from interface: ElemenopeConnectionEntity

sets connectivity attributes

Specified by:

setConnectionAttributes in interface ElemenopeConnectionEntity

Parameters:

atts - Map of connectivity attributes

Throws:

ElemenopeException

connect

public void connect(Connector connector)
             throws ElemenopeConnectionException

Connects to the server and adds handler.

Parameters:

connector -

Throws:

ElemenopeConnectionException

connect

public void connect()
             throws ElemenopeConnectionException

Throws:

ElemenopeConnectionException

disconnect

public void disconnect()
                throws ElemenopeConnectionException

Throws:

ElemenopeConnectionException

getConnectionAttributes

public java.util.Map getConnectionAttributes()
                                      throws ElemenopeException

Description copied from interface: ElemenopeConnectionEntity

gets connectivity attributes

Specified by:

getConnectionAttributes in interface ElemenopeConnectionEntity

Returns:

connectivity attributes

Throws:

ElemenopeException

execute

public java.lang.Object execute(java.lang.String method,
                                java.util.Vector params)
                         throws java.lang.Exception

Specified by:

execute in interface org.apache.xmlrpc.XmlRpcHandler

Throws:

java.lang.Exception

releaseComponents

public void releaseComponents()

Description copied from interface: ElemenopeComponent

Should be called upon shutdown, in order for elemenope component classes clean up after themselves.

Specified by:

releaseComponents in interface ElemenopeComponent

setConfigurationAttributes

public void setConfigurationAttributes(java.util.Map atts)
                                throws ElemenopeException

Description copied from interface: ElemenopeComponent

sets configuration attributes

Specified by:

setConfigurationAttributes in interface ElemenopeComponent

Parameters:

atts - Map of connectivity attributes

Throws:

ElemenopeException