org.glassfish.hk2.api.HK2Invocation Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.hk2.api;
/**
* This is an interface that is also implemented by the
* {@link org.aopalliance.intercept.MethodInvocation} object
* passed to the invoke method of {@link org.aopalliance.intercept.MethodInterceptor}
* and the {@link org.aopalliance.intercept.ConstructorInvocation} object
* passed to the invoke method of {@link org.aopalliance.intercept.ConstructorInterceptor}.
* It allows HK2 users of the AOP interception feature to easily pass
* data between interceptors on the same invocatio stack
*
* @author jwells
*
*/
public interface HK2Invocation {
/**
* Sets the user data to be associated with the invocation
* frame. The key may not be null. If data is null
* then the data associated with the key is removed
*
* @param key a non-null identifier for user data to be
* associated with the invocation frame
* @param data possibly null data. If non-null it
* will replace any value previously associated with
* the key. If null it will remove the key from the
* map
*/
public void setUserData(String key, Object data);
/**
* Gets the user data associated with the given key
*
* @param key The key for which to get data. May
* not be null
* @return The user data previously associated with
* this key, or null if there was no user data
* associated with this key
*/
public Object getUserData(String key);
}