01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence.spi;
37:
38: import java.security.ProtectionDomain;
39: import java.lang.instrument.IllegalClassFormatException;
40:
41: /**
42: * A persistence provider supplies an instance of this
43: * interface to the {@link PersistenceUnitInfo#addTransformer
44: * PersistenceUnitInfo.addTransformer}
45: * method. The supplied transformer instance will get
46: * called to transform entity class files when they are
47: * loaded or redefined. The transformation occurs before
48: * the class is defined by the JVM.
49: *
50: * @since Java Persistence 1.0
51: */
52: public interface ClassTransformer {
53: /**
54: * Invoked when a class is being loaded or redefined.
55: * The implementation of this method may transform the
56: * supplied class file and return a new replacement class
57: * file.
58: *
59: * @param loader The defining loader of the class to be
60: * transformed, may be null if the bootstrap loader
61: * @param className The name of the class in the internal form
62: * of fully qualified class and interface names
63: * @param classBeingRedefined If this is a redefine, the
64: * class being redefined, otherwise null
65: * @param protectionDomain The protection domain of the
66: * class being defined or redefined
67: * @param classfileBuffer The input byte buffer in class
68: * file format - must not be modified
69: * @return A well-formed class file buffer (the result of
70: * the transform), or null if no transform is performed
71: * @throws IllegalClassFormatException If the input does
72: * not represent a well-formed class file
73: */
74: byte[] transform(ClassLoader loader, String className,
75: Class<?> classBeingRedefined,
76: ProtectionDomain protectionDomain, byte[] classfileBuffer)
77: throws IllegalClassFormatException;
78: }
|