com.sun.faces.cdi.SessionMapProducer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2015 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://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 com.sun.faces.cdi;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import static java.util.Arrays.asList;
import static java.util.Collections.emptySet;
import static java.util.Collections.singleton;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.enterprise.context.RequestScoped;
import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.enterprise.inject.spi.PassivationCapable;
import javax.enterprise.util.AnnotationLiteral;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.context.SessionMap;
/**
*
* The SessionProducer is the CDI producer that allows injection of the session
* map using @Inject.
*
*
* @since 2.3
* @see ExternalContext#getSessionMap()
*/
public class SessionMapProducer extends CdiProducer
implements Bean>, PassivationCapable {
/**
* The set of types that this producer is capable of producing, and hence
* can be used as the type of an injection point.
*/
private final Set types = new HashSet<>(asList(
new ParameterizedTypeImpl(Map.class, new Type[]{String.class, Object.class}),
Map.class,
Object.class));
/**
* Stores our id.
*/
private String id = SessionMapProducer.class.getName();
/**
* Inner class defining an annotation literal for @SessionMap.
*/
public class SessionMapAnnotationLiteral
extends AnnotationLiteral {
@Override
public Class annotationType() {
return SessionMap.class;
}
private static final long serialVersionUID = 1L;
}
/**
* Create the actual instance.
*
* @param creationalContext the creational context.
* @return the Faces context.
*/
@Override
public Map create(CreationalContext> creationalContext) {
checkActive();
return FacesContext.getCurrentInstance().getExternalContext().getSessionMap();
}
/**
* Destroy the instance.
*
*
* Since the FacesContext is a JSF artifact that the JSF runtime really is
* managing the destroy method here does not need to do anything.
*
*
* @param instance the instance.
* @param creationalContext the creational context.
*/
@Override
public void destroy(Map instance, CreationalContext> creationalContext) {
}
/**
* Get the bean class.
*
* @return the bean class.
*/
@Override
public Class getBeanClass() {
return Map.class;
}
/**
* Get the injection points.
*
* @return the injection points.
*/
@Override
public Set getInjectionPoints() {
return emptySet();
}
/**
* Get the name.
*
* @return the name.
*/
@Override
public String getName() {
return "sessionScope";
}
/**
* Get the qualifiers.
*
* @return the qualifiers.
*/
@Override
public Set getQualifiers() {
return singleton((Annotation) new SessionMapAnnotationLiteral());
}
/**
* Get the scope.
*
* @return the scope.
*/
@Override
public Class getScope() {
return RequestScoped.class;
}
/**
* Get the stereotypes.
*
* @return the stereotypes.
*/
@Override
public Set> getStereotypes() {
return emptySet();
}
/**
* Get the types.
*
* @return the types.
*/
@Override
public Set getTypes() {
return types;
}
/**
* Is this an alternative.
*
* @return false.
*/
@Override
public boolean isAlternative() {
return false;
}
/**
* Is this nullable.
*
* @return false.
*/
@Override
public boolean isNullable() {
return false;
}
/**
* Get the id.
*
* @return the id.
*/
@Override
public String getId() {
return id;
}
}