org.apache.openejb.jee.was.v6.wsclient

Class Handler

java.lang.Object

org.apache.openejb.jee.was.v6.common.DescriptionGroup

org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup

org.apache.openejb.jee.was.v6.wsclient.Handler

public class Handler
extends CompatibilityDescriptionGroup

Declares the handler for a port-component. Handlers can access the init-param name/value pairs using the HandlerInfo interface. If port-name is not specified, the handler is assumed to be associated with all ports of the service.

Used in: service-ref

Java class for Handler complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Handler">
   <complexContent>
     <extension base="{common.xmi}CompatibilityDescriptionGroup">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="soapRoles" type="{http://www.w3.org/2001/XMLSchema}string"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="portNames" type="{http://www.w3.org/2001/XMLSchema}string"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="handlerClass" type="{java.xmi}JavaClass"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="initParams" type="{common.xmi}ParamValue"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="soapHeaders" type="{common.xmi}QName"/>
         </choice>
       </choice>
       <attribute name="handlerClass" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="handlerName" type="{http://www.w3.org/2001/XMLSchema}string" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<JavaClass>	handlerClasses
protected String	handlerClassString
protected String	handlerName
protected List<ParamValue>	initParams
protected List<String>	portNames
protected List<QName>	soapHeaders
protected List<String>	soapRoles

Fields inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup

description, displayName, largeIcon, smallIcon

Fields inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup

descriptions, displayNames, extensions, href, icons, id, idref, label, type, uuid, version

Constructor Summary

Constructors

Constructor and Description
Handler()

Method Summary

Methods

Modifier and Type	Method and Description
List<JavaClass>	getHandlerClasses() Gets the value of the handlerClasses property.
String	getHandlerClassString() Gets the value of the handlerClassString property.
String	getHandlerName() Gets the value of the handlerName property.
List<ParamValue>	getInitParams() Gets the value of the initParams property.
List<String>	getPortNames() Gets the value of the portNames property.
List<QName>	getSoapHeaders() Gets the value of the soapHeaders property.
List<String>	getSoapRoles() Gets the value of the soapRoles property.
void	setHandlerClassString(String value) Sets the value of the handlerClassString property.
void	setHandlerName(String value) Sets the value of the handlerName property.

Methods inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup

getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDisplayName, setLargeIcon, setSmallIcon

Methods inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup

getDescriptions, getDisplayNames, getExtensions, getHref, getIcons, getId, getIdref, getLabel, getType, getUuid, getVersion, setHref, setId, setIdref, setLabel, setType, setUuid, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

soapRoles

protected List<String> soapRoles

portNames

protected List<String> portNames

handlerClasses

protected List<JavaClass> handlerClasses

initParams

protected List<ParamValue> initParams

soapHeaders

protected List<QName> soapHeaders

handlerClassString

protected String handlerClassString

handlerName

protected String handlerName

Constructor Detail

Handler

public Handler()

Method Detail

getSoapRoles

public List<String> getSoapRoles()

Gets the value of the soapRoles property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the soapRoles property.

For example, to add a new item, do as follows:

 getSoapRoles().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getPortNames

public List<String> getPortNames()

Gets the value of the portNames property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the portNames property.

For example, to add a new item, do as follows:

 getPortNames().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getHandlerClasses

public List<JavaClass> getHandlerClasses()

Gets the value of the handlerClasses property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the handlerClasses property.

For example, to add a new item, do as follows:

 getHandlerClasses().add(newItem);
 

Objects of the following type(s) are allowed in the list JavaClass

getInitParams

public List<ParamValue> getInitParams()

Gets the value of the initParams property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParams property.

For example, to add a new item, do as follows:

 getInitParams().add(newItem);
 

Objects of the following type(s) are allowed in the list ParamValue

getSoapHeaders

public List<QName> getSoapHeaders()

Gets the value of the soapHeaders property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the soapHeaders property.

For example, to add a new item, do as follows:

 getSoapHeaders().add(newItem);
 

Objects of the following type(s) are allowed in the list QName

getHandlerClassString

public String getHandlerClassString()

Gets the value of the handlerClassString property.

Returns:

possible object is String

setHandlerClassString

public void setHandlerClassString(String value)

Sets the value of the handlerClassString property.

Parameters:

value - allowed object is String

getHandlerName

public String getHandlerName()

Gets the value of the handlerName property.

Returns:

possible object is String

setHandlerName

public void setHandlerName(String value)

Sets the value of the handlerName property.

Parameters:

value - allowed object is String