org.omnifaces.cdi.converter

Class ConverterManager

java.lang.Object

org.omnifaces.cdi.converter.ConverterManager

@ApplicationScoped
public class ConverterManager
extends Object

The @FacesConverter is by default not eligible for dependency injection by @Inject nor @EJB. There is a workaround for EJB, but this is nasty and doesn't work out for CDI. Another way would be to make it a JSF or CDI managed bean, however this doesn't register the converter instance into the JSF application context, and hence you won't be able to make use of Application.createConverter(String) on it. Further it also breaks the power of forClass attribute, i.e. you can't register a JSF converter for a specific type anymore and you'd need to explicitly declare it everytime.

Initially, this should be solved in JSF 2.2 which comes with new support for dependency injection in among others all javax.faces.*.*Factory, NavigationHandler, ResourceHandler, ActionListener, PhaseListener and SystemEventListener instances. The Converter and Validator were initially also among them, but they broke a TCK test and were at the last moment removed from dependency injection support.

The support is expected to come back in JSF 2.3, but we just can't wait any longer. MyFaces CODI has support for it, but it requires an additional @Advanced annotation. OmniFaces solves this by implicitly making all FacesConverter instances eligible for dependency injection without any further modification, like as JSF 2.2 would initially do, hereby providing a transparent bridge of the code to the upcoming JSF 2.3.

The ConverterManager provides access to all FacesConverter annotated Converter instances which are made eligible for CDI.

Since:

1.6

Author:

Radu Creanga <rdcrng@gmail.com>, Bauke Scholtz

See Also:

OmniApplication, OmniApplicationFactory

Constructor Summary

Constructors

Constructor and Description
ConverterManager()

Method Summary

Modifier and Type	Method and Description
Converter	createConverter(Application application, Class<?> converterForClass) Returns the converter instance associated with the given converter for-class, or null if there is none.
Converter	createConverter(Application application, String converterId) Returns the converter instance associated with the given converter ID, or null if there is none.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConverterManager

public ConverterManager()

Method Detail

createConverter

public Converter createConverter(Application application,
                                 String converterId)

Returns the converter instance associated with the given converter ID, or null if there is none.

Parameters:

application - The involved JSF application.

converterId - The converter ID of the desired converter instance.

Returns:

the converter instance associated with the given converter ID, or null if there is none.

createConverter

public Converter createConverter(Application application,
                                 Class<?> converterForClass)

Returns the converter instance associated with the given converter for-class, or null if there is none.

Parameters:

application - The involved JSF application.

converterForClass - The converter for-class of the desired converter instance.

Returns:

the converter instance associated with the given converter for-class, or null if there is none.