RARDeploymentMBean


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  import org.w3c.dom.Element  ;
30  
31  /**
32   * MBean interface.
33   * 
34   * @author <a HREF="mailto:adrian@jboss.com">Adrian Brock</a>
35   * @version $Revision: 38338 $
36   */
37  public interface RARDeploymentMBean extends ServiceMBean, ManagedConnectionFactory  
38  {
39     public static final ObjectName   OBJECT_NAME = ObjectNameFactory.create("jboss.jca:service=RARDeployment");
40  
41     /**
42      * The OldRarDeployment attribute refers to a previous-generation RARDeployment. THIS IS A HACK UNTIL XSLT DEPLOYMENT IS WRITTEN
43      * 
44      * @return value of OldRarDeployment
45      */
46     ObjectName   getOldRarDeployment();
47  
48     /**
49      * Set the value of OldRarDeployment
50      * 
51      * @param oldRarDeployment - Value to assign to OldRarDeployment
52      */
53     void setOldRarDeployment(ObjectName   oldRarDeployment);
54  
55     /**
56      * The RARName attribute holds the file name of the rar
57      * 
58      * @return the rar name value.
59      */
60     String   getRARName();
61  
62     /**
63      * Set the RARName value.
64      * 
65      * @param rarName The new DisplayName value.
66      */
67     void setRARName(String   rarName);
68  
69     /**
70      * The connection definition inside the rar, it identifies the unique connection factory
71      * 
72      * @return the rar name value.
73      */
74     String   getConnectionDefinition();
75  
76     /**
77      * Set the connection definition.
78      * 
79      * @param connectionDefinition - the connection definition
80      */
81     void setConnectionDefinition(String   connectionDefinition);
82  
83     /**
84      * The VendorName attribute holds the VendorName from the ra.xml It should be supplied by xslt from ra.xml
85      * 
86      * @return the VendorName value.
87      */
88     String   getVendorName();
89  
90     /**
91      * Set the VendorName value.
92      * 
93      * @param vendorName The new VendorName value.
94      */
95     void setVendorName(String   vendorName);
96  
97     /**
98      * The SpecVersion attribute holds the SpecVersion from the ra.xml It should be supplied by xslt from ra.xml
99      * 
100     * @return the SpecVersion value.
101     */
102    String   getSpecVersion();
103 
104    /**
105     * Set the SpecVersion value.
106     * 
107     * @param specVersion The new SpecVersion value.
108     */
109    void setSpecVersion(String   specVersion);
110 
111    /**
112     * The EisType attribute holds the EisType from the ra.xml. It should be supplied by xslt from ra.xml
113     * 
114     * @return the EisType value.
115     */
116    String   getEisType();
117 
118    /**
119     * Set the EisType value.
120     * 
121     * @param eisType The new EisType value.
122     */
123    void setEisType(String   eisType);
124 
125    /**
126     * The Version attribute holds the Version from the ra.xml. It should be supplied by xslt from ra.xml
127     * 
128     * @return the Version value.
129     */
130    String   getVersion();
131 
132    /**
133     * Set the Version value.
134     * 
135     * @param version The new Version value.
136     */
137    void setVersion(String   version);
138 
139    /**
140     * The ManagedConnectionFactoryClass attribute holds the ManagedConnectionFactoryClass from the ra.xml. It should be supplied by xslt from ra.xml
141     * 
142     * @return the ManagedConnectionFactoryClass value.
143     */
144    String   getManagedConnectionFactoryClass();
145 
146    /**
147     * Set the ManagedConnectionFactoryClass value.
148     * 
149     * @param managedConnectionFactoryClass The new ManagedConnectionFactoryClass value.
150     */
151    void setManagedConnectionFactoryClass(String   managedConnectionFactoryClass);
152 
153    /**
154     * The ConnectionFactoryInterface attribute holds the ConnectionFactoryInterface from the ra.xml. It should be supplied by xslt from ra.xml
155     * 
156     * @return the ConnectionFactoryInterface value.
157     */
158    String   getConnectionFactoryInterface();
159 
160    /**
161     * Set the ConnectionFactoryInterface value.
162     * 
163     * @param connectionFactoryInterface The ConnectionFactoryInterface value.
164     */
165    void setConnectionFactoryInterface(String   connectionFactoryInterface);
166 
167    /**
168     * The ConnectionFactoryImplClass attribute holds the ConnectionFactoryImplClass from the ra.xml. It should be supplied by xslt from ra.xml
169     * 
170     * @return the ConnectionFactoryImplClass value.
171     */
172    String   getConnectionFactoryImplClass();
173 
174    /**
175     * Set the ConnectionFactoryImplClass value.
176     * 
177     * @param connectionFactoryImplClass The ConnectionFactoryImplClass value.
178     */
179    void setConnectionFactoryImplClass(String   connectionFactoryImplClass);
180 
181    /**
182     * The ConnectionInterface attribute holds the ConnectionInterface from the ra.xml. It should be supplied by xslt from ra.xml
183     * 
184     * @return the ConnectionInterface value.
185     */
186    String   getConnectionInterface();
187 
188    /**
189     * Set the ConnectionInterface value.
190     * 
191     * @param connectionInterface The ConnectionInterface value.
192     */
193    void setConnectionInterface(String   connectionInterface);
194 
195    /**
196     * The ConnectionImplClass attribute holds the ConnectionImplClass from the ra.xml. It should be supplied by xslt from ra.xml
197     * 
198     * @return the connectionImplClass value.
199     */
200    String   getConnectionImplClass();
201 
202    /**
203     * Set the ConnectionImplClass value.
204     * 
205     * @param connectionImplClass The ConnectionImplClass value.
206     */
207    void setConnectionImplClass(String   connectionImplClass);
208 
209    /**
210     * The TransactionSupport attribute holds the TransactionSupport from the ra.xml. It should be supplied by xslt from ra.xml It is ignored, and choice of ConnectionManager implementations determine transaction support. Get the TransactionSupport value.
211     * 
212     * @return the TransactionSupport value.
213     */
214    String   getTransactionSupport();
215 
216    /**
217     * Set the TransactionSupport value.
218     * 
219     * @param transactionSupport The TransactionSupport value.
220     */
221    void setTransactionSupport(String   transactionSupport);
222 
223    /**
224     * The ManagedConnectionFactoryProperties attribute holds the ManagedConnectionFactoryProperties from the ra.xml, together with user supplied values for all or some of these properties. This must be supplied as an element in the same format as in ra.xml, wrapped in a properties tag. It should be supplied by xslt from ra.xml merged with an user configuration xml file. An alternative format has a config-property element with attributes for name and type and the value as content.
225     * 
226     * @return the ManagedConnectionFactoryProperties value.
227     */
228    Element   getManagedConnectionFactoryProperties();
229 
230    /**
231     * Set the ManagedConnectionFactoryProperties value.
232     * 
233     * @param managedConnectionFactoryProperties The ManagedConnectionFactoryProperties value.
234     */
235    void setManagedConnectionFactoryProperties(Element   managedConnectionFactoryProperties);
236 
237    /**
238     * The AuthenticationMechanismType attribute holds the AuthenticationMechanismType from the ra.xml. It should be supplied by xslt from ra.xml
239     * 
240     * @return the AuthenticationMechanismType value.
241     */
242    String   getAuthenticationMechanismType();
243 
244    /**
245     * Set the AuthenticationMechanismType value.
246     * 
247     * @param authenticationMechanismType The AuthenticationMechanismType value.
248     */
249    void setAuthenticationMechanismType(String   authenticationMechanismType);
250 
251    /**
252     * The CredentialInterface attribute holds the CredentialInterface from the ra.xml. It should be supplied by xslt from ra.xml
253     * 
254     * @return the CredentialInterface value.
255     */
256    String   getCredentialInterface();
257 
258    /**
259     * Set the CredentialInterface value.
260     * 
261     * @param credentialInterface The CredentialInterface value.
262     */
263    void setCredentialInterface(String   credentialInterface);
264 
265    /**
266     * The ReauthenticationSupport attribute holds the ReauthenticationSupport from the ra.xml. It should be supplied by xslt from ra.xml
267     * 
268     * @return the ReauthenticationSupport value.
269     */
270    boolean isReauthenticationSupport();
271 
272    /**
273     * Set the ReauthenticationSupport value.
274     * 
275     * @param reauthenticationSupport The ReauthenticationSupport value.
276     */
277    void setReauthenticationSupport(boolean reauthenticationSupport);
278 
279    /**
280     * The <code>getMcfInstance</code> method returns the ManagedConnectionFactory instance represented by this mbean. It is needed so PasswordCredentials can match up correctly. This will probably have to be implemented as an interceptor when the mcf is directly deployed as an mbean.
281     * @return a <code>ManagedConnectionFactory</code> value
282     */
283    ManagedConnectionFactory   getMcfInstance();
284 
285    /**
286     * The setManagedConnectionFactoryAttribute method can be used to set attributes on the ManagedConnectionFactory from code, without using the xml configuration.
287     * 
288     * @param name a <code>String</code> value
289     * @param clazz a <code>Class</code> value
290     * @param value an <code>Object</code> value
291     */
292    void setManagedConnectionFactoryAttribute(String   name, Class   clazz, Object   value);
293 
294    /**
295     * The <code>getManagedConnectionFactoryAttribute</code> method can be used to examine the managed connection factory properties.
296     * 
297     * @param name a <code>String</code> value
298     * @return an <code>Object</code> value
299     */
300    Object   getManagedConnectionFactoryAttribute(String   name);
301 }
302
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags