| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:11 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SessionManager (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SessionManager (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":9,"i23":10,"i24":9,"i25":10,"i26":9,"i27":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionFactory.html" title="class in org.eclipse.persistence.sessions.factories"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/factories/TableCreatorClassGenerator.html" title="class in org.eclipse.persistence.sessions.factories"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/factories/SessionManager.html" target="_top">Frames</a></li> |
| <li><a href="SessionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.sessions.factories</div> |
| <h2 title="Class SessionManager" class="title">Class SessionManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.sessions.factories.SessionManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SessionManager</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: Global session location.</p> |
| |
| <p><b>Description</b>: This allows for a global session local which can |
| be accessed globally from other classes. This is needed for EJB data stores |
| as they must have a globally accessible place to access the session. |
| This can be by EJB session beans, BMP beans and CMP beans as well as Servlets and |
| other three-tier services.</p> |
| |
| <p><b>Responsibilities</b>:</p> |
| <ul> |
| <li> Store a global session. |
| <li> Allow the storage of alternative sessions as well. |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>James Sutherland</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TOPLink/Java 3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#defaultSession">defaultSession</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#manager">manager</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#sessions">sessions</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#shouldPerformDTDValidation">shouldPerformDTDValidation</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#shouldUseSchemaValidation">shouldUseSchemaValidation</a></span></code> |
| <div class="block">Allow for usage of schema validation to be configurable.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#SessionManager--">SessionManager</a></span>()</code> |
| <div class="block">PUBLIC: |
| The default constructor to create a new session manager.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#addSession-org.eclipse.persistence.sessions.Session-">addSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</code> |
| <div class="block">INTERNAL: |
| Add an named session to the hashtable.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#addSession-java.lang.String-org.eclipse.persistence.sessions.Session-">addSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</code> |
| <div class="block">ADVANCED: |
| add an named session to the hashtable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#destroy--">destroy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Destroy current session manager instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#destroyAllSessions--">destroyAllSessions</a></span>()</code> |
| <div class="block">INTERNAL: |
| Destroy all sessions held onto by this manager.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#destroySession-java.lang.String-">destroySession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName)</code> |
| <div class="block">INTERNAL: |
| Destroy the session defined by sessionName on this manager.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getAllManagers--">getAllManagers</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return all session managers.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getDefaultSession--">getDefaultSession</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the default session.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getInternalMWConfigObjects-java.lang.String-java.lang.ClassLoader-">getInternalMWConfigObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</code> |
| <div class="block">INTERNAL: |
| This method is to be used to load config objects for the Mapping Workbench |
| only.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getInternalMWConfigObjects-java.lang.String-java.lang.ClassLoader-boolean-">getInternalMWConfigObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean validate)</code> |
| <div class="block">INTERNAL: |
| This method is to be used to load config objects for the Mapping Workbench |
| only.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getManager--">getManager</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the session manager for current context.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName)</code> |
| <div class="block">PUBLIC: |
| Return the session by name.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-boolean-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| boolean shouldLoginSession)</code> |
| <div class="block">PUBLIC: |
| Return the session by name.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-boolean-boolean-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession)</code> |
| <div class="block">PUBLIC: |
| Return the session by name.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-java.lang.ClassLoader-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</code> |
| <div class="block">PUBLIC: |
| Return the session by name.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-java.lang.Object-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> objectBean)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, using the classloader of the Object specified.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-java.lang.String-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, in the file specified.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-java.lang.String-java.lang.String-java.lang.ClassLoader-">getSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, in the file specified, using the class loader to find the resource.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-">getSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader, using the loading options provided on the loader.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-">getSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the XMLSessionConfigLoader.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-boolean-boolean-">getSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-boolean-boolean-boolean-">getSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession, |
| boolean shouldCheckClassLoader)</code> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#getSessions--">getSessions</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return a hashtable on all sessions.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#initializeManager--">initializeManager</a></span>()</code> |
| <div class="block">INTERNAL: |
| Initialize the singleton session manager.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#setDefaultSession-org.eclipse.persistence.sessions.Session-">setDefaultSession</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> defaultSession)</code> |
| <div class="block">PUBLIC: |
| Set the default session.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#setManager-org.eclipse.persistence.sessions.factories.SessionManager-">setManager</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a> theManager)</code> |
| <div class="block">INTERNAL: |
| Set the singleton session manager.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#setSessions-java.util.concurrent.ConcurrentMap-">setSessions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a> sessions)</code> |
| <div class="block">INTERNAL: |
| Set a hashtable of all sessions</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#setShouldUseSchemaValidation-boolean-">setShouldUseSchemaValidation</a></span>(boolean useSchemaValidation)</code> |
| <div class="block">PUBLIC: |
| Set if schema validation will be used when parsing the 10g (10.1.3) sessions XML.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html#shouldUseSchemaValidation--">shouldUseSchemaValidation</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return if schema validation will be used when parsing the 10g (10.1.3) sessions XML.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="shouldUseSchemaValidation"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseSchemaValidation</h4> |
| <pre>protected static boolean shouldUseSchemaValidation</pre> |
| <div class="block">Allow for usage of schema validation to be configurable.</div> |
| </li> |
| </ul> |
| <a name="manager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>manager</h4> |
| <pre>protected static volatile <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a> manager</pre> |
| </li> |
| </ul> |
| <a name="defaultSession"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultSession</h4> |
| <pre>protected org.eclipse.persistence.internal.sessions.AbstractSession defaultSession</pre> |
| </li> |
| </ul> |
| <a name="sessions"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>> sessions</pre> |
| </li> |
| </ul> |
| <a name="shouldPerformDTDValidation"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>shouldPerformDTDValidation</h4> |
| <pre>protected static boolean shouldPerformDTDValidation</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SessionManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SessionManager</h4> |
| <pre>public SessionManager()</pre> |
| <div class="block">PUBLIC: |
| The default constructor to create a new session manager.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="shouldUseSchemaValidation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseSchemaValidation</h4> |
| <pre>public static boolean shouldUseSchemaValidation()</pre> |
| <div class="block">PUBLIC: |
| Return if schema validation will be used when parsing the 10g (10.1.3) sessions XML.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if schema validation will be used when parsing |
| the 10g (10.1.3) sessions XML, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setShouldUseSchemaValidation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldUseSchemaValidation</h4> |
| <pre>public static void setShouldUseSchemaValidation(boolean useSchemaValidation)</pre> |
| <div class="block">PUBLIC: |
| Set if schema validation will be used when parsing the 10g (10.1.3) sessions XML. |
| By default schema validation is on, but can be turned off if validation problems occur, |
| or to improve parsing performance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>useSchemaValidation</code> - <code>true</code> if schema validation should be used when parsing |
| the 10g (10.1.3) sessions XML, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSession-org.eclipse.persistence.sessions.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSession</h4> |
| <pre>public void addSession(<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</pre> |
| <div class="block">INTERNAL: |
| Add an named session to the hashtable. |
| Session must have a name prior to setting into session manager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - session to be added to the session manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSession-java.lang.String-org.eclipse.persistence.sessions.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSession</h4> |
| <pre>public void addSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</pre> |
| <div class="block">ADVANCED: |
| add an named session to the hashtable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>session</code> - session to be added to the session manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultSession</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> getDefaultSession()</pre> |
| <div class="block">PUBLIC: |
| Return the default session. |
| The session configuration is stored in a sessions.xml file in a |
| directory on your classpath. Other sessions are supported through the |
| getSession by name API.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>default session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>public void destroy()</pre> |
| <div class="block">PUBLIC: |
| Destroy current session manager instance.</div> |
| </li> |
| </ul> |
| <a name="destroySession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroySession</h4> |
| <pre>public void destroySession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName)</pre> |
| <div class="block">INTERNAL: |
| Destroy the session defined by sessionName on this manager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - name of the session to be destroyed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroyAllSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroyAllSessions</h4> |
| <pre>public void destroyAllSessions()</pre> |
| <div class="block">INTERNAL: |
| Destroy all sessions held onto by this manager.</div> |
| </li> |
| </ul> |
| <a name="getInternalMWConfigObjects-java.lang.String-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInternalMWConfigObjects</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs getInternalMWConfigObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</pre> |
| <div class="block">INTERNAL: |
| This method is to be used to load config objects for the Mapping Workbench |
| only. Do not call this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceName</code> - resource to load</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the resource</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parsed session configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInternalMWConfigObjects-java.lang.String-java.lang.ClassLoader-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInternalMWConfigObjects</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs getInternalMWConfigObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean validate)</pre> |
| <div class="block">INTERNAL: |
| This method is to be used to load config objects for the Mapping Workbench |
| only. Do not call this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceName</code> - resource to load</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the resource</dd> |
| <dd><code>validate</code> - whether to validate the resource passed in</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parsed session configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManager</h4> |
| <pre>public static <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a> getManager()</pre> |
| <div class="block">PUBLIC: |
| Return the session manager for current context. |
| This allow global access to a set of named sessions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session manager for current context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllManagers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllManagers</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a>> getAllManagers()</pre> |
| <div class="block">ADVANCED: |
| Return all session managers. |
| This allows global access to all instances of SessionManager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all SessionManager instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initializeManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeManager</h4> |
| <pre>protected static <a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a> initializeManager()</pre> |
| <div class="block">INTERNAL: |
| Initialize the singleton session manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>initialized session manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| boolean shouldLoginSession)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name. |
| Log the session in only if specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>shouldLoginSession</code> - whether the session should be logged in</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name. |
| Log the session in only if specified. |
| Refresh the session only if specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>shouldLoginSession</code> - whether the session should be logged in</dd> |
| <dd><code>shouldRefreshSession</code> - whether the session should be refreshed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> objectBean)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, using the classloader of the Object specified. |
| This method is used in older versions of BMP support |
| This method will cause the class loader of the provided object to be |
| compared with the classloader used to load the original session of this |
| name, with this classloader. If they are not the same then the session |
| will be refreshed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>objectBean</code> - object to get the ClassLoader from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, in the file specified. |
| Login the session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>filename</code> - file name containing session definition</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-java.lang.String-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, in the file specified, using the class loader to find the resource. |
| This method will cause the class loader to be compared with the classloader |
| used to load the original session of this name. |
| If they are not the same then the session will be refreshed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>filename</code> - file name containing session definition</dd> |
| <dd><code>classLoader</code> - ClassLoader used to load the original session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-java.lang.String-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name. |
| Provide the class loader for loading the project, the configuration file |
| and the deployed classes. |
| E.g. SessionManager.getManager().getSession("mySession", MySessionBean.getClassLoader()); |
| This method will cause the class loader to be compared with the classloader |
| used to load the original session of this name. |
| If they are not the same then the session will be refreshed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the original session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the XMLSessionConfigLoader. Provide the class loader for |
| loading the project, the configuration file and the deployed classes. |
| This method will cause the class loader to be compared with the classloader |
| used to load the original session of this name. |
| If they are not the same then the session will be refreshed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - <a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories"><code>XMLSessionConfigLoader</code></a> containing session configuration</dd> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the original session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader. Provide the class loader for loading the |
| project, the configuration file and the deployed classes. Pass in true for |
| shouldLoginSession if the session returned should be logged in before |
| returned otherwise false. Pass in true for shouldRefreshSession if the |
| XMLSessionConfigLoader should reparse the configuration file for new |
| sessions. False, will cause the XMLSessionConfigLoader not to parse the |
| file again.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - <a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories"><code>XMLSessionConfigLoader</code></a> containing session configuration</dd> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the original session</dd> |
| <dd><code>shouldLoginSession</code> - whether the session should be logged in</dd> |
| <dd><code>shouldRefreshSession</code> - whether the session should be refreshed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-java.lang.String-java.lang.ClassLoader-boolean-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sessionName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> objectClassLoader, |
| boolean shouldLoginSession, |
| boolean shouldRefreshSession, |
| boolean shouldCheckClassLoader)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader. Provide the class loader for loading the |
| project, the configuration file and the deployed classes. Pass in true for |
| shouldLoginSession if the session returned should be logged in before |
| returned otherwise false. Pass in true for shouldRefreshSession if the |
| XMLSessionConfigLoader should reparse the configuration file for new |
| sessions. False, will cause the XMLSessionConfigLoader not to parse the |
| file again. |
| Pass true for shouldCheckClassLoader will cause the class loader to be compared with the classloader |
| used to load the original session of this name. |
| If they are not the same then the session will be refreshed, this can be used for re-deployment.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - <a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories"><code>XMLSessionConfigLoader</code></a> containing session configuration</dd> |
| <dd><code>sessionName</code> - session name</dd> |
| <dd><code>objectClassLoader</code> - ClassLoader used to load the original session</dd> |
| <dd><code>shouldLoginSession</code> - whether the session should be logged in</dd> |
| <dd><code>shouldRefreshSession</code> - whether the session should be refreshed</dd> |
| <dd><code>shouldCheckClassLoader</code> - whether to compare class loaders used to load given session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession-org.eclipse.persistence.sessions.factories.XMLSessionConfigLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession(<a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories">XMLSessionConfigLoader</a> loader)</pre> |
| <div class="block">PUBLIC: |
| Return the session by name, loading the configuration from the file |
| specified in the loader, using the loading options provided on the loader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - <a href="../../../../../org/eclipse/persistence/sessions/factories/XMLSessionConfigLoader.html" title="class in org.eclipse.persistence.sessions.factories"><code>XMLSessionConfigLoader</code></a> containing session configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>session with given session name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSessions-java.util.concurrent.ConcurrentMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessions</h4> |
| <pre>public void setSessions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a> sessions)</pre> |
| <div class="block">INTERNAL: |
| Set a hashtable of all sessions</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessions</code> - sessions for this session manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>> getSessions()</pre> |
| <div class="block">INTERNAL: |
| Return a hashtable on all sessions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all sessions known by this session manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDefaultSession-org.eclipse.persistence.sessions.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultSession</h4> |
| <pre>public void setDefaultSession(<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> defaultSession)</pre> |
| <div class="block">PUBLIC: |
| Set the default session. |
| If not set the session configuration is stored in a sessions.xml |
| file in a TopLink directory on your classpath. |
| Other sessions are supported through the getSession by name API.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>defaultSession</code> - default session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setManager-org.eclipse.persistence.sessions.factories.SessionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setManager</h4> |
| <pre>public static void setManager(<a href="../../../../../org/eclipse/persistence/sessions/factories/SessionManager.html" title="class in org.eclipse.persistence.sessions.factories">SessionManager</a> theManager)</pre> |
| <div class="block">INTERNAL: |
| Set the singleton session manager. |
| This allows global access to a set of named sessions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>theManager</code> - session manager for current context</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/factories/SessionFactory.html" title="class in org.eclipse.persistence.sessions.factories"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/factories/TableCreatorClassGenerator.html" title="class in org.eclipse.persistence.sessions.factories"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/factories/SessionManager.html" target="_top">Frames</a></li> |
| <li><a href="SessionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |