org.jvnet.hk2.component.ContextualFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of auto-depends Show documentation
${project.name}
The newest version!
/*
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2007-2010 Sun Microsystems, Inc. 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.html
 * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.jvnet.hk2.component;

import java.security.AccessControlContext;

import org.jvnet.hk2.annotations.Contract;

/**
 * Extension to the simple Factory that supports contextual injection.
 * 
 * 
 * Users who wish to use this should note that there is a slight
 * degradation of performance in using this feature since the implementation
 * needs to track various thread local context data for each injection
 * point that is undergoing injection by the system.
 * 
 * @author Jeff Trent
 * @see InjectionPoint
 */
@Contract
public interface ContextualFactory extends org.glassfish.hk2.Factory {
  /**
   * The system calls this method to obtain a reference to the component when
   * injection point context information is available.
   * 
   * 
   * Note that injection point context information is not currently supported for use with {@link Holder} injections.
   * 
   * @param injectionPoint the injection point for which the return object will be injected
   * @param acc the caller's access control context that can be used to make access control decisions
   */
  T getObject(InjectionPoint injectionPoint, AccessControlContext acc) throws ComponentException;
}