All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.glassfish.jersey.internal.inject.AbstractBinder Maven / Gradle / Ivy

    Go to download

    A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

    There is a newer version: 3.1.10
    Show newest version
    /*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2017 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.internal.inject;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.function.Supplier;
import java.util.stream.Collectors;

import javax.ws.rs.core.GenericType;

/**
 * Implementation of {@link Binder} interface dedicated to keep some level of code compatibility between previous HK2
 * implementation and new DI SPI.
 * 
    
 * Currently, there are supported only bind method and more complicated method where HK2 interfaces are required were omitted.
 *
 * @author Petr Bouda (petr.bouda at oracle.com)
 */
public abstract class AbstractBinder implements Binder {

    private List bindings = new ArrayList<>();

    private List installed = new ArrayList<>();

    /**
     * Implement to provide binding definitions using the exposed binding methods.
     */
    protected abstract void configure();

    /**
     * Start building a new class-based service binding.
     * 
    
     * Does NOT bind the service type itself as a contract type.
     *
     * @param          service type.
     * @param serviceType service class.
     * @return initialized binding builder.
     */
    public  ClassBinding bind(Class serviceType) {
        ClassBinding descriptor = Bindings.service(serviceType);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Start building a new class-based service binding.
     * 
    
     * Binds the service type itself as a contract type.
     *
     * @param          service type.
     * @param serviceType service class.
     * @return initialized binding builder.
     */
    public  ClassBinding bindAsContract(Class serviceType) {
        ClassBinding descriptor = Bindings.serviceAsContract(serviceType);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Start building a new generic type-based service binding.
     * 
    
     * Binds the generic service type itself as a contract type.
     *
     * @param          service type.
     * @param serviceType generic service type information.
     * @return initialized binding builder.
     */
    public  ClassBinding bindAsContract(GenericType serviceType) {
        ClassBinding descriptor = Bindings.service(serviceType);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Start building a new generic type-based service binding.
     * 
    
     * Binds the generic service type itself as a contract type.
     *
     * @param serviceType generic service type information.
     * @return initialized binding builder.
     */
    public ClassBinding bindAsContract(Type serviceType) {
        ClassBinding descriptor = Bindings.serviceAsContract(serviceType);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Start building a new instance-based service binding. The binding is naturally
     * considered to be a {@link javax.inject.Singleton singleton-scoped}.
     * 
    
     * Does NOT bind the service type itself as a contract type.
     *
     * @param      service type.
     * @param service service instance.
     * @return initialized binding builder.
     */
    public  InstanceBinding bind(T service) {
        InstanceBinding descriptor = Bindings.service(service);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Start building a new supplier class-based service binding.
     *
     * @param            service type.
     * @param supplierType  service supplier class.
     * @param supplierScope factory scope.
     * @return initialized binding builder.
     */
    public  SupplierClassBinding bindFactory(
            Class> supplierType, Class supplierScope) {
        SupplierClassBinding binding = Bindings.supplier(supplierType, supplierScope);
        bindings.add(binding);
        return binding;
    }

    /**
     * Start building a new supplier class-based service binding.
     * 
    
     * The supplier itself is bound in a per-lookup scope.
     *
     * @param           service type.
     * @param supplierType service supplier class.
     * @return initialized binding builder.
     */
    public  SupplierClassBinding bindFactory(Class> supplierType) {
        SupplierClassBinding binding = Bindings.supplier(supplierType);
        bindings.add(binding);
        return binding;
    }

    /**
     * Start building a new supplier instance-based service binding.
     *
     * @param      service type.
     * @param factory service instance.
     * @return initialized binding builder.
     */
    public  SupplierInstanceBinding bindFactory(Supplier factory) {
        SupplierInstanceBinding binding = Bindings.supplier(factory);
        bindings.add(binding);
        return binding;
    }

    /**
     * Start building a new injection resolver binding. The injection resolver is naturally
     * considered to be a {@link javax.inject.Singleton singleton-scoped}.
     * 
    
     * There is no need to provide any additional information. Other method on {@link Binding}
     * will be ignored.
     *
     * @param         type of the injection resolver.
     * @param resolver   injection resolver instance.
     * @return initialized binding builder.
     */
    public  InjectionResolverBinding bind(T resolver) {
        InjectionResolverBinding descriptor = Bindings.injectionResolver(resolver);
        bindings.add(descriptor);
        return descriptor;
    }

    /**
     * Adds all binding definitions from the binders to the binding configuration.
     *
     * @param binders binders whose binding definitions should be configured.
     */
    public final void install(AbstractBinder... binders) {
        Arrays.stream(binders)
                .filter(Objects::nonNull)
                .forEach(installed::add);
    }

    /**
     * Gets a collection of descriptors registered in this jersey binder.
     *
     * @return collection of descriptors.
     */
    public Collection getBindings() {
        return flatten(this).stream()
                .flatMap(binder -> binder.bindings.stream())
                .collect(Collectors.toList());
    }


    private static List flatten(AbstractBinder binder) {
        List binders = new ArrayList<>();
        flatten(binder, binders);
        return binders;
    }

    private static void flatten(AbstractBinder binder, List binders) {
        binder.configure();

        if (binder.installed.size() > 0) {
            binder.installed.forEach(b -> flatten(b, binders));
        }

        binders.add(binder);
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy