001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.resource.connectionmanager;
023:
024: import javax.management.ObjectName;
025: import javax.resource.spi.ManagedConnectionFactory;
026:
027: import org.jboss.mx.util.ObjectNameFactory;
028: import org.jboss.system.ServiceMBean;
029:
030: /**
031: * MBean interface.
032: *
033: * @author <a href="mailto:adrian@jboss.com">Adrian Brock</a>
034: * @version $Revision: 57189 $
035: */
036: public interface BaseConnectionManager2MBean extends ServiceMBean {
037: public static final ObjectName OBJECT_NAME = ObjectNameFactory
038: .create("jboss.jca:service=BaseConnectionManager");
039:
040: /**
041: * 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.
042: *
043: * @return the JndiName value.
044: */
045: String getJndiName();
046:
047: /**
048: * Set the JndiName value.
049: *
050: * @param jndiName The JndiName value.
051: */
052: void setJndiName(String jndiName);
053:
054: /**
055: * 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.
056: *
057: * @return the ManagedConnectionPool value.
058: */
059: ObjectName getManagedConnectionPool();
060:
061: /**
062: * Set the ManagedConnectionPool value.
063: *
064: * @param newManagedConnectionPool The new ManagedConnectionPool value.
065: */
066: void setManagedConnectionPool(ObjectName newManagedConnectionPool);
067:
068: /**
069: * 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.
070: *
071: * @param ccmName an <code>ObjectName</code> value
072: */
073: void setCachedConnectionManager(ObjectName ccmName);
074:
075: /**
076: * Describe <code>getCachedConnectionManager</code> method here.
077: *
078: * @return an <code>ObjectName</code> value
079: */
080: ObjectName getCachedConnectionManager();
081:
082: /**
083: * 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.
084: *
085: * @param securityDomainJndiName an <code>String</code> value
086: */
087: void setSecurityDomainJndiName(String securityDomainJndiName);
088:
089: /**
090: * Get the SecurityDomainJndiName value.
091: *
092: * @return the SecurityDomainJndiName value.
093: */
094: String getSecurityDomainJndiName();
095:
096: /**
097: * Get the JaasSecurityManagerService value.
098: *
099: * @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(
109: ObjectName jaasSecurityManagerService);
110:
111: /**
112: * ManagedConnectionFactory is an internal attribute that holds the ManagedConnectionFactory instance managed by this ConnectionManager.
113: *
114: * @return value of managedConnectionFactory
115: */
116: ManagedConnectionFactory getManagedConnectionFactory();
117:
118: /**
119: * Describe <code>getInstance</code> method here.
120: *
121: * @return a <code>BaseConnectionManager2</code> value
122: */
123: BaseConnectionManager2 getInstance();
124: }
|