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 java.util.List<JavaClass>`	`handlerClasses`
`protected java.lang.String`	`handlerClassString`
`protected java.lang.String`	`handlerName`
`protected java.util.List<ParamValue>`	`initParams`
`protected java.util.List<java.lang.String>`	`portNames`
`protected java.util.List<QName>`	`soapHeaders`
`protected java.util.List<java.lang.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()

Constructors
Constructor and Description
`Handler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<JavaClass>`	`getHandlerClasses()` Gets the value of the handlerClasses property.
`java.lang.String`	`getHandlerClassString()` Gets the value of the handlerClassString property.
`java.lang.String`	`getHandlerName()` Gets the value of the handlerName property.
`java.util.List<ParamValue>`	`getInitParams()` Gets the value of the initParams property.
`java.util.List<java.lang.String>`	`getPortNames()` Gets the value of the portNames property.
`java.util.List<QName>`	`getSoapHeaders()` Gets the value of the soapHeaders property.
`java.util.List<java.lang.String>`	`getSoapRoles()` Gets the value of the soapRoles property.
`void`	`setHandlerClassString(java.lang.String value)` Sets the value of the handlerClassString property.
`void`	`setHandlerName(java.lang.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 java.util.List<java.lang.String> soapRoles
```
  - portNames
```
protected java.util.List<java.lang.String> portNames
```
  - handlerClasses
```
protected java.util.List<JavaClass> handlerClasses
```
  - initParams
```
protected java.util.List<ParamValue> initParams
```
  - soapHeaders
```
protected java.util.List<QName> soapHeaders
```
  - handlerClassString
```
protected java.lang.String handlerClassString
```
  - handlerName
```
protected java.lang.String handlerName
```
- Constructor Detail
  - Handler
```
public Handler()
```
- Method Detail
  - getSoapRoles
```
public java.util.List<java.lang.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 java.util.List<java.lang.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 java.util.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 java.util.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 java.util.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 java.lang.String getHandlerClassString()
```
    Gets the value of the handlerClassString property.
    
    Returns:
    
    possible object is String
  - setHandlerClassString
```
public void setHandlerClassString(java.lang.String value)
```
    Sets the value of the handlerClassString property.
    
    Parameters:
    
    value - allowed object is String
  - getHandlerName
```
public java.lang.String getHandlerName()
```
    Gets the value of the handlerName property.
    
    Returns:
    
    possible object is String
  - setHandlerName
```
public void setHandlerName(java.lang.String value)
```
    Sets the value of the handlerName property.
    
    Parameters:
    
    value - allowed object is String

Class Handler

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

soapRoles

portNames

handlerClasses

initParams

soapHeaders

handlerClassString

handlerName

Constructor Detail

Handler

Method Detail

getSoapRoles

getPortNames

getHandlerClasses

getInitParams

getSoapHeaders

getHandlerClassString

setHandlerClassString

getHandlerName

setHandlerName