/*
* Copyright (c) 2017, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.internal;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Objects;
import jakarta.ws.rs.core.Configuration;
import org.glassfish.jersey.internal.spi.AutoDiscoverable;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.model.internal.ManagedObjectsFinalizer;
import org.glassfish.jersey.process.internal.RequestScope;
import org.glassfish.jersey.spi.ContextResolvers;
import org.glassfish.jersey.spi.ExceptionMappers;
A holder that is used only during Jersey bootstrap to keep the instances of the given types and then use them during the
bootstrap. This works as a replacement of an injection framework during a bootstrap and intentionally keeps all needed types in
separate fields to make strong type nature and to preserve a clear view which types are needed to inject to other services.
Author: Petr Bouda
/**
* A holder that is used only during Jersey bootstrap to keep the instances of the given types and then use them during the
* bootstrap. This works as a replacement of an injection framework during a bootstrap and intentionally keeps all needed types in
* separate fields to make strong type nature and to preserve a clear view which types are needed to inject to other services.
*
* @author Petr Bouda
*/
public class BootstrapBag {
private Configuration configuration;
private RequestScope requestScope;
private MessageBodyWorkers messageBodyWorkers;
private ExceptionMappers exceptionMappers;
private ContextResolvers contextResolvers;
private ManagedObjectsFinalizer managedObjectsFinalizer;
private List<AutoDiscoverable> autoDiscoverables;
Gets a list of AutoDiscoverable
. Returns: list of AutoDiscoverable
.
/**
* Gets a list of {@link AutoDiscoverable}.
*
* @return list of {@link AutoDiscoverable}.
*/
public List<AutoDiscoverable> getAutoDiscoverables() {
return autoDiscoverables;
}
Sets a list of AutoDiscoverable
. Params: - autoDiscoverables – list of
AutoDiscoverable
.
/**
* Sets a list of {@link AutoDiscoverable}.
*
* @param autoDiscoverables list of {@code AutoDiscoverable}.
*/
public void setAutoDiscoverables(List<AutoDiscoverable> autoDiscoverables) {
this.autoDiscoverables = autoDiscoverables;
}
Gets an instance of ManagedObjectsFinalizer
. Returns: ManagedObjectsFinalizer
instance.
/**
* Gets an instance of {@link ManagedObjectsFinalizer}.
*
* @return {@code ManagedObjectsFinalizer} instance.
*/
public ManagedObjectsFinalizer getManagedObjectsFinalizer() {
return managedObjectsFinalizer;
}
Sets an instance of ManagedObjectsFinalizer
. Params: - managedObjectsFinalizer –
ManagedObjectsFinalizer
instance.
/**
* Sets an instance of {@link ManagedObjectsFinalizer}.
*
* @param managedObjectsFinalizer {@code ManagedObjectsFinalizer} instance.
*/
public void setManagedObjectsFinalizer(ManagedObjectsFinalizer managedObjectsFinalizer) {
this.managedObjectsFinalizer = managedObjectsFinalizer;
}
Gets an instance of RequestScope
. Returns: RequestScope
instance.
/**
* Gets an instance of {@link RequestScope}.
*
* @return {@code RequestScope} instance.
*/
public RequestScope getRequestScope() {
requireNonNull(requestScope, RequestScope.class);
return requestScope;
}
Sets an instance of RequestScope
. Params: - requestScope –
RequestScope
instance.
/**
* Sets an instance of {@link RequestScope}.
*
* @param requestScope {@code RequestScope} instance.
*/
public void setRequestScope(RequestScope requestScope) {
this.requestScope = requestScope;
}
Gets an instance of MessageBodyWorkers
. Returns: MessageBodyWorkers
instance.
/**
* Gets an instance of {@link MessageBodyWorkers}.
*
* @return {@code MessageBodyWorkers} instance.
*/
public MessageBodyWorkers getMessageBodyWorkers() {
requireNonNull(messageBodyWorkers, MessageBodyWorkers.class);
return messageBodyWorkers;
}
Sets an instance of MessageBodyWorkers
. Params: - messageBodyWorkers –
MessageBodyWorkers
instance.
/**
* Sets an instance of {@link MessageBodyWorkers}.
*
* @param messageBodyWorkers {@code MessageBodyWorkers} instance.
*/
public void setMessageBodyWorkers(MessageBodyWorkers messageBodyWorkers) {
this.messageBodyWorkers = messageBodyWorkers;
}
Gets an instance of Configuration
. Returns: Configuration
instance.
/**
* Gets an instance of {@link Configuration}.
*
* @return {@code Configuration} instance.
*/
public Configuration getConfiguration() {
requireNonNull(configuration, Configuration.class);
return configuration;
}
Sets an instance of Configuration
. Params: - configuration –
Configuration
instance.
/**
* Sets an instance of {@link Configuration}.
*
* @param configuration {@code Configuration} instance.
*/
public void setConfiguration(Configuration configuration) {
this.configuration = configuration;
}
Gets an instance of ExceptionMappers
. Returns: ExceptionMappers
instance.
/**
* Gets an instance of {@link ExceptionMappers}.
*
* @return {@code ExceptionMappers} instance.
*/
public ExceptionMappers getExceptionMappers() {
requireNonNull(exceptionMappers, ExceptionMappers.class);
return exceptionMappers;
}
Sets an instance of ExceptionMappers
. Params: - exceptionMappers –
ExceptionMappers
instance.
/**
* Sets an instance of {@link ExceptionMappers}.
*
* @param exceptionMappers {@code ExceptionMappers} instance.
*/
public void setExceptionMappers(ExceptionMappers exceptionMappers) {
this.exceptionMappers = exceptionMappers;
}
Gets an instance of ContextResolvers
. Returns: ContextResolvers
instance.
/**
* Gets an instance of {@link ContextResolvers}.
*
* @return {@code ContextResolvers} instance.
*/
public ContextResolvers getContextResolvers() {
requireNonNull(contextResolvers, ContextResolvers.class);
return contextResolvers;
}
Sets an instance of ContextResolvers
. Params: - contextResolvers –
ContextResolvers
instance.
/**
* Sets an instance of {@link ContextResolvers}.
*
* @param contextResolvers {@code ContextResolvers} instance.
*/
public void setContextResolvers(ContextResolvers contextResolvers) {
this.contextResolvers = contextResolvers;
}
Check whether the value is not null
that means that the proper BootstrapConfigurator
has not been configured or in a wrong order. Params: - object – tested object.
- type – type of the tested object.
/**
* Check whether the value is not {@code null} that means that the proper {@link BootstrapConfigurator} has not been configured
* or in a wrong order.
*
* @param object tested object.
* @param type type of the tested object.
*/
protected static void requireNonNull(Object object, Type type) {
Objects.requireNonNull(object, type + " has not been added into BootstrapBag yet");
}
}