com.day.cq.commons.servlets

Class AbstractListServlet

java.lang.Object

GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

com.day.cq.commons.servlets.AbstractPredicateServlet

com.day.cq.commons.servlets.AbstractListServlet

Direct Known Subclasses:

AbstractReplicableListServlet

public class AbstractListServlet
extends AbstractPredicateServlet

The AbstractListServlet provides base functionality such as sorting and paging for servlets that feed Ext grids (like in the SiteAdmin) with JSON. Normally, the list of children of the addressed resource are returned. Alternatively, the paging index of an item can be requested.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractListServlet.ListItem The ListItem interface defines a sortable item of the list.
class	AbstractListServlet.ListItemComparator The ListItemComparator compares public fields of AbstractListServlet.ListItems.

Field Summary

Fields

Modifier and Type	Field and Description
protected Session	admin
protected static java.lang.String	CONTENT_TYPE
protected static java.lang.String	DEFAULT_SORT_DIR
protected static java.lang.String	DEFAULT_SORT_KEY
protected static java.lang.String	DEFAULT_TIDY
protected static java.lang.String	ENCODING
protected ListInfoProvider	listInfoProvider
static java.lang.String	PAGE_INDEX Parameter to use in conjunction with PATH to determine the paging index of an item.
static java.lang.String	PAGE_LIMIT Parameter to specify the limit of items per page when using paging.
static java.lang.String	PAGE_START Parameter to specify the start index with when using paging.
static java.lang.String	PATH Parameter to use in conjunction with PAGE_INDEX to determine the paging index of an item.
static java.lang.String	PROP Parameter to use to specify the name(s) of custom properties that should be returned for each item in the list.
protected SlingRepository	repository
protected static long	serialVersionUID
static java.lang.String	SORT_ASCENDING Value to use for SORT_DIR to use ascending order (default).
static java.lang.String	SORT_DESCENDING Value to use for SORT_DIR to use descending order.
static java.lang.String	SORT_DIR Parameter to specify the direction to use for sorting.
static java.lang.String	SORT_KEY Parameter to specify which property use for sorting.
static java.lang.String	TIDY Parameter to use for tidy JSON.

Fields inherited from class com.day.cq.commons.servlets.AbstractPredicateServlet

FILTER_PARAM, PATH_PARAM, PREDICATE_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractListServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(ComponentContext context)
protected java.util.List<AbstractListServlet.ListItem>	applyPaging(SlingHttpServletRequest request, java.util.List<AbstractListServlet.ListItem> items, int total) Applies paging to the list items if specified in the request.
protected java.util.List<AbstractListServlet.ListItem>	applySorting(SlingHttpServletRequest request, java.util.List<AbstractListServlet.ListItem> items) Applies sorting to the list items if specified in the request.
protected void	bindListInfoProvider(ServiceReference ref)
protected void	deactivate(ComponentContext context)
protected void	doGet(SlingHttpServletRequest request, SlingHttpServletResponse response, Predicate predicate) Handles the HTTP GET method
protected java.text.Collator	getCollator()
protected java.util.List<AbstractListServlet.ListItem>	getItems(SlingHttpServletRequest request, Predicate predicate) Returns the list items based on the specified request and predicate.
protected long	getPagingIndex(SlingHttpServletRequest request, java.util.List<AbstractListServlet.ListItem> items, java.lang.String path) Returns the paging index of the item with the specified path or -1 if item not part of the specified items.
protected java.util.List<AbstractListServlet.ListItem>	processItems(SlingHttpServletRequest request, java.util.List<AbstractListServlet.ListItem> items, int total) Processes the specified list items based on the request parameters.
protected void	registerProvider(ServiceReference ref)
protected void	unbindListInfoProvider(ServiceReference ref)
protected void	write(SlingHttpServletRequest request, SlingHttpServletResponse response, java.util.List<AbstractListServlet.ListItem> listItems, java.lang.String[] customProps, int total) Writes the list to a JSON writer.
protected void	writeCustomProperties(JSONWriter out, Resource resource, java.lang.String[] customProps) Writes the specified properties of the resource to the JSON writer.
protected void	writeKey(JSONWriter out, java.lang.String key, java.lang.Object value) Writes a key and its value to the specified JSON writer.
protected void	writeOptionalDateKey(JSONWriter out, java.lang.String key, java.util.Calendar value) Writes a key and its date value to the specified JSON writer.
protected void	writeOptionalKey(JSONWriter out, java.lang.String key, java.lang.Object value) Writes a key and its value to the specified JSON writer.
protected void	writePagingIndex(SlingHttpServletRequest request, SlingHttpServletResponse response, java.util.List<AbstractListServlet.ListItem> listItems, java.lang.String path) Writes the paging index of the item with the specified path to a JSON writer.

Methods inherited from class com.day.cq.commons.servlets.AbstractPredicateServlet

doGet, getPredicate, selectorPredicateStart

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 java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

TIDY

public static final java.lang.String TIDY

Parameter to use for tidy JSON. If present, indentation and line breaks are added for better legibility.

See Also:

Constant Field Values

PAGE_START

public static final java.lang.String PAGE_START

Parameter to specify the start index with when using paging. Typically used in conjunction with PAGE_LIMIT. For the items of the page n, use a start index of limit + (n - 1).

See Also:

Constant Field Values

PAGE_LIMIT

public static final java.lang.String PAGE_LIMIT

Parameter to specify the limit of items per page when using paging. Typically used in conjunction with PAGE_START.

See Also:

Constant Field Values

SORT_KEY

public static final java.lang.String SORT_KEY

Parameter to specify which property use for sorting. Defaults to "index".

See Also:

Constant Field Values

SORT_DIR

public static final java.lang.String SORT_DIR

Parameter to specify the direction to use for sorting. Defaults to SORT_ASCENDING.

See Also:

Constant Field Values

SORT_ASCENDING

public static final java.lang.String SORT_ASCENDING

Value to use for SORT_DIR to use ascending order (default).

See Also:

Constant Field Values

SORT_DESCENDING

public static final java.lang.String SORT_DESCENDING

Value to use for SORT_DIR to use descending order.

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

Parameter to use in conjunction with PAGE_INDEX to determine the paging index of an item. If both parameters are present, the paging index of the item with the specified path will be returned instead of the list of children.

See Also:

Constant Field Values

PAGE_INDEX

public static final java.lang.String PAGE_INDEX

Parameter to use in conjunction with PATH to determine the paging index of an item. If this parameter is present, the paging index of the item with the path specified in PATH will be returned instead of the list of children.

See Also:

Constant Field Values

PROP

public static final java.lang.String PROP

Parameter to use to specify the name(s) of custom properties that should be returned for each item in the list. If the properties exist on the item's resource, their values will be returned as additional JSON properties.

See Also:

Constant Field Values

DEFAULT_TIDY

protected static final java.lang.String DEFAULT_TIDY

See Also:

Constant Field Values

DEFAULT_SORT_KEY

protected static final java.lang.String DEFAULT_SORT_KEY

See Also:

Constant Field Values

DEFAULT_SORT_DIR

protected static final java.lang.String DEFAULT_SORT_DIR

See Also:

Constant Field Values

CONTENT_TYPE

protected static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

ENCODING

protected static final java.lang.String ENCODING

See Also:

Constant Field Values

repository

protected SlingRepository repository

listInfoProvider

protected ListInfoProvider listInfoProvider

admin

protected Session admin

Constructor Detail

AbstractListServlet

public AbstractListServlet()

Method Detail

doGet

protected void doGet(SlingHttpServletRequest request,
         SlingHttpServletResponse response,
         Predicate predicate)
              throws ServletException,
                     java.io.IOException

Handles the HTTP GET method

Overrides:

doGet in class AbstractPredicateServlet

Parameters:

request - The HTTP request

response - The HTTP response

predicate - the predicate retrieved from the request

Throws:

ServletException - if a servlet error occurs

java.io.IOException - if an I/O error occurs

getItems

protected java.util.List<AbstractListServlet.ListItem> getItems(SlingHttpServletRequest request,
                                                    Predicate predicate)
                                                         throws java.lang.Exception

Returns the list items based on the specified request and predicate. The list items are typically generated from the children of the Resource provided by the request. The optional predicate can be used for evaluation.

Parameters:

request - The request

predicate - The predicate (optional)

Returns:

The list items

Throws:

