Class XMLSessionConfigLoader
- java.lang.Object
-
- org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader
-
public class XMLSessionConfigLoader extends Object
Provide a mechanism for loading Session configuration XML files. This is used by the SessionManager to define how to find and load a Session from a sessions XML file. The sessions XML file is typically deployed in the applications jar (ejb-jar) and named sessions.xml in the /META-INF directory. Several loading options are provided,- resourceName : The resource path and file name to the sessions XML file, default is /sessions.xml or /META-INF/sessions.xml. (ensure "/" is used, not "\"). A file path can also be provided, although a resource is typically used.
- shouldLogin : Define if the loaded session should be connected, default true.
- shouldRefresh : Define if the loaded session should be refreshed from the file, (this old session will be disconnected) default false.
- classLoader : Define the class loader that should be used to find the resource. This loader will also be used as the loaded session's class loader. This should be the application's class loader. Default is the ConversionManager loader, which is thread-based.
- shouldCheckClassLoader : Defines if the session will be refreshed from the file if the class loader requesting the load, is different than the loaded session's class loader. This can be used to handle re-deployment.
- Since:
- TopLink 10.1.3
- Author:
- Guy Pelletier
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
XMLSessionConfigLoader.XMLSessionConfigLoaderErrorHandler
INTERNAL:
-
Field Summary
Fields Modifier and Type Field Description static String
ECLIPSELINK_SESSIONS_SCHEMA
-
Constructor Summary
Constructors Constructor Description XMLSessionConfigLoader()
PUBLIC: This constructor is used when the file resource named 'sessions.xml' will be parsed for configuration.XMLSessionConfigLoader(String resourceName)
PUBLIC: This constructor is used when passing in the resource name of the configuration file that should be parsed
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassLoader
getClassLoader()
PUBLIC: Return the class loader that should be used to find the resource.Vector<Throwable>
getExceptionStore()
INTERNAL:String
getResourceName()
PUBLIC: Returns the resource name we are trying to load.String
getResourcePath()
INTERNAL: Will return the the resource name with full path of the resource file.String
getSessionName()
PUBLIC: Returns the name of the Session in the sessions XML file desired to be loaded.boolean
load(SessionManager sessionManager, ClassLoader loader)
INTERNAL: This method instantiates the parser and builds the document based on the schema.org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs
loadConfigsForMappingWorkbench(ClassLoader loader)
INTERNAL: This method is to be used to load config objects for the Mapping Workbench only.org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs
loadConfigsForMappingWorkbench(ClassLoader loader, boolean validate)
INTERNAL: This method is to be used to load config objects for the Mapping Workbench only.void
setClassLoader(ClassLoader classLoader)
PUBLIC: Set the class loader that should be used to find the resource.void
setResourceName(String resourceName)
PUBLIC: Set the resource name we are trying to load.void
setSessionName(String sessionName)
PUBLIC: Set the name of the Session in the sessions XML file desired to be loaded.void
setShouldCheckClassLoader(boolean shouldCheckClassLoader)
PUBLIC: Set if the session will be refreshed from the file if the class loader requesting the load is different than the loaded session's class loader.void
setShouldLogin(boolean shouldLogin)
PUBLIC: Set if the loaded session should be connected.void
setShouldRefresh(boolean shouldRefresh)
PUBLIC: Set if the loaded session should be refreshed from the file.boolean
shouldCheckClassLoader()
PUBLIC: Return if the session will be refreshed from the file if the class loader requesting the load is different than the loaded session's class loader.boolean
shouldLogin()
PUBLIC: Return if the loaded session should be connected.boolean
shouldRefresh()
PUBLIC: Return if the loaded session should be refreshed from the file.
-
-
-
Field Detail
-
ECLIPSELINK_SESSIONS_SCHEMA
public static final String ECLIPSELINK_SESSIONS_SCHEMA
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
XMLSessionConfigLoader
public XMLSessionConfigLoader()
PUBLIC: This constructor is used when the file resource named 'sessions.xml' will be parsed for configuration.
-
XMLSessionConfigLoader
public XMLSessionConfigLoader(String resourceName)
PUBLIC: This constructor is used when passing in the resource name of the configuration file that should be parsed
-
-
Method Detail
-
getResourcePath
public String getResourcePath()
INTERNAL: Will return the the resource name with full path of the resource file.
-
getResourceName
public String getResourceName()
PUBLIC: Returns the resource name we are trying to load.
-
setResourceName
public void setResourceName(String resourceName)
PUBLIC: Set the resource name we are trying to load.
-
getSessionName
public String getSessionName()
PUBLIC: Returns the name of the Session in the sessions XML file desired to be loaded.
-
setSessionName
public void setSessionName(String sessionName)
PUBLIC: Set the name of the Session in the sessions XML file desired to be loaded.
-
shouldLogin
public boolean shouldLogin()
PUBLIC: Return if the loaded session should be connected.
-
setShouldLogin
public void setShouldLogin(boolean shouldLogin)
PUBLIC: Set if the loaded session should be connected.
-
shouldRefresh
public boolean shouldRefresh()
PUBLIC: Return if the loaded session should be refreshed from the file.
-
setShouldRefresh
public void setShouldRefresh(boolean shouldRefresh)
PUBLIC: Set if the loaded session should be refreshed from the file.
-
shouldCheckClassLoader
public boolean shouldCheckClassLoader()
PUBLIC: Return if the session will be refreshed from the file if the class loader requesting the load is different than the loaded session's class loader.
-
setShouldCheckClassLoader
public void setShouldCheckClassLoader(boolean shouldCheckClassLoader)
PUBLIC: Set if the session will be refreshed from the file if the class loader requesting the load is different than the loaded session's class loader.
-
getClassLoader
public ClassLoader getClassLoader()
PUBLIC: Return the class loader that should be used to find the resource.
-
setClassLoader
public void setClassLoader(ClassLoader classLoader)
PUBLIC: Set the class loader that should be used to find the resource.
-
load
public boolean load(SessionManager sessionManager, ClassLoader loader)
INTERNAL: This method instantiates the parser and builds the document based on the schema. If the document is loaded without errors, then the configs are converted to sessions and stored on the session manager and true is returned to indicate success.
-
loadConfigsForMappingWorkbench
public org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs loadConfigsForMappingWorkbench(ClassLoader loader)
INTERNAL: This method is to be used to load config objects for the Mapping Workbench only. Do not call this method.
-
loadConfigsForMappingWorkbench
public org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs loadConfigsForMappingWorkbench(ClassLoader loader, boolean validate)
INTERNAL: This method is to be used to load config objects for the Mapping Workbench only. Do not call this method.
-
-