blob: ee76d992ec0db2081f31a47bfbef9543860d2c39 [file] [log] [blame]
<!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 -->
<title>com.ibm.oti.shared (OpenJ9 Shared Classes)</title>
<meta name="keywords" content="com.ibm.oti.shared package">
<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="com.ibm.oti.shared (OpenJ9 Shared Classes)";
}
}
catch(err) {
}
//-->
</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="../../../../com/ibm/oti/shared/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Shared Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/oti/shared/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.ibm.oti.shared</h1>
<div class="docSummary">
<div class="block">The OpenJ9 shared classes API, a persistent share which can contain classes, precompiled code (AOT),
JIT data, and other data used to improve start up performance and reduce memory footprint.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a></td>
<td class="colLast">
<div class="block">SharedClassFilter allows users of a Helper API to filter which classes are found and stored in the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></td>
<td class="colLast">
<div class="block">The SharedClassHelper superinterface defines functions that are common
to all class helpers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html" title="interface in com.ibm.oti.shared">SharedClassHelperFactory</a></td>
<td class="colLast">
<div class="block">SharedClassHelperFactory provides an interface that is
used to create various types of SharedClassHelper for ClassLoaders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></td>
<td class="colLast">
<div class="block">SharedClassHelper API that stores and finds classes using String tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></td>
<td class="colLast">
<div class="block">SharedClassHelper API that stores and finds classes by using URL classpaths.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.IndexHolder.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper.IndexHolder</a></td>
<td class="colLast">
<div class="block">Interface that allows an index to be returned from findSharedClass calls.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></td>
<td class="colLast">
<div class="block">SharedClassHelper API that stores and finds classes by using URL paths.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedDataHelper.html" title="interface in com.ibm.oti.shared">SharedDataHelper</a></td>
<td class="colLast">
<div class="block">SharedDataHelper API that stores and finds byte data using String tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedDataHelperFactory.html" title="interface in com.ibm.oti.shared">SharedDataHelperFactory</a></td>
<td class="colLast">
<div class="block">SharedDataHelperFactory provides an interface used to create SharedDataHelpers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedHelper.html" title="interface in com.ibm.oti.shared">SharedHelper</a></td>
<td class="colLast">
<div class="block">The SharedHelper superinterface defines functions common to all helpers.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/Shared.html" title="class in com.ibm.oti.shared">Shared</a></td>
<td class="colLast">
<div class="block">Global class that provides SharedClassHelperFactory, SharedDataHelperFactory and sharing status.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedAbstractHelper.html" title="class in com.ibm.oti.shared">SharedAbstractHelper</a></td>
<td class="colLast">
<div class="block">SharedAbstractHelper provides common functions and data to helper subclasses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedAbstractHelperFactory.html" title="class in com.ibm.oti.shared">SharedAbstractHelperFactory</a></td>
<td class="colLast">
<div class="block">SharedAbstractHelperFactory is an abstract superclass for helper factory subclasses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassAbstractHelper.html" title="class in com.ibm.oti.shared">SharedClassAbstractHelper</a></td>
<td class="colLast">
<div class="block">SharedClassAbstractHelper provides common functions and data to class helper subclasses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html" title="class in com.ibm.oti.shared">SharedClassCacheInfo</a></td>
<td class="colLast">
<div class="block">SharedClassCacheInfo stores information about a shared class cache and
provides methods to retrieve that information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassesNamedPermission.html" title="class in com.ibm.oti.shared">SharedClassesNamedPermission</a></td>
<td class="colLast">
<div class="block">This class defines shared cache permissions as described in the table below.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassPermission.html" title="class in com.ibm.oti.shared">SharedClassPermission</a></td>
<td class="colLast">
<div class="block">SharedClassPermission provides security permission to govern ClassLoader access to the shared class cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassPermissionCollection.html" title="class in com.ibm.oti.shared">SharedClassPermissionCollection</a></td>
<td class="colLast">
<div class="block">SharedClassPermissionCollection provides permission collection to support SharedClassPermission</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassStatistics.html" title="class in com.ibm.oti.shared">SharedClassStatistics</a></td>
<td class="colLast">
<div class="block">SharedClassStatistics provides static functions that report basic cache statistics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html" title="class in com.ibm.oti.shared">SharedClassUtilities</a></td>
<td class="colLast">
<div class="block">SharedClassUtilities provides APIs to get information about all shared class caches in a directory and
to destroy a particular shared class cache.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/CannotSetClasspathException.html" title="class in com.ibm.oti.shared">CannotSetClasspathException</a></td>
<td class="colLast">
<div class="block">Exception thrown if an attempt is made to modify confirmed elements of a
classpath in SharedClassURLClasspathHelper.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></td>
<td class="colLast">
<div class="block">Exception thrown if a factory is asked to get multiple helpers for a ClassLoader.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.ibm.oti.shared Description">Package com.ibm.oti.shared Description</h2>
<div class="block">The OpenJ9 shared classes API, a persistent share which can contain classes, precompiled code (AOT),
JIT data, and other data used to improve start up performance and reduce memory footprint.</div>
</div>
<!-- ======= 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="../../../../com/ibm/oti/shared/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Shared Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/oti/shared/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</body>
</html>