javax.xml.rpc.ServiceFactory Maven / Gradle / Ivy
Show all versions of jakarta.xml.rpc-api Show documentation
/*
* Copyright (c) 2003, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.xml.rpc;
import javax.xml.rpc.Service;
import javax.xml.rpc.ServiceException;
import 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.
*
*
* @version 1.1
* @author Rahul Sharma
* @author Roberto Chinnici
* @see javax.xml.rpc.Service
**/
public abstract class ServiceFactory {
/**
* A constant representing the property used to lookup the
* name of a ServiceFactory implementation
* class.
*/
static public final String SERVICEFACTORY_PROPERTY
= "javax.xml.rpc.ServiceFactory";
/**
* A constant representing the name of the default
* ServiceFactory implementation class.
**/
static private final String DEFAULT_SERVICEFACTORY
= "com.sun.xml.rpc.client.ServiceFactoryImpl";
protected ServiceFactory () {}
/** 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.
* @return the ServiceFactory
* @throws javax.xml.rpc.ServiceException if a ServiceFactory could
* not be created
**/
public static ServiceFactory newInstance() throws ServiceException {
try {
return (ServiceFactory)
FactoryFinder.find(SERVICEFACTORY_PROPERTY,
DEFAULT_SERVICEFACTORY);
} catch (ServiceException ex) {
throw ex;
} catch (Exception ex) {
throw new ServiceException("Unable to create Service Factory: "+
ex.getMessage());
}
}
/** Create a Service instance.
*
* @param wsdlDocumentLocation URL for the WSDL document location
* for the service
* @param serviceName QName for the service
* @return the new service
* @throws ServiceException If any error in creation of the
* specified service
**/
public abstract Service createService(
java.net.URL wsdlDocumentLocation,
QName serviceName)
throws ServiceException;
/** Create a Service instance.
*
* @param serviceName QName for the service
* @return the new service
* @throws ServiceException If any error in creation of the
* specified service
**/
public abstract Service createService(
QName serviceName)
throws ServiceException;
/**
* Create an instance of the generated service implementation class
* for a given service interface, if available.
*
* @param serviceInterface Service interface
* @return the new 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
**/
public abstract Service loadService(
Class serviceInterface)
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.
*
* @param wsdlDocumentLocation URL for the WSDL document location
* for the service or null
* @param serviceInterface Service interface
* @param properties A set of implementation-specific properties
* to help locate the generated service
* implementation class
* @return the new 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
**/
public abstract Service loadService(
java.net.URL wsdlDocumentLocation,
Class serviceInterface,
java.util.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.
*
* @param wsdlDocumentLocation URL for the WSDL document location
* for the service or null
* @param serviceName Qualified name for the service
* @param properties A set of implementation-specific properties
* to help locate the generated service
* implementation class
* @return the new 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
**/
public abstract Service loadService(
java.net.URL wsdlDocumentLocation,
QName serviceName,
java.util.Properties properties)
throws ServiceException;
}