JTR 5.0 API Documentation

jtr.config.ws
Class WebServiceService

java.lang.Object
  extended by jtr.config.ws.WebServiceService
All Implemented Interfaces:
java.io.Serializable

public class WebServiceService
extends java.lang.Object
implements java.io.Serializable

This class is the object oriented representation of a service element of a jtr.xml configuration file.
It can be assimilated to the concept of WSDL service. As such it hosts information like ports and port types, and is uniquely identified by a QName.
Moreover a service definition might include type mapping information too. A type mapping states which Java class should be used to represent an XML data type. These classes are used to marshall and unmarshall messages at runtime.

Since:
3.0
Version:
5.0
Author:
Francesco Russo (frusso@dev.java.net)
See Also:
Serialized Form

Constructor Summary
WebServiceService()
          Default constructor.
 
Method Summary
 void addPort(WebServicePort port)
          Add a single port to the set of configured ones.
 void addPortType(WebServicePortType pt)
          Add a single port type the the set of configured ones.
 void addTypeMapping(javax.xml.namespace.QName qName, java.lang.String javaClassName)
          Add a single type mapping to the current service specification.
 void addTypeMapping(javax.xml.namespace.QName qualifiedName, WebServiceTypeMapping tm)
          Add a single type mapping to the current service specification.
 void addTypeMapping(java.lang.String nameSpace, java.lang.String name, java.lang.String javaClassName)
          Add a single type mapping to the current service specification.
 void addTypeMapping(WebServiceTypeMapping typeMapping)
          Add a single type mapping to the current service specification.
 java.lang.String getName()
          Get the unique name.
 java.lang.String getNameSpace()
          Get the service namespace.
 WebServicePort getPort(java.lang.String name)
          Get the port identified by the given name or null if nothing can be found.
 java.util.Collection<WebServicePort> getPorts()
          Get the collection of configured ports.
 WebServicePortType getPortType(javax.xml.namespace.QName qName)
          Get the port type identified by the given QName or null if nothing can be found.
 java.util.Collection<WebServicePortType> getPortTypes()
          Get the configured port types.
 WebServiceTypeMapping getTypeMapping(javax.xml.namespace.QName qName)
          Get the type mapping identified by the given QName or null if nothing can be found.
 java.util.Collection<WebServiceTypeMapping> getTypeMappings()
          Get the collection of type mappings available for the current service specification.
 void setName(java.lang.String name)
          Set the service name.
 void setNameSpace(java.lang.String nameSpace)
          Set the service namespace.
 void setPorts(java.util.Collection<WebServicePort> ports)
          Set the collection of available ports.
 void setPortTypes(java.util.Collection<WebServicePortType> portTypes)
          Set the collection of port types.
 void setTypeMappings(java.util.Collection<WebServiceTypeMapping> typeMappings)
          Set the type mappings for the current service specification.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebServiceService

public WebServiceService()
Default constructor.

Method Detail

getPortTypes

public java.util.Collection<WebServicePortType> getPortTypes()
Get the configured port types.

Returns:
Collection

getName

public java.lang.String getName()
Get the unique name.

Returns:
String

setNameSpace

public void setNameSpace(java.lang.String nameSpace)
Set the service namespace.

Parameters:
nameSpace -

setPortTypes

public void setPortTypes(java.util.Collection<WebServicePortType> portTypes)
Set the collection of port types.

Parameters:
portTypes -

setName

public void setName(java.lang.String name)
Set the service name.

Parameters:
name -

setPorts

public void setPorts(java.util.Collection<WebServicePort> ports)
Set the collection of available ports.

Parameters:
ports -

getNameSpace

public java.lang.String getNameSpace()
Get the service namespace.

Returns:
String

getPorts

public java.util.Collection<WebServicePort> getPorts()
Get the collection of configured ports.

Returns:
Collection

addPortType

public void addPortType(WebServicePortType pt)
Add a single port type the the set of configured ones.

Parameters:
pt -

addPort

public void addPort(WebServicePort port)
Add a single port to the set of configured ones.

Parameters:
port -

getTypeMappings

public java.util.Collection<WebServiceTypeMapping> getTypeMappings()
Get the collection of type mappings available for the current service specification.

Returns:
Returns the typeMappings.

setTypeMappings

public void setTypeMappings(java.util.Collection<WebServiceTypeMapping> typeMappings)
Set the type mappings for the current service specification.

Parameters:
typeMappings - The typeMappings to set.

addTypeMapping

public void addTypeMapping(javax.xml.namespace.QName qualifiedName,
                           WebServiceTypeMapping tm)
Add a single type mapping to the current service specification.

Parameters:
qualifiedName -
tm -

addTypeMapping

public void addTypeMapping(java.lang.String nameSpace,
                           java.lang.String name,
                           java.lang.String javaClassName)
Add a single type mapping to the current service specification.

Parameters:
nameSpace -
name -
javaClassName -

addTypeMapping

public void addTypeMapping(javax.xml.namespace.QName qName,
                           java.lang.String javaClassName)
Add a single type mapping to the current service specification.

Parameters:
qName -
javaClassName -

addTypeMapping

public void addTypeMapping(WebServiceTypeMapping typeMapping)
Add a single type mapping to the current service specification.

Parameters:
typeMapping -

getPortType

public WebServicePortType getPortType(javax.xml.namespace.QName qName)
Get the port type identified by the given QName or null if nothing can be found.

Parameters:
qName -
Returns:
WebServicePortType

getPort

public WebServicePort getPort(java.lang.String name)
Get the port identified by the given name or null if nothing can be found.

Parameters:
name -
Returns:
WebServicePort

getTypeMapping

public WebServiceTypeMapping getTypeMapping(javax.xml.namespace.QName qName)
Get the type mapping identified by the given QName or null if nothing can be found.

Parameters:
qName -
Returns:
WebServiceTypeMapping

The JTR Project is licensed under GPL version 2