org.ow2.jonas.deployment.common
Class HandlerDesc

java.lang.Object
  org.ow2.jonas.deployment.common.HandlerDesc

public class HandlerDesc
extends Object

The Handler class describe both - a Handler reference to use on the client side of a Web Service, - and a Handler description. The difference is that the port-names attribute is present for a handler reference, and the port-names attribute does not exist for a handler description.

Author:

Guillaume Sauthier, Xavier Delplanque, Helene Joanin

Constructor Summary

HandlerDesc(ClassLoader classLoader, Handler handler)
Creates a new HandlerRef object.

Method Summary

boolean	equals(Object other) Test Equality between 2 Objects.
Class	getHandlerClass() Return the Handler implementation class.
String	getHandlerClassName() Return the name of class of the Handler.
String	getInitParam(String pname) Return the value of an init-param.
Properties	getInitParams() Return all the init-params of the Handler.
String	getName() Return the name of the Handler.
List	getPortNames() Return the list of port name the Handler is associated with.
List	getSOAPHeaders() Return the list of Headers the Handlers will access.
List	getSOAPRoles() Return the list of SOAP Actor Definitions the Handler will play as a role.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerDesc

public HandlerDesc(ClassLoader classLoader,
                   Handler handler)
            throws DeploymentDescException

Creates a new HandlerRef object.

Parameters:

classLoader - ejbjar classLoader

handler - contains informations defined in web deployment descriptor (service-ref)

Throws:

DeploymentDescException - When Construction fails.

Method Detail

getName

public String getName()

Return the name of the Handler.

Returns:

the name of the Handler.

getHandlerClassName

public String getHandlerClassName()

Return the name of class of the Handler.

Returns:

the name of class of the Handler.

getHandlerClass

public Class getHandlerClass()

Return the Handler implementation class.

Returns:

the Handler class

getInitParams

public Properties getInitParams()

Return all the init-params of the Handler.

Returns:

the init-params of the Handler

getInitParam

public String getInitParam(String pname)

Return the value of an init-param.

Parameters:

pname - The key of init-param map.

Returns:

the value of an init-param

getSOAPHeaders

public List getSOAPHeaders()

Return the list of Headers the Handlers will access.

Returns:

the list of Headers the Handlers will access.

getSOAPRoles

public List getSOAPRoles()

Return the list of SOAP Actor Definitions the Handler will play as a role.

Returns:

the list of Role the Handler will play

getPortNames

public List getPortNames()

Return the list of port name the Handler is associated with. The names match the localPart of the Port QName.

Returns:

the list of port name the Handler is associated with.

equals

public boolean equals(Object other)

Test Equality between 2 Objects.

Overrides:

equals in class Object

Parameters:

other - The object to compare.

Returns:

true if the objects are equals in value, else false.

toString

public String toString()

Overrides:

toString in class Object

Returns:

Returns a String representation of a HandlerDesc