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.interceptor;
37:
38: import java.lang.reflect.Method;
39: import java.util.Map;
40:
41: /**
42: * Context information passed to AroundInvoke and
43: * Interceptor-class lifecycle callback methods.
44: */
45: public interface InvocationContext {
46:
47: /**
48: * Returns the target instance.
49: */
50: public Object getTarget();
51:
52: /**
53: * Returns the method of the bean class for which the interceptor
54: * was invoked. For AroundInvoke methods, this is the business
55: * method on the bean class. For lifecycle callback methods,
56: * returns null.
57: */
58: public Method getMethod();
59:
60: /**
61: * Returns the parameters that will be used to invoke
62: * the business method. If setParameters has been called,
63: * getParameters() returns the values to which the parameters
64: * have been set.
65: *
66: * @exception java.lang.IllegalStateException if invoked within
67: * a lifecycle callback method.
68: */
69: public Object[] getParameters();
70:
71: /**
72: * Sets the parameters that will be used to invoke the
73: * business method.
74: *
75: * @exception java.lang.IllegalStateException if invoked within
76: * a lifecycle callback method.
77: *
78: * @exception java.lang.IllegalArgumentException if the parameter types do not match
79: * the types for the business method, or the number of parameters supplied does not
80: * equal the number of parameters for the business method.
81: */
82: public void setParameters(Object[] params);
83:
84: /**
85: * Returns the context data associated with this invocation or
86: * lifecycle callback. If there is no context data, an
87: * empty Map<String,Object> object will be returned.
88: */
89: public Map<String, Object> getContextData();
90:
91: /**
92: * Proceed to the next entry in the interceptor chain.
93: * The proceed method returns the result of the next
94: * method invoked. If the method returns void, proceed
95: * returns null.
96: */
97: public Object proceed() throws Exception;
98:
99: }
|