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

Method Summary

Modifier and Type	Method and Description
static Validator	getBeanValidator() Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.getBeanValidator() instead.
static ValidatorFactory	getBeanValidatorFactory() Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.getBeanValidatorFactory() instead.
static String	getDefaultFacesServletMapping(ServletContext servletContext) Determines and returns the default faces servlet mapping.
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() Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.isBeanValidationAvailable() instead.
static Map<String,String>	validateBean(Object bean, Class<?>... groups) Deprecated. Since 3.8. This method should have returned actual constraint violations instead of abstracting them. Use Validators.validateBean(Object, Class...) instead.
static Map<String,String>	validateBeanProperty(Class<?> beanType, String propertyName, Object value, Class<?>... groups) Deprecated. Since 3.8. This method should have returned actual constraint violations instead of abstracting them. Use Validators.validateBeanProperty(Class, String, Object, Class...) instead.

Methods inherited from class java.lang.Object

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

Method Detail

isBeanValidationAvailable

@Deprecated
public static boolean isBeanValidationAvailable()

Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.isBeanValidationAvailable() instead.

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

Returns:

true if Bean Validation is available.

getBeanValidatorFactory

@Deprecated
public static ValidatorFactory getBeanValidatorFactory()

Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.getBeanValidatorFactory() instead.

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

Returns:

The default bean validator factory.

getBeanValidator

@Deprecated
public static Validator getBeanValidator()

Deprecated. Since 3.8. Bean Validation utilities are migrated to Validators. Use Validators.getBeanValidator() instead.

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

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

Deprecated. Since 3.8. This method should have returned actual constraint violations instead of abstracting them. Use Validators.validateBean(Object, Class...) instead.

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

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

Deprecated. Since 3.8. This method should have returned actual constraint violations instead of abstracting them. Use Validators.validateBeanProperty(Class, String, Object, Class...) instead.

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

getDefaultFacesServletMapping

public static String getDefaultFacesServletMapping(ServletContext servletContext)

Determines and returns the default faces servlet mapping. This will loop over getFacesServletMappings(ServletContext) and pick the first one starting with *. or ending with /*. If JSF is prefix mapped (e.g. /faces/*), then this returns the whole path, with a leading slash (e.g. /faces). If JSF is suffix mapped (e.g. *.xhtml), then this returns the whole extension (e.g. .xhtml). If none is found, then this falls back to .xhtml. This is for the first time determined in ApplicationInitializer and cached in the ServletContext.

Returns:

The default faces servlet mapping (without the wildcard).

Since:

3.10