org.objectweb.jonas_ws.deployment.api
Class HandlerRef

java.lang.Object
  extended byorg.objectweb.jonas_ws.deployment.api.HandlerRef

public class HandlerRef
extends java.lang.Object

The HandlerRef class describe a Handler to use on the client side of a Web Service.

Author:
Guillaume Sauthier, Xavier Delplanque

Constructor Summary
HandlerRef(java.lang.ClassLoader classLoader, org.objectweb.jonas_ejb.deployment.xml.Handler handler)
          Creates a new HandlerRef object.
HandlerRef(java.lang.ClassLoader classLoader, org.objectweb.jonas_web.deployment.xml.Handler handler)
          Creates a new HandlerRef object.
 
Method Summary
 boolean equals(java.lang.Object other)
          Test Equality between 2 Objects.
 java.lang.Class getHandlerClass()
          Return the Handler implementation class.
 java.lang.String getInitParam(java.lang.String pname)
          Return the value of an init-param.
 java.util.Hashtable getInitParams()
          Return all the init-params of the Handler.
 java.lang.String getName()
          Return the name of the Handler.
 java.util.List getPortNames()
          Return the list of port name the Handler is associated with.
 java.util.List getSOAPHeaders()
          Return the list of Headers the Handlers will access.
 java.util.List getSOAPRoles()
          Return the list of SOAP Actor Definitions the Handler will play as a role.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HandlerRef

public HandlerRef(java.lang.ClassLoader classLoader,
                  org.objectweb.jonas_ejb.deployment.xml.Handler handler)
           throws WSDeploymentDescException
Creates a new HandlerRef object.

Parameters:
classLoader - ejbjar classLoader
handler - contains informations defined in ejb deployment descriptor (service-ref)
Throws:
WSDeploymentDescException - When Construction fails.

HandlerRef

public HandlerRef(java.lang.ClassLoader classLoader,
                  org.objectweb.jonas_web.deployment.xml.Handler handler)
           throws WSDeploymentDescException
Creates a new HandlerRef object.

Parameters:
classLoader - ejbjar classLoader
handler - contains informations defined in web deployment descriptor (service-ref)
Throws:
WSDeploymentDescException - When Construction fails.
Method Detail

getName

public java.lang.String getName()
Return the name of the Handler.

Returns:
the name of the Handler.

getHandlerClass

public java.lang.Class getHandlerClass()
Return the Handler implementation class.

Returns:
the Handler class

getInitParams

public java.util.Hashtable getInitParams()
Return all the init-params of the Handler.

Returns:
the init-params of the Handler

getInitParam

public java.lang.String getInitParam(java.lang.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 java.util.List getSOAPHeaders()
Return the list of Headers the Handlers will access.

Returns:
the list of Headers the Handlers will access.

getSOAPRoles

public java.util.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 java.util.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(java.lang.Object other)
Test Equality between 2 Objects.

Parameters:
other - The object to compare.
Returns:
true if the objects are equals in value, else false.