org.omnifaces.util

Class Platform

java.lang.Object

org.omnifaces.util.Platform

public final class Platform
extends Object

This class provides access to (Java EE 6) platform services from the view point of JSF.

Note that this utility class can only be used in a JSF environment and is thus not a Java EE general way to obtain platform services.

Since:

1.6

Author:

Arjan Tijms

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_VALIDATION_AVAILABLE

Method Summary

Modifier and Type	Method and Description
static Validator	getBeanValidator() Returns the bean validator which is aware of the JSF locale.
static ValidatorFactory	getBeanValidatorFactory() Returns the default bean validator factory.
static Collection<String>	getFacesServletMappings(ServletContext servletContext) Returns the mappings associated with the FacesServlet.
static ServletRegistration	getFacesServletRegistration(ServletContext servletContext) Returns the ServletRegistration associated with the FacesServlet.
static boolean	isBeanValidationAvailable() Returns true if Bean Validation is available.
static Map<String,String>	validateBean(Object bean, Class<?>... groups) Validate given bean on given group classes and return constraint violation messages mapped by property path.
static Map<String,String>	validateBeanProperty(Class<?> beanType, String propertyName, Object value, Class<?>... groups) Validate given value as if it were a property of the given bean type and return constraint violation messages mapped by property path.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_VALIDATION_AVAILABLE

public static final String BEAN_VALIDATION_AVAILABLE

See Also:

Constant Field Values

Method Detail

isBeanValidationAvailable

public static boolean isBeanValidationAvailable()

Returns true if Bean Validation is available. This is remembered in the application scope.

Returns:

true if Bean Validation is available.

getBeanValidatorFactory

public static ValidatorFactory getBeanValidatorFactory()

Returns the default bean validator factory. This is remembered in the application scope.

Returns:

The default bean validator factory.

getBeanValidator

public static Validator getBeanValidator()

Returns the bean validator which is aware of the JSF locale.

Returns:

The bean validator which is aware of the JSF locale.

See Also:

Faces.getLocale()

validateBean

public static Map<String,String> validateBean(Object bean,
                                              Class<?>... groups)

Validate given bean on given group classes and return constraint violation messages mapped by property path.

Parameters:

bean - Bean to be validated.

groups - Bean validation groups, if any.

Returns:

Constraint violation messages mapped by property path.

Since:

2.7

validateBeanProperty

public static Map<String,String> validateBeanProperty(Class<?> beanType,
                                                      String propertyName,
                                                      Object value,
                                                      Class<?>... groups)

Validate given value as if it were a property of the given bean type and return constraint violation messages mapped by property path.

Parameters:

beanType - Type of target bean.

propertyName - Name of property on target bean.

value - Value to be validated.

groups - Bean validation groups, if any.

Returns:

Constraint violation messages mapped by property path.

Since:

2.7

getFacesServletRegistration

public static ServletRegistration getFacesServletRegistration(ServletContext servletContext)

Returns the ServletRegistration associated with the FacesServlet.

Parameters:

servletContext - The context to get the ServletRegistration from.

Returns:

ServletRegistration for FacesServlet, or null if the FacesServlet is not installed.

Since:

1.8

getFacesServletMappings

public static Collection<String> getFacesServletMappings(ServletContext servletContext)

Returns the mappings associated with the FacesServlet.

Parameters:

servletContext - The context to get the FacesServlet from.

Returns:

The mappings associated with the FacesServlet, or an empty set.

Since:

2.5