org.glassfish.jersey.internal.BootstrapConfigurator Maven / Gradle / Ivy
Show all versions of jersey-common Show documentation
/*
* 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
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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;
import org.glassfish.jersey.internal.inject.InjectionManager;
/**
* Configurator which contains two methods, {@link #init(InjectionManager, BootstrapBag)} contains {@link InjectionManager}
* into which only registering services make sense because injection manager has not been completed yet and
* {@link #postInit(InjectionManager, BootstrapBag)} in which {@link InjectionManager} has been already completed and is able to
* create and provide services.
*
* The configurators should register instances into {@link InjectionManager} only if the instance must be really injectable if
* the instance can be used internally without the injection, then extend {@link BootstrapBag} and propagate the instance to
* correct services using constructors or methods in a phase of Jersey initialization.
*
* @author Petr Bouda
*/
public interface BootstrapConfigurator {
/**
* Pre-initialization method should only register services into {@link InjectionManager} and populate {@link BootstrapBag}.
*
* @param injectionManager not completed injection manager.
* @param bootstrapBag bootstrap bag with services used in following processing.
*/
void init(InjectionManager injectionManager, BootstrapBag bootstrapBag);
/**
* Post-initialization method can get services from {@link InjectionManager} and is not able to register the new one because
* injection manager is already completed.
*
* @param injectionManager already completed injection manager.
* @param bootstrapBag bootstrap bag with services used in following processing.
*/
default void postInit(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
}
}