com.icfolson.aem.library.core.servlets.optionsprovider

Class AbstractOptionsProviderServlet

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.AbstractComponentServlet

com.icfolson.aem.library.core.servlets.optionsprovider.AbstractOptionsProviderServlet

All Implemented Interfaces:

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

public abstract class AbstractOptionsProviderServlet
extends AbstractComponentServlet

Base class for providing a list of "options" to a component dialog widget. An option is simply a text/value pair to be rendered in a selection box. The implementing class determines how these options are retrieved from the repository (or external provider, such as a web service).

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
AbstractOptionsProviderServlet()

Method Summary

Modifier and Type	Method and Description
protected abstract List<Option>	getOptions(ComponentServletRequest request) Get a list of "options" (text/value pairs) for rendering in an authoring dialog.
protected abstract com.google.common.base.Optional<String>	getOptionsRoot(ComponentServletRequest request)
protected void	processGet(ComponentServletRequest request) Process a GET request.

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

doDelete, doGet, doPost, doPut, processDelete, processPost, processPut

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

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

AbstractOptionsProviderServlet

public AbstractOptionsProviderServlet()

Method Detail

getOptions

protected abstract List<Option> getOptions(ComponentServletRequest request)

Get a list of "options" (text/value pairs) for rendering in an authoring dialog. Building the list of options is handled by the implementing class and will vary depending on the requirements for the component dialog calling this servlet.

Parameters:

request - component servlet request

Returns:

list of options as determined by the implementing class

getOptionsRoot

protected abstract com.google.common.base.Optional<String> getOptionsRoot(ComponentServletRequest request)

Parameters:

request - component servlet request

Returns:

Optional name of root JSON object containing options

processGet

protected final void processGet(ComponentServletRequest request)
                         throws javax.servlet.ServletException,
                                IOException

Description copied from class: AbstractComponentServlet

Process a GET request. Extending classes can optionally override this method to implement desired functionality.

Overrides:

processGet in class AbstractComponentServlet

Parameters:

request - component request

Throws:

javax.servlet.ServletException - if servlet error occurs

IOException - if I/O error occurs