ServiceRefHandlerType (Apache CXF Compatibility Bundle Jar 2.7.0.redhat-611423 API)

java.lang.Object
- org.apache.cxf.jaxws.javaee.ServiceRefHandlerType

public class ServiceRefHandlerType
extends Object

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 service-ref_handlerType complex type.

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

 <complexType name="service-ref_handlerType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="handler-name" type="{http://java.sun.com/xml/ns/javaee}string"/>
         <element name="handler-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="soap-header" type="{http://java.sun.com/xml/ns/javaee}xsdQNameType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="soap-role" type="{http://java.sun.com/xml/ns/javaee}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="port-name" type="{http://java.sun.com/xml/ns/javaee}string" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<DescriptionType>`	`description`
`protected List<DisplayNameType>`	`displayName`
`protected FullyQualifiedClassType`	`handlerClass`
`protected CString`	`handlerName`
`protected List<IconType>`	`icon`
`protected String`	`id`
`protected List<ParamValueType>`	`initParam`
`protected List<CString>`	`portName`
`protected List<XsdQNameType>`	`soapHeader`
`protected List<CString>`	`soapRole`

Constructor Summary

Constructors
Constructor and Description

ServiceRefHandlerType()

Constructors
Constructor and Description
`ServiceRefHandlerType()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<DescriptionType>`	`getDescription()` Gets the value of the description property.
`List<DisplayNameType>`	`getDisplayName()` Gets the value of the displayName property.
`FullyQualifiedClassType`	`getHandlerClass()` Gets the value of the handlerClass property.
`CString`	`getHandlerName()` Gets the value of the handlerName property.
`List<IconType>`	`getIcon()` Gets the value of the icon property.
`String`	`getId()` Gets the value of the id property.
`List<ParamValueType>`	`getInitParam()` Gets the value of the initParam property.
`List<CString>`	`getPortName()` Gets the value of the portName property.
`List<XsdQNameType>`	`getSoapHeader()` Gets the value of the soapHeader property.
`List<CString>`	`getSoapRole()` Gets the value of the soapRole property.
`void`	`setHandlerClass(FullyQualifiedClassType value)` Sets the value of the handlerClass property.
`void`	`setHandlerName(CString value)` Sets the value of the handlerName property.
`void`	`setId(String value)` Sets the value of the id property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - description
```
protected List<DescriptionType> description
```
  - displayName
```
protected List<DisplayNameType> displayName
```
  - icon
```
protected List<IconType> icon
```
  - handlerName
```
protected CString handlerName
```
  - handlerClass
```
protected FullyQualifiedClassType handlerClass
```
  - initParam
```
protected List<ParamValueType> initParam
```
  - soapHeader
```
protected List<XsdQNameType> soapHeader
```
  - soapRole
```
protected List<CString> soapRole
```
  - portName
```
protected List<CString> portName
```
  - id
```
protected String id
```
- Constructor Detail
  - ServiceRefHandlerType
```
public ServiceRefHandlerType()
```
- Method Detail
  - getDescription
```
public List<DescriptionType> getDescription()
```
    Gets the value of the description 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 description property.
    For example, to add a new item, do as follows:
```
    getDescription().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DescriptionType
  - getDisplayName
```
public List<DisplayNameType> getDisplayName()
```
    Gets the value of the displayName 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 displayName property.
    For example, to add a new item, do as follows:
```
    getDisplayName().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DisplayNameType
  - getIcon
```
public List<IconType> getIcon()
```
    Gets the value of the icon 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 icon property.
    For example, to add a new item, do as follows:
```
    getIcon().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list IconType
  - getHandlerName
```
public CString getHandlerName()
```
    Gets the value of the handlerName property.
    
    Returns:
    possible object is CString
  - setHandlerName
```
public void setHandlerName(CString value)
```
    Sets the value of the handlerName property.
    
    Parameters:
    value - allowed object is CString
  - getHandlerClass
```
public FullyQualifiedClassType getHandlerClass()
```
    Gets the value of the handlerClass property.
    
    Returns:
    possible object is FullyQualifiedClassType
  - setHandlerClass
```
public void setHandlerClass(FullyQualifiedClassType value)
```
    Sets the value of the handlerClass property.
    
    Parameters:
    value - allowed object is FullyQualifiedClassType
  - getInitParam
```
public List<ParamValueType> getInitParam()
```
    Gets the value of the initParam 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 initParam property.
    For example, to add a new item, do as follows:
```
    getInitParam().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ParamValueType
  - getSoapHeader
```
public List<XsdQNameType> getSoapHeader()
```
    Gets the value of the soapHeader 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 soapHeader property.
    For example, to add a new item, do as follows:
```
    getSoapHeader().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list XsdQNameType
  - getSoapRole
```
public List<CString> getSoapRole()
```
    Gets the value of the soapRole 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 soapRole property.
    For example, to add a new item, do as follows:
```
    getSoapRole().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CString
  - getPortName
```
public List<CString> getPortName()
```
    Gets the value of the portName 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 portName property.
    For example, to add a new item, do as follows:
```
    getPortName().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CString
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    value - allowed object is String

Class ServiceRefHandlerType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

displayName

icon

handlerName

handlerClass

initParam

soapHeader

soapRole

portName

id

Constructor Detail

ServiceRefHandlerType

Method Detail

getDescription

getDisplayName

getIcon

getHandlerName

setHandlerName

getHandlerClass

setHandlerClass

getInitParam

getSoapHeader

getSoapRole

getPortName

getId

setId