org.eclipse.modisco.jee.webapp.webapp24
Interface ServiceRefType


public interface ServiceRefType

A representation of the model object 'Service Ref Type'. The service-ref element declares a reference to a Web service. It contains optional description, display name and icons, a declaration of the required Service interface, an optional WSDL document location, an optional set of JAX-RPC mappings, an optional QName for the service element, an optional set of Service Endpoint Interfaces to be resolved by the container to a WSDL port, and an optional set of handlers.

The following features are supported:

See Also:
Webapp24Package.getServiceRefType()
Generated:
Model:
extendedMetaData="name='service-refType' 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.
  getHandler()
          Returns the value of the 'Handler' containment reference list.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 PathType getJaxrpcMappingFile()
          Returns the value of the 'Jaxrpc Mapping File' containment reference.
  getPortComponentRef()
          Returns the value of the 'Port Component Ref' containment reference list.
 FullyQualifiedClassType getServiceInterface()
          Returns the value of the 'Service Interface' containment reference.
 XsdQNameType getServiceQname()
          Returns the value of the 'Service Qname' containment reference.
 JndiNameType getServiceRefName()
          Returns the value of the 'Service Ref Name' containment reference.
 XsdAnyURIType getWsdlFile()
          Returns the value of the 'Wsdl File' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setJaxrpcMappingFile(PathType value)
          Sets the value of the 'Jaxrpc Mapping File' containment reference.
 void setServiceInterface(FullyQualifiedClassType value)
          Sets the value of the 'Service Interface' containment reference.
 void setServiceQname(XsdQNameType value)
          Sets the value of the 'Service Qname' containment reference.
 void setServiceRefName(JndiNameType value)
          Sets the value of the 'Service Ref Name' containment reference.
 void setWsdlFile(XsdAnyURIType value)
          Sets the value of the 'Wsdl File' containment reference.
 

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:
Webapp24Package.getServiceRefType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/j2ee'"

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:
Webapp24Package.getServiceRefType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='display-name' namespace='http://java.sun.com/xml/ns/j2ee'"

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:
Webapp24Package.getServiceRefType_Icon()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='icon' namespace='http://java.sun.com/xml/ns/j2ee'"

getServiceRefName

JndiNameType getServiceRefName()
Returns the value of the 'Service Ref Name' containment reference. The service-ref-name element declares logical name that the components in the module use to look up the Web service. It is recommended that all service reference names start with "service/".

Returns:
the value of the 'Service Ref Name' containment reference.
See Also:
setServiceRefName(JndiNameType), Webapp24Package.getServiceRefType_ServiceRefName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='service-ref-name' namespace='http://java.sun.com/xml/ns/j2ee'"

setServiceRefName

void setServiceRefName(JndiNameType value)
Sets the value of the 'Service Ref Name' containment reference.

Parameters:
value - the new value of the 'Service Ref Name' containment reference.
See Also:
getServiceRefName()
Generated:

getServiceInterface

FullyQualifiedClassType getServiceInterface()
Returns the value of the 'Service Interface' containment reference. The service-interface element declares the fully qualified class name of the JAX-RPC Service interface the client depends on. In most cases the value will be javax.xml.rpc.Service. A JAX-RPC generated Service Interface class may also be specified.

Returns:
the value of the 'Service Interface' containment reference.
See Also:
setServiceInterface(FullyQualifiedClassType), Webapp24Package.getServiceRefType_ServiceInterface()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='service-interface' namespace='http://java.sun.com/xml/ns/j2ee'"

setServiceInterface

void setServiceInterface(FullyQualifiedClassType value)
Sets the value of the 'Service Interface' containment reference.

Parameters:
value - the new value of the 'Service Interface' containment reference.
See Also:
getServiceInterface()
Generated:

getWsdlFile

XsdAnyURIType getWsdlFile()
Returns the value of the 'Wsdl File' containment reference. The wsdl-file element contains the URI location of a WSDL file. The location is relative to the root of the module.

Returns:
the value of the 'Wsdl File' containment reference.
See Also:
setWsdlFile(XsdAnyURIType), Webapp24Package.getServiceRefType_WsdlFile()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='wsdl-file' namespace='http://java.sun.com/xml/ns/j2ee'"

setWsdlFile

void setWsdlFile(XsdAnyURIType value)
Sets the value of the 'Wsdl File' containment reference.

Parameters:
value - the new value of the 'Wsdl File' containment reference.
See Also:
getWsdlFile()
Generated:

getJaxrpcMappingFile

PathType getJaxrpcMappingFile()
Returns the value of the 'Jaxrpc Mapping File' containment reference. The jaxrpc-mapping-file element contains the name of a file that describes the JAX-RPC mapping between the Java interaces used by the application and the WSDL description in the wsdl-file. The file name is a relative path within the module file.

Returns:
the value of the 'Jaxrpc Mapping File' containment reference.
See Also:
setJaxrpcMappingFile(PathType), Webapp24Package.getServiceRefType_JaxrpcMappingFile()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='jaxrpc-mapping-file' namespace='http://java.sun.com/xml/ns/j2ee'"

setJaxrpcMappingFile

void setJaxrpcMappingFile(PathType value)
Sets the value of the 'Jaxrpc Mapping File' containment reference.

Parameters:
value - the new value of the 'Jaxrpc Mapping File' containment reference.
See Also:
getJaxrpcMappingFile()
Generated:

getServiceQname

XsdQNameType getServiceQname()
Returns the value of the 'Service Qname' containment reference. The service-qname element declares the specific WSDL service element that is being refered to. It is not specified if no wsdl-file is declared.

Returns:
the value of the 'Service Qname' containment reference.
See Also:
setServiceQname(XsdQNameType), Webapp24Package.getServiceRefType_ServiceQname()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='service-qname' namespace='http://java.sun.com/xml/ns/j2ee'"

setServiceQname

void setServiceQname(XsdQNameType value)
Sets the value of the 'Service Qname' containment reference.

Parameters:
value - the new value of the 'Service Qname' containment reference.
See Also:
getServiceQname()
Generated:

getPortComponentRef

 getPortComponentRef()
Returns the value of the 'Port Component Ref' containment reference list. The list contents are of type PortComponentRefType. The port-component-ref element declares a client dependency on the container for resolving a Service Endpoint Interface to a WSDL port. It optionally associates the Service Endpoint Interface with a particular port-component. This is only used by the container for a Service.getPort(Class) method call.

Returns:
the value of the 'Port Component Ref' containment reference list.
See Also:
Webapp24Package.getServiceRefType_PortComponentRef()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='port-component-ref' namespace='http://java.sun.com/xml/ns/j2ee'"

getHandler

 getHandler()
Returns the value of the 'Handler' containment reference list. The list contents are of type ServiceRefHandlerType. 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.

Returns:
the value of the 'Handler' containment reference list.
See Also:
Webapp24Package.getServiceRefType_Handler()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='handler' namespace='http://java.sun.com/xml/ns/j2ee'"

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), Webapp24Package.getServiceRefType_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: