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

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface ServiceRef
extends CompatibilityDescriptionGroup

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

Method Summary
 EList getHandlers()
          Returns the value of the 'Handlers' containment reference list.
 java.lang.String getJaxrpcMappingFile()
          Returns the value of the 'Jaxrpc Mapping File' attribute
 EList getPortComponentRefs()
          Returns the value of the 'Port Component Refs' containment reference list.
 JavaClass getServiceInterface()
          Returns the value of the 'Service Interface' reference
 QName getServiceQname()
          Returns the value of the 'Service Qname' containment reference
 java.lang.String getServiceRefName()
          Returns the value of the 'Service Ref Name' attribute
 java.lang.String getWsdlFile()
          Returns the value of the 'Wsdl File' attribute
 void setJaxrpcMappingFile(java.lang.String value)
          Sets the value of the 'Jaxrpc Mapping File' attribute
 void setServiceInterface(JavaClass value)
          Sets the value of the 'Service Interface' reference
 void setServiceQname(QName value)
          Sets the value of the 'Service Qname' containment reference
 void setServiceRefName(java.lang.String value)
          Sets the value of the 'Service Ref Name' attribute
 void setWsdlFile(java.lang.String value)
          Sets the value of the 'Wsdl File' 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
 

Method Detail

getServiceRefName

public java.lang.String getServiceRefName()
Returns the value of the 'Service Ref Name' attribute.

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

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' attribute.
See Also:
setServiceRefName(String), Webservice_clientPackage.getServiceRef_ServiceRefName()

setServiceRefName

public void setServiceRefName(java.lang.String value)
Sets the value of the 'Service Ref Name' attribute.

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

getWsdlFile

public java.lang.String getWsdlFile()
Returns the value of the 'Wsdl File' attribute.

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

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' attribute.
See Also:
setWsdlFile(String), Webservice_clientPackage.getServiceRef_WsdlFile()

setWsdlFile

public void setWsdlFile(java.lang.String value)
Sets the value of the 'Wsdl File' attribute.

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

getJaxrpcMappingFile

public java.lang.String getJaxrpcMappingFile()
Returns the value of the 'Jaxrpc Mapping File' attribute.

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

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' attribute.
See Also:
setJaxrpcMappingFile(String), Webservice_clientPackage.getServiceRef_JaxrpcMappingFile()

setJaxrpcMappingFile

public void setJaxrpcMappingFile(java.lang.String value)
Sets the value of the 'Jaxrpc Mapping File' attribute.

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

getServiceInterface

public JavaClass getServiceInterface()
Returns the value of the 'Service Interface' reference.

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

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' reference.
See Also:
setServiceInterface(JavaClass), Webservice_clientPackage.getServiceRef_ServiceInterface()

setServiceInterface

public void setServiceInterface(JavaClass value)
Sets the value of the 'Service Interface' reference.

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

getPortComponentRefs

public EList getPortComponentRefs()
Returns the value of the 'Port Component Refs' containment reference list. The list contents are of type PortComponentRef.

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

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 Refs' containment reference list.
See Also:
Webservice_clientPackage.getServiceRef_PortComponentRefs()

getHandlers

public EList getHandlers()
Returns the value of the 'Handlers' containment reference list. The list contents are of type Handler.

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

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 'Handlers' containment reference list.
See Also:
Webservice_clientPackage.getServiceRef_Handlers()

getServiceQname

public QName getServiceQname()
Returns the value of the 'Service Qname' containment reference.

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

Returns:
the value of the 'Service Qname' containment reference.
See Also:
setServiceQname(QName), Webservice_clientPackage.getServiceRef_ServiceQname()

setServiceQname

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

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