BaseConnectionManager2MBean


1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
4    * by the @authors tag. See the copyright.txt in the distribution for a
5    * full listing of individual contributors.
6    *
7    * This is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as
9    * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22  package org.jboss.resource.connectionmanager;
23  
24  import javax.management.ObjectName  ;
25  import javax.resource.spi.ManagedConnectionFactory  ;
26  
27  import org.jboss.mx.util.ObjectNameFactory;
28  import org.jboss.system.ServiceMBean;
29  
30  /**
31   * MBean interface.
32   * 
33   * @author <a HREF="mailto:adrian@jboss.com">Adrian Brock</a>
34   * @version $Revision: 38338 $
35   */
36  public interface BaseConnectionManager2MBean extends ServiceMBean
37  {
38     public static final ObjectName   OBJECT_NAME = ObjectNameFactory.create("jboss.jca:service=BaseConnectionManager");
39  
40     /**
41      * The JndiName attribute holds the jndi name the ConnectionFactory will be bound under in jndi. Note that an entry of the form DefaultDS2 will be bound to java:/DefaultDS2.
42      * 
43      * @return the JndiName value.
44      */
45     String   getJndiName();
46  
47     /**
48      * Set the JndiName value.
49      * 
50      * @param jndiName The JndiName value.
51      */
52     void setJndiName(String   jndiName);
53  
54     /**
55      * The ManagedConnectionPool holds the ObjectName of the mbean representing the pool for this connection manager. Normally it will be an embedded mbean in a depends tag rather than an ObjectName reference to the mbean.
56      * 
57      * @return the ManagedConnectionPool value.
58      */
59     ObjectName   getManagedConnectionPool();
60  
61     /**
62      * Set the ManagedConnectionPool value.
63      * 
64      * @param newManagedConnectionPool The new ManagedConnectionPool value.
65      */
66     void setManagedConnectionPool(ObjectName   newManagedConnectionPool);
67  
68     /**
69      * The CachecConnectionManager holds the ObjectName of the CachedConnectionManager mbean used by this ConnectionManager. Normally this will be a depends tag with the ObjectName of the unique CachedConnectionManager for the server.
70      * 
71      * @param ccmName an <code>ObjectName</code> value
72      */
73     void setCachedConnectionManager(ObjectName   ccmName);
74  
75     /**
76      * Describe <code>getCachedConnectionManager</code> method here.
77      * 
78      * @return an <code>ObjectName</code> value
79      */
80     ObjectName   getCachedConnectionManager();
81  
82     /**
83      * The SecurityDomainJndiName holds the jndi name of the security domain configured for the ManagedConnectionFactory this ConnectionManager manages. It is normally of the form java:/jaas/firebirdRealm, where firebirdRealm is the name found in auth.conf or equivalent file.
84      * 
85      * @param securityDomainJndiName an <code>String</code> value
86      */
87     void setSecurityDomainJndiName(String   securityDomainJndiName);
88  
89     /**
90      * Get the SecurityDomainJndiName value.
91      * 
92      * @return the SecurityDomainJndiName value.
93      */
94     String   getSecurityDomainJndiName();
95  
96     /**
97      * Get the JaasSecurityManagerService value.
98      * 
99      * @return the JaasSecurityManagerService value.
100     */
101    ObjectName   getJaasSecurityManagerService();
102 
103    /**
104     * Set the JaasSecurityManagerService value.
105     * 
106     * @param jaasSecurityManagerService The new JaasSecurityManagerService value.
107     */
108    void setJaasSecurityManagerService(ObjectName   jaasSecurityManagerService);
109 
110    /**
111     * ManagedConnectionFactory is an internal attribute that holds the ManagedConnectionFactory instance managed by this ConnectionManager.
112     * 
113     * @return value of managedConnectionFactory
114     */
115    ManagedConnectionFactory   getManagedConnectionFactory();
116 
117    /**
118     * Describe <code>getInstance</code> method here.
119     * 
120     * @return a <code>BaseConnectionManager2</code> value
121     */
122    BaseConnectionManager2 getInstance();
123 }
124
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags