You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2013/10/21 20:49:49 UTC
svn commit: r1534318 -
/tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html
Author: markt
Date: Mon Oct 21 18:49:48 2013
New Revision: 1534318
URL: http://svn.apache.org/r1534318
Log:
Add missing doc
Added:
tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html (with props)
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html?rev=1534318&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html Mon Oct 21 18:49:48 2013
@@ -0,0 +1,283 @@
+<!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 (version 1.7.0_40) on Wed Oct 16 14:51:52 BST 2013 -->
+<title>InstrumentableClassLoader (Apache Tomcat 8.0.0-RC5 API Documentation)</title>
+<meta name="date" content="2013-10-16">
+<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="InstrumentableClassLoader (Apache Tomcat 8.0.0-RC5 API Documentation)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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"><em><b>Apache Tomcat 8.0.0-RC5</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../org/apache/tomcat/InstanceManager.html" title="interface in org.apache.tomcat"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../org/apache/tomcat/JarScanFilter.html" title="interface in org.apache.tomcat"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?org/apache/tomcat/InstrumentableClassLoader.html" target="_top">Frames</a></li>
+<li><a href="InstrumentableClassLoader.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>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.apache.tomcat</div>
+<h2 title="Interface InstrumentableClassLoader" class="title">Interface InstrumentableClassLoader</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../org/apache/catalina/loader/WebappClassLoader.html" title="class in org.apache.catalina.loader">WebappClassLoader</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">InstrumentableClassLoader</span></pre>
+<div class="block">Specifies a class loader capable of being decorated with
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument"><code>ClassFileTransformer</code></a>s. These transformers can instrument
+ (or weave) the byte code of classes loaded through this class loader
+ to alter their behavior. Currently only
+ <a href="../../../org/apache/catalina/loader/WebappClassLoader.html" title="class in org.apache.catalina.loader"><code>WebappClassLoader</code></a> implements this
+ interface. This allows web application frameworks or JPA providers
+ bundled with a web application to instrument web application classes
+ as necessary.
+ <p>
+ You should always program against the methods of this interface
+ (whether using reflection or otherwise). The methods in
+ <code>WebappClassLoader</code> are protected by the default security
+ manager if one is in use.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>8.0, 7.0.44</dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/tomcat/InstrumentableClassLoader.html#addTransformer(java.lang.instrument.ClassFileTransformer)">addTransformer</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a> transformer)</code>
+<div class="block">Adds the specified class file transformer to this class loader.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a></code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/tomcat/InstrumentableClassLoader.html#copyWithoutTransformers()">copyWithoutTransformers</a></strong>()</code>
+<div class="block">Returns a copy of this class loader without any class file
+ transformers.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/tomcat/InstrumentableClassLoader.html#removeTransformer(java.lang.instrument.ClassFileTransformer)">removeTransformer</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a> transformer)</code>
+<div class="block">Removes the specified class file transformer from this class loader.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="addTransformer(java.lang.instrument.ClassFileTransformer)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addTransformer</h4>
+<pre>void addTransformer(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a> transformer)</pre>
+<div class="block">Adds the specified class file transformer to this class loader. The
+ transformer will then be able to instrument the bytecode of any
+ classes loaded by this class loader after the invocation of this
+ method.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transformer</code> - The transformer to add to the class loader</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the transformer is null.</dd></dl>
+</li>
+</ul>
+<a name="removeTransformer(java.lang.instrument.ClassFileTransformer)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeTransformer</h4>
+<pre>void removeTransformer(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a> transformer)</pre>
+<div class="block">Removes the specified class file transformer from this class loader.
+ It will no longer be able to instrument the byte code of any classes
+ loaded by the class loader after the invocation of this method.
+ However, any classes already instrumented by this transformer before
+ this method call will remain in their instramented state.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transformer</code> - The transformer to remove</dd></dl>
+</li>
+</ul>
+<a name="copyWithoutTransformers()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>copyWithoutTransformers</h4>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> copyWithoutTransformers()</pre>
+<div class="block">Returns a copy of this class loader without any class file
+ transformers. This is a tool often used by Java Persistence API
+ providers to inspect entity classes in the absence of any
+ instrumentation, something that can't be guaranteed within the
+ context of a <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument"><code>ClassFileTransformer</code></a>'s
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true#transform(java.lang.ClassLoader, java.lang.String, java.lang.Class, java.security.ProtectionDomain, byte[])" title="class or interface in java.lang.instrument"><code>transform</code></a> method.
+ <p>
+ The returned class loader's resource cache will have been cleared
+ so that classes already instrumented will not be retained or
+ returned.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the transformer-free copy of this class loader.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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"><em><b>Apache Tomcat 8.0.0-RC5</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../org/apache/tomcat/InstanceManager.html" title="interface in org.apache.tomcat"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../org/apache/tomcat/JarScanFilter.html" title="interface in org.apache.tomcat"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?org/apache/tomcat/InstrumentableClassLoader.html" target="_top">Frames</a></li>
+<li><a href="InstrumentableClassLoader.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>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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 © 2000-2013 Apache Software Foundation. All Rights Reserved.</small></p>
+</body>
+</html>
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/api/org/apache/tomcat/InstrumentableClassLoader.html
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org