org.glassfish.jersey.server.internal.inject.ParameterInjectionBinder Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011-2013 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.server.internal.inject;

import javax.ws.rs.BeanParam;
import javax.ws.rs.CookieParam;
import javax.ws.rs.FormParam;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.container.Suspended;
import javax.ws.rs.ext.ParamConverterProvider;

import javax.inject.Singleton;

import org.glassfish.jersey.server.Uri;
import org.glassfish.jersey.server.spi.internal.ValueFactoryProvider;

import org.glassfish.hk2.api.InjectionResolver;
import org.glassfish.hk2.api.TypeLiteral;
import org.glassfish.hk2.utilities.binding.AbstractBinder;

/**
 * Injection binder providing support for JAX-RS and Jersey injection annotations.
 * Namely, standard injection support for the following set of JAX-RS and Jersey
 * annotations is provided by the binder:
 * 
 *
 * {@link javax.ws.rs.core.Context @Context}
 * 
 * Generic support for the {@code @Context}-based injection is provided so that
 * the {@code @Context} annotation can be used interchangeably with e.g. standard
 * {@code @Inject} dependency injection annotation.
 * 
 *
 * {@link javax.ws.rs.CookieParam @CookieParam}
 * 
 * Support for cookie parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.FormParam @FormParam}
 * 
 * Support for form parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.HeaderParam @HeaderParam}
 * 
 * Support for request header parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.MatrixParam @MatrixParam}
 * 
 * Support for request URI matrix path parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.PathParam @PathParam}
 * 
 * Support for request URI path parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.QueryParam @QueryParam}
 * 
 * Support for request URI query parameter injection as defined by the JAX-RS specification.
 * 
 *
 * {@link javax.ws.rs.container.Suspended @Suspended}
 * 
 * Support for {@link javax.ws.rs.container.AsyncResponse} injection as defined by the JAX-RS specification.
 * 
 *
 * {@link org.glassfish.jersey.server.Uri @Uri}
 * 
 * Jersey-specific support for {@link javax.ws.rs.client.WebTarget} injection.
 * 
 *
 * 
 *
 * @author Marek Potociar (marek.potociar at oracle.com)
 */
public class ParameterInjectionBinder extends AbstractBinder {

    @Override
    public void configure() {
        // Param converter providers
        bind(ParamConverters.AggregatedProvider.class).to(ParamConverterProvider.class).in(Singleton.class);
        bindAsContract(ParamConverterFactory.class).in(Singleton.class);

        // Parameter injection value extractor providers
        bind(MultivaluedParameterExtractorFactory.class).to(MultivaluedParameterExtractorProvider.class).in(Singleton.class);

        // Parameter injection value providers
        bind(AsyncResponseValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(CookieParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(DelegatedInjectionValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(EntityParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(FormParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(HeaderParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(MatrixParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(PathParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(QueryParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(WebTargetValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);
        bind(BeanParamValueFactoryProvider.class).to(ValueFactoryProvider.class).in(Singleton.class);

        // Injection resolvers
        bind(CookieParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(FormParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(HeaderParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(MatrixParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(QueryParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(PathParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(AsyncResponseValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(WebTargetValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);
        bind(BeanParamValueFactoryProvider.InjectionResolver.class).to(new TypeLiteral>() {
        }).in(Singleton.class);

    }
}