javax.xml.rpc

Class ServiceFactory

java.lang.Object

javax.xml.rpc.ServiceFactory

public abstract class ServiceFactory
extends Object

The javax.xml.rpc.ServiceFactory is an abstract class that provides a factory for the creation of instances of the type javax.xml.rpc.Service. This abstract class follows the abstract static factory design pattern. This enables a J2SE based client to create a Service instance in a portable manner without using the constructor of the Service implementation class. The ServiceFactory implementation class is set using the javax.xml.rpc.ServiceFactory System property.

Version:

1.1

Author:

Scott.Stark@jboss.org, Thomas.Diesler@jboss.org

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICEFACTORY_PROPERTY A constant representing the property used to lookup the name of a ServiceFactory implementation class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceFactory()

Method Summary

Modifier and Type	Method and Description
abstract Service	createService(QName serviceName) Create a Service instance.
abstract Service	createService(URL wsdlDocumentLocation, QName serviceName) Create a Service instance.
abstract Service	loadService(Class serviceInterface) Create an instance of the generated service implementation class for a given service interface, if available.
abstract Service	loadService(URL wsdlDocumentLocation, Class serviceInterface, Properties props) Create an instance of the generated service implementation class for a given service interface, if available.
abstract Service	loadService(URL wsdlDocumentLocation, QName serviceName, Properties props) Create an instance of the generated service implementation class for a given service, if available.
static ServiceFactory	newInstance() Gets an instance of the ServiceFactory Only one copy of a factory exists and is returned to the application each time this method is called.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICEFACTORY_PROPERTY

public static final String SERVICEFACTORY_PROPERTY

A constant representing the property used to lookup the name of a ServiceFactory implementation class.

See Also:

Constant Field Values

Constructor Detail

ServiceFactory

protected ServiceFactory()

Method Detail

newInstance

public static ServiceFactory newInstance()
                                  throws ServiceException

Gets an instance of the ServiceFactory Only one copy of a factory exists and is returned to the application each time this method is called. The implementation class to be used can be overridden by setting the javax.xml.rpc.ServiceFactory system property.

Returns:

The ServiceFactory singleton

Throws:

ServiceException - on failure to instantiate the ServiceFactory impl

createService

public abstract Service createService(URL wsdlDocumentLocation,
                                      QName serviceName)
                               throws ServiceException

Create a Service instance.

Parameters:

wsdlDocumentLocation - URL for the WSDL document location

serviceName - QName for the service.

Returns:

Service.

Throws:

ServiceException - If any error in creation of the specified service

createService

public abstract Service createService(QName serviceName)
                               throws ServiceException

Create a Service instance.

Parameters:

serviceName - QName for the service

Returns:

Service.

Throws:

ServiceException - If any error in creation of the specified service

loadService

public abstract Service loadService(Class serviceInterface)
                             throws ServiceException

Create an instance of the generated service implementation class for a given service interface, if available.

Parameters:

serviceInterface - Service interface

Returns:

A Service

Throws:

ServiceException - If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located

loadService

public abstract Service loadService(URL wsdlDocumentLocation,
                                    Class serviceInterface,
                                    Properties props)
                             throws ServiceException

Create an instance of the generated service implementation class for a given service interface, if available. An implementation may use the provided wsdlDocumentLocation and properties to help locate the generated implementation class. If no such class is present, a ServiceException will be thrown.

Parameters:

wsdlDocumentLocation - URL for the WSDL document location for the service or null

serviceInterface - Service interface

props - A set of implementation-specific properties to help locate the generated service implementation class

Returns:

A Service

Throws:

ServiceException - If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located

loadService

public abstract Service loadService(URL wsdlDocumentLocation,
                                    QName serviceName,
                                    Properties props)
                             throws ServiceException

Create an instance of the generated service implementation class for a given service, if available. The service is uniquely identified by the wsdlDocumentLocation and serviceName arguments. An implementation may use the provided properties to help locate the generated implementation class. If no such class is present, a ServiceException will be thrown.

Parameters:

wsdlDocumentLocation - URL for the WSDL document location for the service or null

serviceName - Qualified name for the service

props - A set of implementation-specific properties to help locate the generated service implementation class

Returns:

A Service

Throws:

ServiceException - If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located