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 ofApplication.createConverter(String)
on it. Further it also breaks the power offorClass
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
jakarta.faces.*.*Factory
,NavigationHandler
,ResourceHandler
,ActionListener
,PhaseListener
andSystemEventListener
instances. TheConverter
andValidator
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 allFacesConverter
instances eligible for dependency injection without any further modification.The
ConverterManager
provides access to allFacesConverter
annotatedConverter
instances which are made eligible for CDI.bean-discovery-mode
In Java EE 7's CDI 1.1, when having a CDI 1.1 compatible
beans.xml
, by default only classes with an explicit CDI managed bean scope annotation will be registered for dependency injection support. In order to coverFacesConverter
annotated classes as well, you need to explicitly setbean-discovery-mode="all"
attribute inbeans.xml
. This was not necessary in Mojarra versions older than 2.2.9 due to an oversight. If you want to keep the default ofbean-discovery-mode="annotated"
, then you need to addDependent
annotation to the converter class.AmbiguousResolutionException
In case you have a
FacesConverter
annotated class extending anotherFacesConverter
annotated class which in turn extends a standard converter, then you may withbean-discovery-mode="all"
face anAmbiguousResolutionException
. This can be solved by placingSpecializes
annotation on the subclass.Converters with special Class constructor
By default, CDI only instantiates beans via the default constructor. In case a converter for a class is created, and the returned converter does not have a default constructor, or has a single argument constructor that takes a
Class
instance, then this converter will not be made eligible for CDI. This change was added in OmniFaces 2.6 as per issue 25.JSF 2.3 compatibility
OmniFaces 3.0 continued to work fine with regard to managed converters which are initially developed for JSF 2.2. However, JSF 2.3 introduced two new features for converters: parameterized converters and managed converters. When the converter is parameterized as in
implements Converter<T>
, then you need to use at least OmniFaces 3.1 wherein the incompatibility was fixed. When the converter is managed with the new JSF 2.3managed=true
attribute set on theFacesConverter
annotation, then the converter won't be managed by OmniFaces and will continue to work fine for JSF. But the <o:converter> tag won't be able to set attributes on it.- Since:
- 1.6
- Author:
- Radu Creanga <[email protected]>, Bauke Scholtz
- See Also:
OmniApplication
,OmniApplicationFactory
-
-
Constructor Summary
Constructors Constructor Description ConverterManager()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Converter
createConverter(Application application, Class<?> converterForClass)
Returns the converter instance associated with the given converter for-class, ornull
if there is none.Converter
createConverter(Application application, String converterId)
Returns the converter instance associated with the given converter ID, ornull
if there is none.void
init()
-
-
-
Method Detail
-
init
@PostConstruct public void init()
-
createConverter
public Converter createConverter(Application application, String converterId)
Returns the converter instance associated with the given converter ID, ornull
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, ornull
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.
-
-