org.jboss.weld.bootstrap.api.Environments Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.weld.bootstrap.api;
import java.util.HashSet;
import java.util.Set;
import org.jboss.weld.injection.spi.EjbInjectionServices;
import org.jboss.weld.injection.spi.InjectionServices;
import org.jboss.weld.injection.spi.JpaInjectionServices;
import org.jboss.weld.injection.spi.ResourceInjectionServices;
import org.jboss.weld.resources.spi.ResourceLoader;
import org.jboss.weld.security.spi.SecurityServices;
import org.jboss.weld.transaction.spi.TransactionServices;
/**
* Requirements for various well known environments.
*
* @author Pete Muir
*
*/
public enum Environments implements Environment {
/**
* Java EE5 or Java EE6
*
* In this environment, Weld requires that {@link JpaInjectionServices}, {@link ResourceInjectionServices} and
* {@link EjbInjectionServices} are present, and so will perform EE-style field injection on managed beans itself
*/
EE_INJECT(new EnvironmentBuilder().addRequiredDeploymentService(TransactionServices.class)
.addRequiredDeploymentService(SecurityServices.class)
/*
* EjbServices is a required bean deployment archive service in this environment.
* For backwards compatibility with older integrators that register EjbServices
* as a deployment service, this check is suppressed.
*
* @see WELD-1685
*/
// .addRequiredBeanDeploymentArchiveService(EjbServices.class)
.addRequiredBeanDeploymentArchiveService(ResourceLoader.class)
.addRequiredBeanDeploymentArchiveService(JpaInjectionServices.class)
.addRequiredBeanDeploymentArchiveService(ResourceInjectionServices.class)
.addRequiredBeanDeploymentArchiveService(EjbInjectionServices.class)),
/**
* Java EE5 or Java EE6
*
* In this environment, Weld requires that {@link InjectionServices} are present, and expects the container to use this
* callback to perform EE-style injection
*
*/
EE(new EnvironmentBuilder().addRequiredDeploymentService(TransactionServices.class)
.addRequiredDeploymentService(SecurityServices.class)
/*
* EjbServices is a required bean deployment archive service in this environment.
* For backwards compatibility with older integrators that register EjbServices
* as a deployment service, this check is suppressed.
*
* @see WELD-1685
*/
// .addRequiredBeanDeploymentArchiveService(EjbServices.class)
.addRequiredBeanDeploymentArchiveService(ResourceLoader.class)
.addRequiredBeanDeploymentArchiveService(InjectionServices.class)),
/**
* Servlet container such as Tomcat
*/
SERVLET(new EnvironmentBuilder()
.addRequiredBeanDeploymentArchiveService(ResourceLoader.class)),
/**
* Java SE
*/
SE(new EnvironmentBuilder()
.addRequiredBeanDeploymentArchiveService(ResourceLoader.class));
private final Set> requiredDeploymentServices;
private final Set> requiredBeanDeploymentArchiveServices;
private Environments(EnvironmentBuilder builder) {
this.requiredDeploymentServices = builder.getRequiredDeploymentServices();
this.requiredBeanDeploymentArchiveServices = builder.getRequiredBeanDeploymentArchiveServices();
}
public Set> getRequiredDeploymentServices() {
return requiredDeploymentServices;
}
public Set> getRequiredBeanDeploymentArchiveServices() {
return requiredBeanDeploymentArchiveServices;
}
private static class EnvironmentBuilder {
private final Set> requiredDeploymentServices;
private final Set> requiredBeanDeploymentArchiveServices;
private EnvironmentBuilder() {
this.requiredBeanDeploymentArchiveServices = new HashSet>();
this.requiredDeploymentServices = new HashSet>();
}
private Set> getRequiredBeanDeploymentArchiveServices() {
return requiredBeanDeploymentArchiveServices;
}
private Set> getRequiredDeploymentServices() {
return requiredDeploymentServices;
}
private EnvironmentBuilder addRequiredDeploymentService(Class service) {
this.requiredDeploymentServices.add(service);
return this;
}
private EnvironmentBuilder addRequiredBeanDeploymentArchiveService(Class service) {
this.requiredBeanDeploymentArchiveServices.add(service);
return this;
}
}
}