com.icfolson.aem.library.core.servlets

Class AbstractValidatorServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

com.icfolson.aem.library.core.servlets.AbstractJsonResponseServlet

com.icfolson.aem.library.core.servlets.AbstractValidatorServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AbstractValidatorServlet
extends AbstractJsonResponseServlet

Validators extending this class need to add the following SCR annotation to register the servlet:

  @SlingServlet(resourceTypes = "aem-library/components/content/example", selectors = "validator",
 extensions = "json", methods = "GET")
 

The "resourceTypes" annotation will need to be updated to match the resource type of the component being validated. The component dialog.xml can call the the validator for a given dialog field using the following function:

 
 <name jcr:primaryType="cq:Widget" fieldLabel="Name" name="./name" xtype="textfield"
     validator="function(value) {
         return AEM.Library.Utilities.Dialog.validateField(this, value, 'Name is invalid');
     }" />
 
 

See Also:

Serialized Form

Field Summary

Fields inherited from class com.icfolson.aem.library.core.servlets.AbstractJsonResponseServlet

DEFAULT_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
AbstractValidatorServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse response)
protected abstract boolean	isValid(org.apache.sling.api.SlingHttpServletRequest request, String path, String value) Validate the given value for this request and path.

Methods inherited from class com.icfolson.aem.library.core.servlets.AbstractJsonResponseServlet

writeJsonResponse, writeJsonResponse, writeJsonResponse, writeJsonResponse

Methods inherited from class org.apache.sling.api.servlets.SlingAllMethodsServlet

doDelete, doPost, doPut, getAllowedRequestMethods, isMethodValid, mayService

Methods inherited from class org.apache.sling.api.servlets.SlingSafeMethodsServlet

doGeneric, doHead, doOptions, doTrace, getServletInfo, handleMethodNotImplemented, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidatorServlet

public AbstractValidatorServlet()

Method Detail

doGet

protected final void doGet(org.apache.sling.api.SlingHttpServletRequest request,
                           org.apache.sling.api.SlingHttpServletResponse response)
                    throws javax.servlet.ServletException,
                           IOException

Overrides:

doGet in class org.apache.sling.api.servlets.SlingSafeMethodsServlet

Throws:

javax.servlet.ServletException

IOException

isValid

protected abstract boolean isValid(org.apache.sling.api.SlingHttpServletRequest request,
                                   String path,
                                   String value)

Validate the given value for this request and path.

Parameters:

request - servlet request

path - path to current component being validated

value - input value to validate

Returns:

true if value is valid, false otherwise