org.eclipse.jst.j2ee.webservice.wsclient
Interface Handler

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface Handler
extends CompatibilityDescriptionGroup

A representation of the model object 'Handler'. 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:
Webservice_clientPackage.getHandler()

Method Summary
 JavaClass getHandlerClass()
          Returns the value of the 'Handler Class' reference
 java.lang.String getHandlerName()
          Returns the value of the 'Handler Name' attribute
 org.eclipse.emf.common.util.EList getInitParams()
          Returns the value of the 'Init Params' containment reference list.
 org.eclipse.emf.common.util.EList getPortNames()
          Returns the value of the 'Port Names' attribute list.
 org.eclipse.emf.common.util.EList getSoapHeaders()
          Returns the value of the 'Soap Headers' containment reference list.
 org.eclipse.emf.common.util.EList getSoapRoles()
          Returns the value of the 'Soap Roles' attribute list.
 void setHandlerClass(JavaClass value)
          Sets the value of the 'Handler Class' reference
 void setHandlerName(java.lang.String value)
          Sets the value of the 'Handler Name' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getHandlerName

java.lang.String getHandlerName()
Returns the value of the 'Handler Name' attribute.

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

Defines the name of the handler. The name must be unique within the module.

Returns:
the value of the 'Handler Name' attribute.
See Also:
setHandlerName(String), Webservice_clientPackage.getHandler_HandlerName()

setHandlerName

void setHandlerName(java.lang.String value)
Sets the value of the 'Handler Name' attribute.

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

getSoapHeaders

org.eclipse.emf.common.util.EList getSoapHeaders()
Returns the value of the 'Soap Headers' containment reference list. The list contents are of type QName.

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

Returns:
the value of the 'Soap Headers' containment reference list.
See Also:
Webservice_clientPackage.getHandler_SoapHeaders()

getSoapRoles

org.eclipse.emf.common.util.EList getSoapRoles()
Returns the value of the 'Soap Roles' attribute list. The list contents are of type String.

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

The soap-role element contains a SOAP actor definition that the Handler will play as a role.

Returns:
the value of the 'Soap Roles' attribute list.
See Also:
Webservice_clientPackage.getHandler_SoapRoles()

getPortNames

org.eclipse.emf.common.util.EList getPortNames()
Returns the value of the 'Port Names' attribute list. The list contents are of type String.

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

The port-name element defines the WSDL port-name that a handler should be associated with.

Returns:
the value of the 'Port Names' attribute list.
See Also:
Webservice_clientPackage.getHandler_PortNames()

getHandlerClass

JavaClass getHandlerClass()
Returns the value of the 'Handler Class' reference.

If the meaning of the 'Handler Class' reference isn't clear, there really should be more of a description here...

Defines a fully qualified class name for the handler implementation.

Returns:
the value of the 'Handler Class' reference.
See Also:
setHandlerClass(JavaClass), Webservice_clientPackage.getHandler_HandlerClass()

setHandlerClass

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

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

getInitParams

org.eclipse.emf.common.util.EList getInitParams()
Returns the value of the 'Init Params' containment reference list. The list contents are of type ParamValue.

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

Returns:
the value of the 'Init Params' containment reference list.
See Also:
Webservice_clientPackage.getHandler_InitParams()