org.omnifaces.config

Enum BeanManager

java.lang.Object

java.lang.Enum<BeanManager>

org.omnifaces.config.BeanManager

All Implemented Interfaces:

Serializable, Comparable<BeanManager>

public enum BeanManager
extends Enum<BeanManager>

This configuration enum allows you to get the CDI BeanManager anyway in cases where @Inject and/or CDI#current() may not work, or when you'd like to test availability of CDI without having any direct CDI dependency (as done in ApplicationListener). It will during initialization grab the CDI bean manager instance as generic object from JNDI.

Do not use it directly. Use Beans utility class instead. It will under the covers use this configuration enum. This configuration enum is basically a leftover from OmniFaces 1.x where the CDI dependency was optional. The getReference(Class) method is deprecated since OmniFaces 2.3 and will be removed in OmniFaces 3.0.

Since:

1.6.1

Author:

Bauke Scholtz

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Returns the lazily loaded enum singleton instance.

Method Summary

Modifier and Type	Method and Description
<T> T	get() Returns the CDI bean manager.
<T> T	getReference(Class<T> beanClass) Deprecated. Use Beans.getReference(Class) instead.
void	init(ServletContext servletContext) Perform manual initialization whereby the bean manager is looked up from servlet context when not available.
static BeanManager	valueOf(String name) Returns the enum constant of this type with the specified name.
static BeanManager[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final BeanManager INSTANCE

Returns the lazily loaded enum singleton instance. Throws IllegalStateException when initialization fails.

Method Detail

values

public static BeanManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BeanManager c : BeanManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BeanManager valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

init

public void init(ServletContext servletContext)

Perform manual initialization whereby the bean manager is looked up from servlet context when not available.

Parameters:

servletContext - The servlet context to obtain the BeanManager from, if necessary.

Throws:

IllegalStateException - When initialization fails.

get

public <T> T get()

Returns the CDI bean manager. It's preferred that you use Beans.getManager() for this.

Type Parameters:

T - The javax.enterprise.inject.spi.BeanManager.

Returns:

The CDI bean manager.

Throws:

ClassCastException - When you assign it to a variable which is not declared as CDI BeanManager.

getReference

@Deprecated
public <T> T getReference(Class<T> beanClass)

Deprecated. Use Beans.getReference(Class) instead.

Returns the CDI managed bean reference (proxy) of the given class. Note that this actually returns a client proxy and the underlying actual instance is thus always auto-created.

Type Parameters:

T - The expected return type.

Parameters:

beanClass - The CDI managed bean class.

Returns:

The CDI managed bean reference (proxy) of the given class, or null if there is none.

Throws:

UnsupportedOperationException - When obtaining the CDI managed bean reference failed with an exception.