hibernateservicembean.java

用Java实现的23个常用设计模式源代码

//$Id: HibernateServiceMBean.java,v 1.5.2.2 2003/09/29 12:06:29 oneovthafew Exp $
package net.sf.hibernate.jmx;

import net.sf.hibernate.HibernateException;

/**
 * Hibernate JMX Management API
 * @see HibernateService
 * @author John Urberg
 */
public interface HibernateServiceMBean {
	
	/**
	 * The Hibernate mapping files (might be overridden by subclasses
	 * that want to specify the mapping files by some other mechanism)
	 * @return String
	 */
	public String getMapResources();
	/**
	 * Specify the Hibernate mapping files
	 * @param mappingFiles
	 */
	public void setMapResources(String mappingFiles);
	/**
	 * Add a mapping file
	 * @param mapResource
	 */
	public void addMapResource(String mapResource);
	
	/**
	 * Set a property
	 * @param property the property name
	 * @param value the property value
	 */
	public void setProperty(String property, String value);
	
	/**
	 * Get a property
	 * @param property the property name
	 * @return the property value
	 */
	public String getProperty(String property);
	
	/**
	 * Display the properties
	 * @return a list of property names and values
	 */
	public String getPropertyList();
	
	/**
	 * The JNDI name of the datasource to use in this <tt>SessionFactory</tt>
	 * @return String
	 */
	public String getDatasource();
	/**
	 * Set the JNDI name of the datasource to use in this <tt>SessionFactory</tt>
	 * @param datasource
	 */
	public void setDatasource(String datasource);
	
	/**
	 * Log into the database with this name
	 * @return String
	 */
	public String getUserName();
	/**
	 * Log into the database with this name
	 * @param userName
	 */
	public void setUserName(String userName);
	
	/**
	 * Log into the database with this password
	 * @return String
	 */
	public String getPassword();
	/**
	 * Log into the database with this password
	 * @param password
	 */
	public void setPassword(String password);
	
	/**
	 * The JNDI name of the dialect class to use in this <tt>SessionFactory</tt>
	 * @return String
	 */
	public String getDialect();
	/**
	 * The name of the dialect class to use in this <tt>SessionFactory</tt>
	 * @param dialect fully qualified class name of <tt>Dialect</tt> subclass
	 * @see net.sf.hibernate.dialect.Dialect
	 */
	public void setDialect(String dialect);
	
	/**
	 * The JNDI name to bind to the <tt>SessionFactory</tt>
	 * @return String
	 */
	public String getJndiName();
	/**
	 * The JNDI name to bind to the <tt>SessionFactory</tt>
	 * @param jndiName
	 */
	public void setJndiName(String jndiName);
	
	/**
	 * The fully qualified class name of the Hibernate <tt>TransactionFactory</tt> implementation
	 * @return the class name
	 * @see net.sf.hibernate.transaction.TransactionFactory
	 */
	public String getTransactionStrategy();
	
	/**
	 * Set the fully qualified class name of the Hibernate <tt>TransactionFactory</tt> implementation
	 * @param txnStrategy the class name
	 * @see net.sf.hibernate.transaction.TransactionFactory
	 */
	public void setTransactionStrategy(String txnStrategy);
	
	/**
	 * The JNDI name of the JTA UserTransaction object (used only be <tt>JTATransaction</tt>).
	 * @return the JNDI name
	 * @see net.sf.hibernate.transaction.JTATransaction
	 */
	public String getUserTransactionName();
	/**
	 * Set the JNDI name of the JTA UserTransaction object (used only by <tt>JTATransaction</tt>).
	 * @param utName the JNDI name
	 * @see net.sf.hibernate.transaction.JTATransaction
	 */
	public void setUserTransactionName(String utName);
	
	/**
	 * Get the strategy for obtaining the JTA <tt>TransactionManager</tt>
	 * @return the class name
	 * @see net.sf.hibernate.transaction.TransactionManagerLookup
	 */
	public String getTransactionManagerLookupStrategy();
	/**
	 * Set the strategy for obtaining the JTA <tt>TransactionManager</tt>
	 * @param lkpStrategy the class name
	 * @see net.sf.hibernate.transaction.TransactionManagerLookup
	 */
	public void setTransactionManagerLookupStrategy(String lkpStrategy);
	/**
	 * Is outerjoin fetching enabled?
	 * @return boolean
	 */
	public boolean getUseOuterJoin();
	/**
	 * Enable outerjoin fetching
	 * @param uoj
	 */
	public void setUseOuterJoin(boolean uoj);
	
	/**
	 * Is SQL logging enabled?
	 * @return boolean
	 */
	public boolean getShowSql();
	/**
	 * Enable logging of SQL to console
	 * @param showSql
	 */
	public void setShowSql(boolean showSql);
	
	/**
	 * Create the <tt>SessionFactory</tt> and bind to the jndi name on startup
	 */
	public void start() throws HibernateException;
	/**
	 * Unbind the <tt>SessionFactory</tt> or stub from JNDI
	 */
	public void stop();
	
}