com.createtank.elemenope.transports
Class XmlRpcServletBroker

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.createtank.elemenope.transports.XmlRpcServletBroker

All Implemented Interfaces:

Broker, ElemenopeComponent, ElemenopeConnectionEntity, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.xmlrpc.XmlRpcHandler

Direct Known Subclasses:

XmlRpcElemenopeServletBroker

public class XmlRpcServletBroker
extends javax.servlet.http.HttpServlet
implements Broker, org.apache.xmlrpc.XmlRpcHandler

This is a Servlet class to provide generic XML-RPC -> elemenope functionality from within an application server.

It must be passed the following parameters:

serviceName

name of XML-RPC service
e.g. name=serviceName value=testService

initializationGroup

initialization group name
only one entry allowed
e.g. name=initializationGroup value=ModuleA --> "ModuleA" init group will be used for operations

operationGroup

operationGroup to use for this web service from elemenope.xml configuration file
e.g. name=operationGroup value=transGroupA

Author:

John Joseph Roets [joe@createtank.com]

See Also:

Serialized Form

Constructor Summary

XmlRpcServletBroker()

Method Summary

java.lang.Object	execute(java.lang.String method, java.util.Vector params)
java.util.Map	getConnectionAttributes() gets connectivity attributes
void	init(javax.servlet.ServletConfig config)
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 javax.servlet.http.HttpServlet

service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRpcServletBroker

public XmlRpcServletBroker()

Method Detail

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

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

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

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

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

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

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

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

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