HibernateServiceMBean


1   //$Id: HibernateServiceMBean.java,v 1.7 2005/03/17 10:48:03 turin42 Exp $
2   package org.hibernate.jmx;
3   
4   import org.hibernate.HibernateException;
5   
6   /**
7    * Hibernate JMX Management API
8    * @see HibernateService
9    * @author John Urberg, Gavin King
10   */
11  public interface HibernateServiceMBean {
12  
13      /**
14       * The Hibernate mapping files (might be overridden by subclasses
15       * that want to specify the mapping files by some other mechanism)
16       * @return String
17       */
18      public String   getMapResources();
19      /**
20       * Specify the Hibernate mapping files
21       * @param mappingFiles
22       */
23      public void setMapResources(String   mappingFiles);
24      /**
25       * Add a mapping file
26       * @param mapResource
27       */
28      public void addMapResource(String   mapResource);
29  
30      /**
31       * Set a property
32       * @param property the property name
33       * @param value the property value
34       */
35      public void setProperty(String   property, String   value);
36  
37      /**
38       * Get a property
39       * @param property the property name
40       * @return the property value
41       */
42      public String   getProperty(String   property);
43  
44      /**
45       * Display the properties
46       * @return a list of property names and values
47       */
48      public String   getPropertyList();
49  
50      /**
51       * The JNDI name of the datasource to use in this <tt>SessionFactory</tt>
52       * @return String
53       */
54      public String   getDatasource();
55      /**
56       * Set the JNDI name of the datasource to use in this <tt>SessionFactory</tt>
57       * @param datasource
58       */
59      public void setDatasource(String   datasource);
60  
61      /**
62       * Log into the database with this name
63       * @return String
64       */
65      public String   getUserName();
66      /**
67       * Log into the database with this name
68       * @param userName
69       */
70      public void setUserName(String   userName);
71  
72      /**
73       * Log into the database with this password
74       * @return String
75       */
76      public String   getPassword();
77      /**
78       * Log into the database with this password
79       * @param password
80       */
81      public void setPassword(String   password);
82  
83      /**
84       * The JNDI name of the dialect class to use in this <tt>SessionFactory</tt>
85       * @return String
86       */
87      public String   getDialect();
88      /**
89       * The name of the dialect class to use in this <tt>SessionFactory</tt>
90       * @param dialect fully qualified class name of <tt>Dialect</tt> subclass
91       * @see org.hibernate.dialect.Dialect
92       */
93      public void setDialect(String   dialect);
94  
95      /**
96       * The JNDI name to bind to the <tt>SessionFactory</tt>
97       * @return String
98       */
99      public String   getJndiName();
100     /**
101      * The JNDI name to bind to the <tt>SessionFactory</tt>
102      * @param jndiName
103      */
104     public void setJndiName(String   jndiName);
105 
106     /**
107      * The fully qualified class name of the Hibernate <tt>TransactionFactory</tt> implementation
108      * @return the class name
109      * @see org.hibernate.transaction.TransactionFactory
110      */
111     public String   getTransactionStrategy();
112 
113     /**
114      * Set the fully qualified class name of the Hibernate <tt>TransactionFactory</tt> implementation
115      * @param txnStrategy the class name
116      * @see org.hibernate.transaction.TransactionFactory
117      */
118     public void setTransactionStrategy(String   txnStrategy);
119 
120     /**
121      * The JNDI name of the JTA UserTransaction object (used only be <tt>JTATransaction</tt>).
122      * @return the JNDI name
123      * @see org.hibernate.transaction.JTATransaction
124      */
125     public String   getUserTransactionName();
126     /**
127      * Set the JNDI name of the JTA UserTransaction object (used only by <tt>JTATransaction</tt>).
128      * @param utName the JNDI name
129      * @see org.hibernate.transaction.JTATransaction
130      */
131     public void setUserTransactionName(String   utName);
132 
133     /**
134      * Get the strategy for obtaining the JTA <tt>TransactionManager</tt>
135      * @return the class name
136      * @see org.hibernate.transaction.TransactionManagerLookup
137      */
138     public String   getTransactionManagerLookupStrategy();
139     /**
140      * Set the strategy for obtaining the JTA <tt>TransactionManager</tt>
141      * @param lkpStrategy the class name
142      * @see org.hibernate.transaction.TransactionManagerLookup
143      */
144     public void setTransactionManagerLookupStrategy(String   lkpStrategy);
145 
146     /**
147      * Is SQL logging enabled?
148      */
149     public String   getShowSqlEnabled();
150     /**
151      * Enable logging of SQL to console
152      */
153     public void setShowSqlEnabled(String   showSql);
154     /**
155      * Get the maximum outer join fetch depth
156      */
157     public String   getMaximumFetchDepth();
158     /**
159      * Set the maximum outer join fetch depth
160      */
161     public void setMaximumFetchDepth(String   fetchDepth);
162     /**
163      * Get the maximum JDBC batch size
164      */
165     public String   getJdbcBatchSize();
166     /**
167      * Set the maximum JDBC batch size
168      */
169     public void setJdbcBatchSize(String   batchSize);
170     /**
171      * Get the JDBC fetch size
172      */
173     public String   getJdbcFetchSize();
174     /**
175      * Set the JDBC fetch size
176      */
177     public void setJdbcFetchSize(String   fetchSize);
178     /**
179      * Get the query language substitutions
180      */
181     public String   getQuerySubstitutions();
182     /**
183      * Set the query language substitutions
184      */
185     public void setQuerySubstitutions(String   querySubstitutions);
186     /**
187      * Get the default schema
188      */
189     public String   getDefaultSchema();
190     /**
191      * Set the default schema
192      */
193     public void setDefaultSchema(String   schema);
194     /**
195      * Get the default catalog
196      */
197     public String   getDefaultCatalog();
198     /**
199      * Set the default catalog
200      */
201     public void setDefaultCatalog(String   catalog);
202     /**
203      * Is use of scrollable resultsets enabled?
204      */
205     public String   getJdbcScrollableResultSetEnabled();
206     /**
207      * Enable or disable the use of scrollable resultsets 
208      */
209     public void setJdbcScrollableResultSetEnabled(String   enabled);
210     /**
211      * Is use of JDBC3 <tt>getGeneratedKeys()</tt> enabled?
212      */
213     public String   getGetGeneratedKeysEnabled();
214     /**
215      * Enable or disable the use <tt>getGeneratedKeys()</tt> 
216      */
217     public void setGetGeneratedKeysEnabled(String   enabled);
218     /**
219      * Get the second-level cache provider class name
220      */
221     public String   getCacheProviderClass();
222     /**
223      * Set the second-level cache provider class name
224      */
225     public void setCacheProviderClass(String   providerClassName);
226     /**
227      * Is the query cache enabled?
228      */
229     public String   getQueryCacheEnabled();
230     /**
231      * Enable or disable the query cache
232      */
233     public void setQueryCacheEnabled(String   enabled);
234     /**
235      * Is the second-level cache enabled?
236      */
237     public String   getSecondLevelCacheEnabled();
238     /**
239      * Enable or disable the second-level cache
240      */
241     public void setSecondLevelCacheEnabled(String   enabled);
242     /**
243      * Get the cache region prefix
244      */
245     public String   getCacheRegionPrefix();
246     /**
247      * Set the cache region prefix
248      */
249     public void setCacheRegionPrefix(String   prefix);
250     /**
251      * Is the second-level cache optimized for miminal puts?
252      */
253     public String   getMinimalPutsEnabled();
254     /**
255      * Enable or disable optimization of second-level cache
256      * for minimal puts 
257      */
258     public void setMinimalPutsEnabled(String   enabled);
259     /**
260      * Are SQL comments enabled?
261      */
262     public String   getCommentsEnabled();
263     /**
264      * Enable or disable the inclusion of comments in
265      * generated SQL
266      */
267     public void setCommentsEnabled(String   enabled);
268     /**
269      * Is JDBC batch update for versioned entities enabled?
270      */
271     public String   getBatchVersionedDataEnabled();
272     /**
273      * Enable or disable the use of batch updates for
274      * versioned entities
275      */
276     public void setBatchVersionedDataEnabled(String   enabled);
277     
278     /**
279      * Enable automatic flushing of the Session when JTA transaction ends.
280      */
281     public void setFlushBeforeCompletionEnabled(String   enabled);
282     /**
283      * Is automatic Session flusing enabled?
284      */
285     public String   getFlushBeforeCompletionEnabled();
286 
287     /**
288      * Enable automatic closing of Session when JTA transaction ends.
289      */
290     public void setAutoCloseSessionEnabled(String   enabled);
291     /**
292      * Is automatic Session closing enabled?
293      */
294     public String   getAutoCloseSessionEnabled();
295 
296     /**
297      * Export the <tt>CREATE</tt> DDL to the database
298      * @throws HibernateException
299      */
300     public void createSchema() throws HibernateException;
301     /**
302      * Export the <tt>DROP</tt> DDL to the database
303      * @throws HibernateException
304      */
305     public void dropSchema() throws HibernateException;
306 
307 
308     /**
309      * Create the <tt>SessionFactory</tt> and bind to the jndi name on startup
310      */
311     public void start() throws HibernateException;
312     /**
313      * Unbind the <tt>SessionFactory</tt> or stub from JNDI
314      */
315     public void stop();
316 
317 }
318 
319 
320 
321 
322 
323 
324
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags