Package org.eclipse.persistence.sessions.factories

Class 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

    • Field Detail

      • resourceName

        protected String resourceName

      • resourcePath

        protected String resourcePath
        Stores the resource path to provide a better error message if the load fails.

      • sessionName

        protected String sessionName
        Stores the name of the Session in the sessions XML file desired to be loaded.

      • shouldLogin

        protected boolean shouldLogin
        Define if the loaded session should be connected, default true.

      • shouldRefresh

        protected boolean shouldRefresh
        Define if the loaded session should be refreshed from the file.

      • classLoader

        protected ClassLoader classLoader
        Define the class loader that should be used to find the resource.

      • shouldCheckClassLoader

        protected boolean 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.

      • exceptionStore

        protected Vector<Throwable> exceptionStore
        Stores any exceptions that occurred to provide all the exceptions up front if the load fails.

      • entityResolver

        protected PersistenceEntityResolver entityResolver
        Used to store the entity resolver to validate the XML schema when parsing.

      • project

        protected static final Project project
        Cache the creation and initialization of the Session XML mapping project.

    • 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

      • getProject

        protected static Project getProject()
        Cache the creation and initialization of the Session XML mapping project.

      • getResourcePath

        public String getResourcePath()
        INTERNAL: Will return the the resource name with full path of the resource file.

      • getExceptionStore

        public Vector<Throwable> getExceptionStore()
        INTERNAL:

      • 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 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 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.

      • loadDocument

        protected Document loadDocument​(ClassLoader loader)
        INTERNAL: Load a session.xml document. The error handler will capture all the errors and allow for a document to be returned.

      • loadDocument

        protected Document loadDocument​(ClassLoader loader,
                                boolean validate)
        INTERNAL: Load a session.xml document. The error handler will capture all the errors and allow for a document to be returned.