org.eclipse.modisco.jee.ejbjar.EjbJar30
Interface ServiceRefHandlerType


public interface ServiceRefHandlerType

A representation of the model object 'Service Ref Handler Type'. 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

The following features are supported:

See Also:
EjbJar30Package.getServiceRefHandlerType()
Generated:
Model:
extendedMetaData="name='service-ref_handlerType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
  getDisplayName()
          Returns the value of the 'Display Name' containment reference list.
 FullyQualifiedClassType getHandlerClass()
          Returns the value of the 'Handler Class' containment reference.
 String getHandlerName()
          Returns the value of the 'Handler Name' containment reference.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getInitParam()
          Returns the value of the 'Init Param' containment reference list.
  getPortName()
          Returns the value of the 'Port Name' containment reference list.
  getSoapHeader()
          Returns the value of the 'Soap Header' containment reference list.
  getSoapRole()
          Returns the value of the 'Soap Role' containment reference list.
 void setHandlerClass(FullyQualifiedClassType value)
          Sets the value of the 'Handler Class' containment reference.
 void setHandlerName(String value)
          Sets the value of the 'Handler Name' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getDisplayName

 getDisplayName()
Returns the value of the 'Display Name' containment reference list. The list contents are of type DisplayNameType.

If the meaning of the 'Display Name' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Display Name' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='display-name' namespace='http://java.sun.com/xml/ns/javaee'"

getIcon

 getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType.

If the meaning of the 'Icon' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Icon' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_Icon()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='icon' namespace='http://java.sun.com/xml/ns/javaee'"

getHandlerName

String getHandlerName()
Returns the value of the 'Handler Name' containment reference. Defines the name of the handler. The name must be unique within the module.

Returns:
the value of the 'Handler Name' containment reference.
See Also:
setHandlerName(org.eclipse.modisco.jee.ejbjar.EjbJar30.String), EjbJar30Package.getServiceRefHandlerType_HandlerName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='handler-name' namespace='http://java.sun.com/xml/ns/javaee'"

setHandlerName

void setHandlerName(String value)
Sets the value of the 'Handler Name' containment reference.

Parameters:
value - the new value of the 'Handler Name' containment reference.
See Also:
getHandlerName()
Generated:

getHandlerClass

FullyQualifiedClassType getHandlerClass()
Returns the value of the 'Handler Class' containment reference. Defines a fully qualified class name for the handler implementation.

Returns:
the value of the 'Handler Class' containment reference.
See Also:
setHandlerClass(FullyQualifiedClassType), EjbJar30Package.getServiceRefHandlerType_HandlerClass()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='handler-class' namespace='http://java.sun.com/xml/ns/javaee'"

setHandlerClass

void setHandlerClass(FullyQualifiedClassType value)
Sets the value of the 'Handler Class' containment reference.

Parameters:
value - the new value of the 'Handler Class' containment reference.
See Also:
getHandlerClass()
Generated:

getInitParam

 getInitParam()
Returns the value of the 'Init Param' containment reference list. The list contents are of type ParamValueType.

If the meaning of the 'Init Param' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Init Param' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_InitParam()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='init-param' namespace='http://java.sun.com/xml/ns/javaee'"

getSoapHeader

 getSoapHeader()
Returns the value of the 'Soap Header' containment reference list. The list contents are of type XsdQNameType. Defines the QName of a SOAP header that will be processed by the handler.

Returns:
the value of the 'Soap Header' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_SoapHeader()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='soap-header' namespace='http://java.sun.com/xml/ns/javaee'"

getSoapRole

 getSoapRole()
Returns the value of the 'Soap Role' containment reference list. The list contents are of type String. The soap-role element contains a SOAP actor definition that the Handler will play as a role.

Returns:
the value of the 'Soap Role' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_SoapRole()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='soap-role' namespace='http://java.sun.com/xml/ns/javaee'"

getPortName

 getPortName()
Returns the value of the 'Port Name' containment reference list. The list contents are of type String. The port-name element defines the WSDL port-name that a handler should be associated with.

Returns:
the value of the 'Port Name' containment reference list.
See Also:
EjbJar30Package.getServiceRefHandlerType_PortName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='port-name' namespace='http://java.sun.com/xml/ns/javaee'"

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar30Package.getServiceRefHandlerType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: