Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-9487 - Improve AvailableSettings javadoc for session_factory_name / session_factory_name_is_jndi

This commit is contained in:
Steve Ebersole 2014-11-07 11:01:18 -06:00
parent aac8afa090
commit d9fc06b7db
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java
View File

@ -28,18 +28,31 @@ package org.hibernate.cfg;
*/ */
public interface AvailableSettings { public interface AvailableSettings {
/** /**
* Defines a name for the {@link org.hibernate.SessionFactory}. Useful both to<ul> * Setting used to name the Hibernate {@link org.hibernate.SessionFactory}.
* <li>allow serialization and deserialization to work across different jvms</li> *
* <li>optionally allow the SessionFactory to be bound into JNDI</li> * Naming the SessionFactory allows for it to be properly serialized across JVMs as
* </ul> * long as the same name is used on each JVM.
*
* If {@link #SESSION_FACTORY_NAME_IS_JNDI} is set to {@code true}, this is also the
* name under which the SessionFactory is bound into JNDI on startup and from which
* it can be obtained from JNDI.
* *
* @see #SESSION_FACTORY_NAME_IS_JNDI * @see #SESSION_FACTORY_NAME_IS_JNDI
* @see org.hibernate.internal.SessionFactoryRegistry
*/ */
String SESSION_FACTORY_NAME = "hibernate.session_factory_name"; String SESSION_FACTORY_NAME = "hibernate.session_factory_name";
/** /**
* Does the value defined by {@link #SESSION_FACTORY_NAME} represent a {@literal JNDI} namespace into which * Does the value defined by {@link #SESSION_FACTORY_NAME} represent a JNDI namespace into which
* the {@link org.hibernate.SessionFactory} should be bound? * the {@link org.hibernate.SessionFactory} should be bound and made accessible?
*
* Defaults to {@code true} for backwards compatibility.
*
* Set this to {@code false} if naming a SessionFactory is needed for serialization purposes, but
* no writable JNDI context exists in the runtime environment or if the user simply does not want
* JNDI to be used.
*
* @see #SESSION_FACTORY_NAME
*/ */
String SESSION_FACTORY_NAME_IS_JNDI = "hibernate.session_factory_name_is_jndi"; String SESSION_FACTORY_NAME_IS_JNDI = "hibernate.session_factory_name_is_jndi";