javax.xml.registry.ConnectionFactory Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package javax.xml.registry;
import java.util.*;
import java.io.*;
/**
* This is the abstract base class for factory classes for creating a JAXR connection.
* A JAXR ConnectionFactory object is configured in a provider-specific way to create connections with registry providers.
*
* Looking Up a ConnectionFactory Using the JNDI API
* The preferred way for a client to look up a JAXR ConnectionFactory is within the Java Naming and Directory InterfaceTM (JNDI) API.
* A ConnectionFactory object is registered with a naming service in a provider specific way, such as one based on the JNDI API. This registration associates the ConnectionFactory object with a logical name. When an application wants to establish a connection with the provider associated with that ConnectionFactory object, it does a lookup, providing the logical name. The application can then use the ConnectionFactory object that is returned to create a connection to the messaging provider.
*
* Looking Up a ConnectionFactory Without Using the JNDI API
* The JAXR API provides an alternative way to look up a JAXR ConnectionFactory that does not require the use of the JNDI API. This is done using the newInstance static method on the abstract class ConnectionFactory provided in the JAXR API. The newInstance method returns a JAXR ConnectionFactory. The client may indicate which factory class should be instantiated by the newInstance method by defining the system property javax.xml.registry.ConnectionFactoryClass.
* If this property is not set, the JAXR provider must return a default ConnectionFactory instance.
*
*
* @see Connection
* @author Farrukh S. Najmi
*/
public abstract class ConnectionFactory {
/**
* Sets the Properties used during createConnection
* and createFederatedConnection calls.
*
*
* -
* Standard Connection Properties:
*
javax.xml.registry.queryManagerURL - URL String for the query manager service within the target registry provider
* javax.xml.registry.lifeCycleManagerURL - URL String for the life cycle manager service within the target registry provider. If unspecified, must default to value of the queryManagerURL described above
* javax.xml.registry.semanticEquivalences - String that allows specification of semantic equivalences
* javax.xml.registry.security.authenticationMethod - string that provides a hint to the JAXR provider on the authentication method to be used when authenticating with the registry provider. Possible value include but are not limited to "UDDI_GET_AUTHTOKEN", "HTTP_BASIC", "CLIENT_CERTIFICATE", "MS_PASSPORT"
* javax.xml.registry.uddi.maxRows - integer that specifies the maximum number of rows to be returned for find operations. This property is specific for UDDI providers
* javax.xml.registry.postalAddressScheme - String that specifies the id of a ClassificationScheme that is used as the default postal address scheme for this connection
*
* - Capability Level: 0
*
* @param properties configuration properties that are either
* specified by JAXR specification or are provider specific.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public abstract void setProperties(Properties properties) throws JAXRException;
/**
* Gets the Properties used during createConnection
* and createFederatedConnection calls.
*
* - Capability Level: 0
*
* @return the Properties defined for this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public abstract Properties getProperties() throws JAXRException;
/**
* Create a named connection. Such a connection can be used to
* communicate with a JAXR provider.
*
* - Capability Level: 0
*
* @return the Connection created by this call
* @throws JAXRException If the JAXR provider encounters an internal error
*
* @link dependency
* @label creates
* @associates <{Connection}>
*/
public abstract Connection createConnection() throws JAXRException;
/**
* Create a FederatedConnection.
*
* - Capability Level: 0 (optional)
*
* @param connections Is a Collection of Connection objects. Note that
* Connection objects may also be FederatedConnection objects.
* @return the FederatedConnection created by this call
* @throws JAXRException If the JAXR provider encounters an internal error
*
*
* @link dependency
* @label creates
* @associates <{Federation}>
*/
public abstract FederatedConnection createFederatedConnection(Collection connections) throws JAXRException;
/**
* Creates a default ConnectionFactory object.
*
* @return a new instance of a ConnectionFactory
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public static ConnectionFactory newInstance() throws JAXRException {
try {
return (ConnectionFactory)
find(CONNECTION_FACTORY_CLASS, DEFAULT_CONNECTION_FACTORY);
} catch (Exception ex) {
throw new JAXRException("Unable to create "+
"ConnectionFactory: "
+ex.getMessage());
}
}
private static Object newInstance(String className,
ClassLoader classLoader)
throws JAXRException {
try {
Class spiClass;
if (classLoader == null) {
spiClass = Class.forName(className);
} else {
spiClass = classLoader.loadClass(className);
}
return spiClass.newInstance();
} catch (ClassNotFoundException x) {
throw new JAXRException(
"Provider " + className + " not found", x);
} catch (Exception x) {
throw new JAXRException(
"Provider " + className + " could not be instantiated: " + x,
x);
}
}
/**
* Finds the implementation Class object for the given
* factory name, or if that fails, finds the Class object
* for the given fallback class name. The arguments supplied must be
* used in order. If using the first argument is successful, the second
* one will not be used.
*
* This method is package private so that this code can be shared.
*
* @return the Class object of the specified message factory;
* may not be null
*
* @param factoryId the name of the factory to find, which is
* a system property
* @param fallbackClassName the implementation class name, which is
* to be used only if nothing else
* is found; null to indicate that
* there is no fallback class name
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
static Object find(String factoryId, String fallbackClassName)
throws JAXRException {
ClassLoader classLoader;
try {
classLoader = Thread.currentThread().getContextClassLoader();
} catch (Exception x) {
throw new JAXRException(x.toString(), x);
}
// Use the system property first
try {
String systemProp =
System.getProperty( factoryId );
if( systemProp!=null) {
return newInstance(systemProp, classLoader);
}
} catch (SecurityException se) {
}
// try to read from $java.home/lib/jaxr.properties
try {
String javah=System.getProperty( "java.home" );
String configFile = javah + File.separator +
"lib" + File.separator + "jaxr.properties";
File f=new File( configFile );
if( f.exists()) {
Properties props=new Properties();
props.load( new FileInputStream(f));
String factoryClassName = props.getProperty(factoryId);
return newInstance(factoryClassName, classLoader);
}
} catch(Exception ex ) {
}
String serviceId = "META-INF/services/" + factoryId;
// try to find services in CLASSPATH
try {
InputStream is=null;
if (classLoader == null) {
is=ClassLoader.getSystemResourceAsStream(serviceId);
} else {
is=classLoader.getResourceAsStream(serviceId);
}
if( is!=null ) {
BufferedReader rd =
new BufferedReader(new InputStreamReader(is, "UTF-8"));
String factoryClassName = rd.readLine();
rd.close();
if (factoryClassName != null &&
! "".equals(factoryClassName)) {
return newInstance(factoryClassName, classLoader);
}
}
} catch( Exception ex ) {
}
if (fallbackClassName == null) {
throw new JAXRException(
"Provider for " + factoryId + " cannot be found", null);
}
return newInstance(fallbackClassName, classLoader);
}
static private final String CONNECTION_FACTORY_CLASS
= "javax.xml.registry.ConnectionFactoryClass";
static private final String DEFAULT_CONNECTION_FACTORY
= "com.sun.xml.registry.common.ConnectionFactoryImpl";
/** @link dependency
* @label creates
*/
/*#FederatedConnection lnkFederatedConnection;*/
}