/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.resource.spi;
import javax.resource.ResourceException;
/** The ManagedConnectionMetaData interface provides information about the
* underlying EIS instance associated with a ManagedConnection instance.
* An application server uses this information to get runtime information
* about a connected EIS instance.
*
* <p>The method ManagedConnection.getMetaData returns a
* ManagedConnectionMetaData instance.
*
* @version 0.8
* @author Rahul Sharma
* @see javax.resource.spi.ManagedConnection
**/
public interface ManagedConnectionMetaData {
/** Returns Product name of the underlying EIS instance connected
* through the ManagedConnection.
*
* @return Product name of the EIS instance.
**/
public
String getEISProductName() throws ResourceException;
/** Returns product version of the underlying EIS instance connected
* through the ManagedConnection.
*
* @return Product version of the EIS instance
**/
public
String getEISProductVersion() throws ResourceException;
/** Returns maximum limit on number of active concurrent connections
* that an EIS instance can support across client processes. If an EIS
* instance does not know about (or does not have) any such limit, it
* returns a 0.
*
* @return Maximum limit for number of active concurrent connections
**/
public
int getMaxConnections() throws ResourceException;
/** Returns name of the user associated with the ManagedConnection
* instance. The name corresponds to the resource principal under whose
* whose security context, a connection to the EIS instance has been
* established.
*
* @return name of the user
**/
public
String getUserName() throws ResourceException;
}