org.apache.cxf.connector.CXFConnectionFactory Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.connector;
import javax.resource.ResourceException;
/**
* Provides methods to create a {@link Connection} object that represents a Web
* service defined from the supplied parameters. This interface is returned from
* an environment naming context lookup by a J2EE component.
*/
public interface CXFConnectionFactory {
/**
* Creates a client proxy based on the connection parameter object.
* @param param,
* @return A proxy object that implements both the given iface
* and the {@link Connection} interface. It represents the Web
* service associated with the specified service.
* @throws ResourceException
*/
Object getConnection(CXFConnectionParam param) throws ResourceException;
/**
* Returns the underlying {@link Bus} for this connection factory. In some
* J2EE environments, for example Weblogic, the {@link Bus} and dependent
* classes are not available to the J2EE application. In this case the CXF
* runtime jar:
* cxf-install-dir/cxf/lib/cxf-rt-version.jar should
* be added to the classpath of the application server. Once, the
* {@link Bus} class is available on the system classpath, then the returned
* object may be cast to {@link Bus}. In other environments, this cast
* should be safe without having to modify the classpath
* org.apache.cxf.Bus = (org.apache.cxf.Bus)connectionFactory.getBus();
*
*
* @return the connection factory&s {@link Bus}
*/
Object getBus();
}