Hk2CustomBoundTypesProvider.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014-2015 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
 * http://glassfish.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.jersey.ext.cdi1x.spi;

import java.lang.reflect.Type;
import java.util.Set;

/**
 * Helper SPI to help specify Jersey HK2 custom bound types that should
 * be HK2-injectable into CDI components.
 *
 * <p>Implementation of this type must be registered via META-INF/services
 * mechanism. I.e. fully qualified name of an implementation class
 * must be written into <code>META-INF/services/org.glassfish.jersey.ext.cdi11.spi.Hk2CustomBoundTypesProvider</code>
 * file.
 *
 * <p>If more than one implementation is found, only a single one is selected that has the highest priority.
 *
 * @author Jakub Podlesak (jakub.podlesak at oracle.com)
 */
public interface Hk2CustomBoundTypesProvider {

    /**
     * Provide a set of types that should became accessible
     * by CDI container in a form of CDI beans backed by HK2.
     *
     * <p>Jersey will ask CDI container to veto these types
     * and will register HK2 backed beans into CDI, so that @{@link javax.inject.Inject}
     * marked injection points could be satisfied.
     *
     * <p>The end user is responsible for defining necessary HK2 bindings
     * within Jersey application. Should any of such bindings remain
     * undefined, runtime errors are likely to occur.
     *
     * @return set of types for which HK2 backed CDI beans shall be registered.
     */
    public Set<Type> getHk2Types();
}