org.jboss.ws.core.jaxrpc.client

Class ServiceImpl

java.lang.Object

org.jboss.ws.core.jaxrpc.client.ServiceImpl

All Implemented Interfaces:

Externalizable, Serializable, javax.xml.rpc.Service, ServiceExt

public class ServiceImpl
extends Object
implements ServiceExt, Serializable, Externalizable

Service class acts as a factory for:

• Dynamic proxy for the target service endpoint.
• Instance of the type javax.xml.rpc.Call for the dynamic invocation of a remote operation on the target service endpoint.
• Instance of a generated stub class

Since:

10-Oct-2004

Author:

Thomas.Diesler@jboss.org

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceImpl()
ServiceImpl(QName serviceName) Construct a Service without WSDL meta data
ServiceImpl(QName serviceName, URL wsdlURL, JavaWsdlMapping mappingURL, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedServiceRefMetaData usrMetaData) Construct a Service that has access to some WSDL meta data
ServiceImpl(QName serviceName, URL wsdlURL, URL mappingURL, URL securityURL) Construct a Service that has access to some WSDL meta data

Method Summary

Methods

Modifier and Type	Method and Description
javax.xml.rpc.Call	createCall() Creates a Call object not associated with specific operation or target service endpoint.
javax.xml.rpc.Call	createCall(QName portName) Creates a Call instance.
javax.xml.rpc.Call	createCall(QName portName, QName opName) Creates a Call instance.
javax.xml.rpc.Call	createCall(QName portName, String operationName) Creates a Call instance.
javax.xml.rpc.Call[]	getCalls(QName portName) Gets an array of preconfigured Call objects for invoking operations on the specified port.
javax.xml.rpc.handler.HandlerRegistry	getDynamicHandlerRegistry() Get a HandlerRegistry that can be used to dynamically change the client side handler chain associated with a given endpoint.
javax.xml.rpc.handler.HandlerChain	getHandlerChain(QName portName) Get the handler chain for the given endpoint name, maybe null.
javax.xml.rpc.handler.HandlerRegistry	getHandlerRegistry() J2EE components should not use the getHandlerRegistry() method.
Remote	getPort(Class seiClass) The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
Remote	getPort(QName portName, Class seiClass) The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
Iterator	getPorts() Returns an Iterator for the list of QNames of service endpoints grouped by this service
ServiceMetaData	getServiceMetaData()
QName	getServiceName() Gets the name of this service.
javax.xml.rpc.encoding.TypeMappingRegistry	getTypeMappingRegistry() J2EE components should not use the getTypeMappingRegistry() method.
URL	getWSDLDocumentLocation() Gets the location of the WSDL document for this Service.
void	readExternal(ObjectInput in)
void	registerHandlerChain(QName portName, List infos, Set roles) Register a handler chain for the given endpoint name
void	setupHandlerChain(EndpointMetaData epMetaData)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceImpl

public ServiceImpl()

ServiceImpl

public ServiceImpl(QName serviceName)

Construct a Service without WSDL meta data

ServiceImpl

public ServiceImpl(QName serviceName,
           URL wsdlURL,
           URL mappingURL,
           URL securityURL)

Construct a Service that has access to some WSDL meta data

ServiceImpl

public ServiceImpl(QName serviceName,
           URL wsdlURL,
           JavaWsdlMapping mappingURL,
           org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedServiceRefMetaData usrMetaData)

Construct a Service that has access to some WSDL meta data

Method Detail

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

getServiceMetaData

public ServiceMetaData getServiceMetaData()

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Gets the location of the WSDL document for this Service.

Specified by:

getWSDLDocumentLocation in interface javax.xml.rpc.Service

Returns:

URL for the location of the WSDL document for this service

getServiceName

public QName getServiceName()

Gets the name of this service.

Specified by:

getServiceName in interface javax.xml.rpc.Service

Returns:

Qualified name of this service

createCall

public javax.xml.rpc.Call createCall(QName portName)
                              throws javax.xml.rpc.ServiceException

Creates a Call instance.

Specified by:

createCall in interface javax.xml.rpc.Service

Parameters:

portName - Qualified name for the target service endpoint

Returns:

Call instance

Throws:

javax.xml.rpc.ServiceException - If any error in the creation of the Call object

createCall

public javax.xml.rpc.Call createCall(QName portName,
                            String operationName)
                              throws javax.xml.rpc.ServiceException

Creates a Call instance.

Specified by:

createCall in interface javax.xml.rpc.Service

