org.resthub.web.controller

Class ValidationController

java.lang.Object

org.resthub.web.controller.ValidationController

@Controller
@Profile(value="resthub-validation")
@RequestMapping(value="/api/validation")
public class ValidationController
extends Object

Exposes dedicated API to export defined validation constraints related to object class name. This API is defined under the "resthub-validation" Spring profile and can be activated by adding this profile in WebappIniliatizer. e.g:

 appContext.getEnvironment().setActiveProfiles("resthub-validation");
 

Constructor Summary

Constructors

Constructor and Description
ValidationController()

Method Summary

Methods

Modifier and Type	Method and Description
ModelConstraint	getConstraintsForClassName(String canonicalClassName, String locale) Exposes an "/api/validation/{canonicalClassName}" endpoint to get all validation constraints for a given object className and optional locale parameter.
void	setService(ValidationService validationService)

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationController

public ValidationController()

Method Detail

setService

@Inject
@Named(value="validationService")
public void setService(ValidationService validationService)

getConstraintsForClassName

@RequestMapping(value="{canonicalClassName:.+}",
                method=GET)
@ResponseBody
public ModelConstraint getConstraintsForClassName(@PathVariable
                                                                     String canonicalClassName,
                                                                     @RequestParam(required=false)
                                                                     String locale)

Exposes an "/api/validation/{canonicalClassName}" endpoint to get all validation constraints for a given object className and optional locale parameter. Usage:

 http://{host}:{port}/api/validation/org.resthub.validation.model.User
 http://{host}:{port}/api/validation/org.resthub.validation.model.User?locale=en-us
 

Parameters:

canonicalClassName - mandatory path parameter containing the complete className of the Java Bean to export (i.e. package + className - e.g. org.resthub.validation.model.User).

locale - optional request parameter, the API takes the locale string indicating your internationalization preferences. You can then provide a valid i18n locale string to choose the desired message locale. Available locales are those supported by Hibernate Validator or provided by your custom properties files. If no locale parameter is provided or if the locale parameter is invalid, the default server locale is used.

Returns:

a ModelConstraint instance containing representation of all validation constraints for the given className.

Throws:

NotFoundException - if either canonicalClassName is missing or could not be retrieved.

See Also:

ValidationService.getConstraintsForClassName(java.lang.String), ModelConstraint