java.lang.Exception - if unable to retrieve items

processItems

protected java.util.List<AbstractListServlet.ListItem> processItems(SlingHttpServletRequest request,
                                                        java.util.List<AbstractListServlet.ListItem> items,
                                                        int total)

Processes the specified list items based on the request parameters. By default, sorting and paging is applied.

Parameters:

request - The request

items - The list items

total - The total number of list items

Returns:

The processed list items

See Also:

applySorting(SlingHttpServletRequest, List), applyPaging(SlingHttpServletRequest, List, int)

applySorting

protected java.util.List<AbstractListServlet.ListItem> applySorting(SlingHttpServletRequest request,
                                                        java.util.List<AbstractListServlet.ListItem> items)

Applies sorting to the list items if specified in the request.

Parameters:

request - The request

items - The list items

Returns:

The sorted list items

applyPaging

protected java.util.List<AbstractListServlet.ListItem> applyPaging(SlingHttpServletRequest request,
                                                       java.util.List<AbstractListServlet.ListItem> items,
                                                       int total)

Applies paging to the list items if specified in the request.

Parameters:

request - The request

items - The list items

total - The total number of list items

Returns:

The truncated list items

getPagingIndex

protected long getPagingIndex(SlingHttpServletRequest request,
                  java.util.List<AbstractListServlet.ListItem> items,
                  java.lang.String path)

Returns the paging index of the item with the specified path or -1 if item not part of the specified items.

Parameters:

request - The request

items - The list items

path - The path of the item

Returns:

The paging index

write

protected void write(SlingHttpServletRequest request,
         SlingHttpServletResponse response,
         java.util.List<AbstractListServlet.ListItem> listItems,
         java.lang.String[] customProps,
         int total)
              throws java.lang.Exception

Writes the list to a JSON writer.

Parameters:

request - The request

response - The response

listItems - The list items

customProps - The names of the custom properties to include

total - The total number of list items

Throws:

java.lang.Exception - if unable to write the list

writeKey

protected void writeKey(JSONWriter out,
            java.lang.String key,
            java.lang.Object value)
                 throws JSONException

Writes a key and its value to the specified JSON writer.

Parameters:

out - The JSON

key - The name of the key

value - The value of the key

Throws:

JSONException - if unable to write the key

writeOptionalKey

protected void writeOptionalKey(JSONWriter out,
                    java.lang.String key,
                    java.lang.Object value)
                         throws JSONException

Writes a key and its value to the specified JSON writer. If the value is null, the key is omitted.

Parameters:

out - The JSON

key - The name of the key

value - The value of the key

Throws:

JSONException - if unable to write the key

writeOptionalDateKey

protected void writeOptionalDateKey(JSONWriter out,
                        java.lang.String key,
                        java.util.Calendar value)
                             throws JSONException

Writes a key and its date value to the specified JSON writer. If the value is null, the key is omitted.

Parameters:

out - The JSON

key - The name of the key

value - The date value of the key

Throws:

JSONException - if unable to write the key

writeCustomProperties

protected void writeCustomProperties(JSONWriter out,
                         Resource resource,
                         java.lang.String[] customProps)
                              throws JSONException

Writes the specified properties of the resource to the JSON writer. If the value is null, the key is omitted.

Parameters:

out - The JSON

resource - The resource

customProps - The properties

Throws:

JSONException - if unable to write the properties

writePagingIndex

protected void writePagingIndex(SlingHttpServletRequest request,
                    SlingHttpServletResponse response,
                    java.util.List<AbstractListServlet.ListItem> listItems,
                    java.lang.String path)
                         throws java.lang.Exception

Writes the paging index of the item with the specified path to a JSON writer.

Parameters:

request - The request

response - The response

listItems - The list items

path - The path of the item

Throws:

java.lang.Exception - if unable to write the index

activate

protected void activate(ComponentContext context)
                 throws java.lang.Exception

Throws:

java.lang.Exception

deactivate

protected void deactivate(ComponentContext context)

bindListInfoProvider

protected void bindListInfoProvider(ServiceReference ref)

unbindListInfoProvider

protected void unbindListInfoProvider(ServiceReference ref)

registerProvider

protected void registerProvider(ServiceReference ref)

getCollator

protected java.text.Collator getCollator()