Parameters:

portName - Qualified name for the target service endpoint

operationName - Name of the operation for which this Call object is to be created.

Returns:

Call instance

Throws:

javax.xml.rpc.ServiceException - If any error in the creation of the Call object

createCall

public javax.xml.rpc.Call createCall(QName portName,
                            QName opName)
                              throws javax.xml.rpc.ServiceException

Creates a Call instance.

Specified by:

createCall in interface javax.xml.rpc.Service

Parameters:

portName - Qualified name for the target service endpoint

opName - Qualified name of the operation for which this Call object is to be created.

Returns:

Call instance

Throws:

javax.xml.rpc.ServiceException - If any error in the creation of the Call object

createCall

public javax.xml.rpc.Call createCall()
                              throws javax.xml.rpc.ServiceException

Creates a Call object not associated with specific operation or target service endpoint. This Call object needs to be configured using the setter methods on the Call interface.

Specified by:

createCall in interface javax.xml.rpc.Service

Returns:

Call object

Throws:

javax.xml.rpc.ServiceException - If any error in the creation of the Call object

getCalls

public javax.xml.rpc.Call[] getCalls(QName portName)
                              throws javax.xml.rpc.ServiceException

Gets an array of preconfigured Call objects for invoking operations on the specified port. There is one Call object per operation that can be invoked on the specified port. Each Call object is pre-configured and does not need to be configured using the setter methods on Call interface.

Each invocation of the getCalls method returns a new array of preconfigured Call objects

This method requires the Service implementation class to have access to the WSDL related metadata.

Specified by:

getCalls in interface javax.xml.rpc.Service

Parameters:

portName - Qualified name for the target service endpoint

Returns:

Call[] Array of pre-configured Call objects

Throws:

javax.xml.rpc.ServiceException - If this Service class does not have access to the required WSDL metadata or if an illegal endpointName is specified.

getHandlerRegistry

public javax.xml.rpc.handler.HandlerRegistry getHandlerRegistry()

J2EE components should not use the getHandlerRegistry() method. A container provider must throw a java.lang.UnsupportedOperationException from the getHandlerRegistry() method of the Service Interface. Handler support is documented in Chapter 6 Handlers.

Specified by:

getHandlerRegistry in interface javax.xml.rpc.Service

getDynamicHandlerRegistry

public javax.xml.rpc.handler.HandlerRegistry getDynamicHandlerRegistry()

Get a HandlerRegistry that can be used to dynamically change the client side handler chain associated with a given endpoint.

Specified by:

getDynamicHandlerRegistry in interface ServiceExt

getTypeMappingRegistry

public javax.xml.rpc.encoding.TypeMappingRegistry getTypeMappingRegistry()

J2EE components should not use the getTypeMappingRegistry() method. A container provider must throw a java.lang.UnsupportedOperationException from the getTypeMappingRegistry() method of the Service Interface.

Specified by:

getTypeMappingRegistry in interface javax.xml.rpc.Service

getPorts

public Iterator getPorts()
                  throws javax.xml.rpc.ServiceException

Returns an Iterator for the list of QNames of service endpoints grouped by this service

Specified by:

getPorts in interface javax.xml.rpc.Service

Returns:

Returns java.util.Iterator with elements of type javax.xml.namespace.QName

Throws:

javax.xml.rpc.ServiceException - If this Service class does not have access to the required WSDL metadata

getPort

public Remote getPort(Class seiClass)
               throws javax.xml.rpc.ServiceException

The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned stub or proxy. In the implementation of this method, the JAX-RPC runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the stub accordingly. The returned Stub instance should not be reconfigured by the client.

Specified by:

getPort in interface javax.xml.rpc.Service

Throws:

javax.xml.rpc.ServiceException

getPort

public Remote getPort(QName portName,
             Class seiClass)
               throws javax.xml.rpc.ServiceException

The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy. A service client uses this dynamic proxy to invoke operations on the target service endpoint. The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy or stub instance.

Specified by:

getPort in interface javax.xml.rpc.Service

Throws:

javax.xml.rpc.ServiceException

getHandlerChain

public javax.xml.rpc.handler.HandlerChain getHandlerChain(QName portName)

Get the handler chain for the given endpoint name, maybe null.

registerHandlerChain

public void registerHandlerChain(QName portName,
                        List infos,
                        Set roles)

Register a handler chain for the given endpoint name

setupHandlerChain

public void setupHandlerChain(EndpointMetaData epMetaData)