Oracle Fusion Middleware Java API Reference for Oracle TopLink (Deprecated)
11g Release 1 (11.1.1)

B32476-04

oracle.toplink.tools.sessionconfiguration
Class XMLSessionConfigLoader

java.lang.Object
  extended by oracle.toplink.tools.sessionconfiguration.XMLSessionConfigLoader
Direct Known Subclasses:
WASXMLSessionConfigLoader

public class XMLSessionConfigLoader
extends java.lang.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,

Since:
TopLink 10.1.3

Constructor Summary
XMLSessionConfigLoader()
          This constructor is used when the file resource named 'sessions.xml' will be parsed for configuration.
XMLSessionConfigLoader(java.lang.String resourceName)
          This constructor is used when passing in the resource name of the configuration file that should be parsed
 
Method Summary
 java.lang.ClassLoader getClassLoader()
          Return the class loader that should be used to find the resource.
 java.lang.String getResourceName()
          Returns the resource name we are trying to load.
 java.lang.String getSessionName()
          Returns the name of the Session in the sessions XML file desired to be loaded.
 void setClassLoader(java.lang.ClassLoader classLoader)
          Set the class loader that should be used to find the resource.
 void setResourceName(java.lang.String resourceName)
          Set the resource name we are trying to load.
 void setSessionName(java.lang.String sessionName)
          Set the name of the Session in the sessions XML file desired to be loaded.
 void setShouldCheckClassLoader(boolean shouldCheckClassLoader)
          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)
          Set if the loaded session should be connected.
 void setShouldRefresh(boolean shouldRefresh)
          Set if the loaded session should be refreshed from the file.
 boolean shouldCheckClassLoader()
          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()
          Return if the loaded session should be connected.
 boolean shouldRefresh()
          Return if the loaded session should be refreshed from the file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLSessionConfigLoader

public XMLSessionConfigLoader()
This constructor is used when the file resource named 'sessions.xml' will be parsed for configuration.


XMLSessionConfigLoader

public XMLSessionConfigLoader(java.lang.String resourceName)
This constructor is used when passing in the resource name of the configuration file that should be parsed

Method Detail

getResourceName

public java.lang.String getResourceName()
Returns the resource name we are trying to load.


setResourceName

public void setResourceName(java.lang.String resourceName)
Set the resource name we are trying to load.


getSessionName

public java.lang.String getSessionName()
Returns the name of the Session in the sessions XML file desired to be loaded.


setSessionName

public void setSessionName(java.lang.String sessionName)
Set the name of the Session in the sessions XML file desired to be loaded.


shouldLogin

public boolean shouldLogin()
Return if the loaded session should be connected.


setShouldLogin

public void setShouldLogin(boolean shouldLogin)
Set if the loaded session should be connected.


shouldRefresh

public boolean shouldRefresh()
Return if the loaded session should be refreshed from the file.


setShouldRefresh

public void setShouldRefresh(boolean shouldRefresh)
Set if the loaded session should be refreshed from the file.


shouldCheckClassLoader

public boolean shouldCheckClassLoader()
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)
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 java.lang.ClassLoader getClassLoader()
Return the class loader that should be used to find the resource.


setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)
Set the class loader that should be used to find the resource.


Copyright © 1998, 2012, Oracle. All Rights Reserved.