| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>SharedClassTokenHelper (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.sharedclasses, package: com.ibm.oti.shared, interface: SharedClassTokenHelper"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.oti.shared.SharedClassTokenHelper interface"> |
| <meta name="keywords" content="findSharedClass()"> |
| <meta name="keywords" content="storeSharedClass()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/SharedClassTokenHelper.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">openj9.sharedclasses</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.oti.shared</a></div> |
| <h1 title="Interface SharedClassTokenHelper" class="title">Interface SharedClassTokenHelper</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></code>, <code><a href="SharedHelper.html" title="interface in com.ibm.oti.shared">SharedHelper</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SharedClassTokenHelper</span><span class="extends-implements"> |
| extends <a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></span></div> |
| <div class="block"><p>SharedClassHelper API that stores and finds classes using String tokens.</p> |
| <h2>Description</h2> |
| <p>A SharedClassTokenHelper is obtained by calling getTokenHelper(ClassLoader) on a SharedClassHelperFactory.</p> |
| <p>The SharedClassTokenHelper, which is the most simple type of helper, uses generated String tokens to find and store classes.</p> |
| <h2>Usage</h2> |
| <p>The ClassLoader should call findSharedClass after looking in its local cache and asking its parent (if one exists). |
| If findSharedClass does not return null, the ClassLoader calls defineClass on the byte[] that is returned.</p> |
| <p>The ClassLoader calls storeSharedClass immediately after a class is defined, unless the class that is being defined was loaded from the shared cache.</p> |
| <p>The ClassLoader is responsible for coordinating the creation of token Strings.</p> |
| <h2>Dynamic cache updates.</h2> |
| <p>Because the shared cache persists beyond the lifetime of a JVM, classes in the shared cache can become out of date (stale). |
| Using this helper, it is entirely the responsibility of the ClassLoader to ensure that cache entries are kept up-to-date. |
| Tokens have no meaning to the cache, so effectively turn the it into a dictionary of classes.</p> |
| <p>For example, a token may be the location where the class was found, combined with some type of versioning data.</p> |
| <p>If a ClassLoader stores multiple versions of the same class by using the same token, only the most recent will be returned by findSharedClass. </p> |
| <h2>Security</h2> |
| <p>A SharedClassHelper will only allow classes to be stored in the cache which were defined by the ClassLoader that owns the SharedClassHelper.</p> |
| <p>If a SecurityManager is installed, SharedClassPermissions must be used to permit read/write access to the shared class cache. |
| Permissions are granted by ClassLoader classname in the java.policy file and are fixed when the SharedClassHelper is created.</p> |
| <p>Note also that if the createClassLoader RuntimePermission is not granted, ClassLoaders cannot be created, |
| which in turn means that SharedClassHelpers cannot be created.</p> |
| <h2>Compatibility with other SharedClassHelpers</h2> |
| <p>Classes stored using the SharedClassTokenHelper cannot be retrieved using any other type of helper, and vice versa. </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassHelper</code></a>, |
| <a href="SharedClassHelperFactory.html" title="interface in com.ibm.oti.shared"><code>SharedClassHelperFactory</code></a>, |
| <a href="SharedClassPermission.html" title="class in com.ibm.oti.shared"><code>SharedClassPermission</code></a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#findSharedClass(java.lang.String,java.lang.String)">findSharedClass</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> token, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> className)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Finds a class in the shared cache by using a specific token and class name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#storeSharedClass(java.lang.String,java.lang.Class)">storeSharedClass</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> token, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Stores a class in the shared cache by using a specific token.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.oti.shared.SharedClassHelper">Methods declared in interface com.ibm.oti.shared.<a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></h3> |
| <code><a href="SharedClassHelper.html#getSharingFilter()">getSharingFilter</a>, <a href="SharedClassHelper.html#setSharingFilter(com.ibm.oti.shared.SharedClassFilter)">setSharingFilter</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.oti.shared.SharedHelper">Methods declared in interface com.ibm.oti.shared.<a href="SharedHelper.html" title="interface in com.ibm.oti.shared">SharedHelper</a></h3> |
| <code><a href="SharedHelper.html#getClassLoader()">getClassLoader</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="findSharedClass(java.lang.String,java.lang.String)"> |
| <h3>findSharedClass</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">findSharedClass</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> token, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> className)</span></div> |
| <div class="block">Finds a class in the shared cache by using a specific token and class name.<p> |
| A class will be returned only for an exact String match of both the token and class name. |
| Otherwise, null is returned.<br> |
| To obtain an instance of the class, the byte[] returned must be passed to defineClass by the caller ClassLoader. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>token</code> - String. |
| A token generated by the ClassLoader</dd> |
| <dd><code>className</code> - String. |
| The name of the class to be found</dd> |
| <dt>Returns:</dt> |
| <dd>byte[]. |
| A byte array describing the class found, or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="storeSharedClass(java.lang.String,java.lang.Class)"> |
| <h3>storeSharedClass</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">storeSharedClass</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> token, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?> clazz)</span></div> |
| <div class="block">Stores a class in the shared cache by using a specific token.<p> |
| The class that is being stored must have been defined by the caller ClassLoader.<br> |
| Returns <code>true</code> if the class is stored successfully or false otherwise.<br> |
| Will return <code>false</code> if the class that is being stored was not defined by the caller ClassLoader. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>token</code> - String. |
| A token generated by the ClassLoader</dd> |
| <dd><code>clazz</code> - Class. |
| The class to store in the shared cache</dd> |
| <dt>Returns:</dt> |
| <dd>boolean. |
| True if the class was stored successfully, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
