Top Description Fields Constructors Methods
javax.xml.rpc

public abstract Class ServiceFactory

extends Object
Class Inheritance
Imports
javax.xml.rpc.Service, .ServiceException, javax.xml.namespace.QName

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 system property SERVICEFACTORY_PROPERTY.

Authors
Rahul Sharma, Roberto Chinnici
Version
1.1
See Also
javax.xml.rpc.Service

Field Summary

Modifier and TypeField and Description
private static final String
DEFAULT_SERVICEFACTORY

A constant representing the name of the default ServiceFactory implementation class.

public static final String
SERVICEFACTORY_PROPERTY

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

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public abstract Service
createService(URL
URL for the WSDL document location for the service
wsdlDocumentLocation
,
QName
QName for the service
serviceName
)

Create a Service instance.

public abstract Service
createService(QName
QName for the service
serviceName
)

Create a Service instance.

public abstract Service
loadService(Class<T>
Service interface
serviceInterface
)

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

public abstract Service
loadService(URL
URL for the WSDL document location for the service or null
wsdlDocumentLocation
,
Class<T>
Service interface
serviceInterface
,
Properties
A set of implementation-specific properties to help locate the generated service implementation class
properties
)

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

public abstract Service
loadService(URL
URL for the WSDL document location for the service or null
wsdlDocumentLocation
,
QName
Qualified name for the service
serviceName
,
Properties
A set of implementation-specific properties to help locate the generated service implementation class
properties
)

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

public 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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_SERVICEFACTORYback to summary
private static final String DEFAULT_SERVICEFACTORY

A constant representing the name of the default ServiceFactory implementation class.

SERVICEFACTORY_PROPERTYback to summary
public static final String SERVICEFACTORY_PROPERTY

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

Constructor Detail

ServiceFactoryback to summary
protected ServiceFactory()

Method Detail

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

Create a Service instance.

Parameters
wsdlDocumentLocation:URL

URL for the WSDL document location for the service

serviceName:QName

QName for the service

Exceptions
ServiceException:
If any error in creation of the specified service
createServiceback to summary
public abstract Service createService(QName serviceName) throws ServiceException

Create a Service instance.

Parameters
serviceName:QName

QName for the service

Exceptions
ServiceException:
If any error in creation of the specified service
loadServiceback to summary
public abstract Service loadService(Class<T> serviceInterface) throws ServiceException

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

Parameters
serviceInterface:Class<T>

Service interface

Exceptions
ServiceException:
If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located
loadServiceback to summary
public abstract Service loadService(URL wsdlDocumentLocation, Class<T> serviceInterface, Properties properties) 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

URL for the WSDL document location for the service or null

serviceInterface:Class<T>

Service interface

properties:Properties

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

Exceptions
ServiceException:
If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located
loadServiceback to summary
public abstract Service loadService(URL wsdlDocumentLocation, QName serviceName, Properties properties) 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

URL for the WSDL document location for the service or null

serviceName:QName

Qualified name for the service

properties:Properties

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

Exceptions
ServiceException:
If there is any error while creating the specified service, including the case where a generated service implementation class cannot be located
newInstanceback to summary
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.