Package com.composum.sling.core.servlet

Class SystemServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

com.composum.sling.core.servlet.AbstractServiceServlet

com.composum.sling.core.servlet.SystemServlet

All Implemented Interfaces:

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

public class SystemServlet
extends AbstractServiceServlet

The service servlet to retrieve all general system settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemServlet.Extension
class	SystemServlet.GetMixinTypes	the 'system.mixinTypes.json' operation send a JSON array with available mixin types a 'query' parameter is used to restrict the result to type names with the query string
class	SystemServlet.GetNodeTypes	the general node types Query and Caching implementation
class	SystemServlet.GetPrimaryTypes	the 'system.primaryTypes.json' operation send a JSON array with available primary types a 'query' parameter is used to restrict the result to type names with the query string
class	SystemServlet.GetPropertyTypes
class	SystemServlet.JsonTypeahead
static class	SystemServlet.MixinTypesFilter	the general filter for mixin types
static class	SystemServlet.Operation
static class	SystemServlet.PrimaryTypesFilter	the general filter for primary types is a inversion ot the mixin types filter

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL_QUERY_KEY
protected org.apache.commons.collections4.map.LRUMap	MIXIN_TYPE_CACHE	the static cache for mixin type queries and their results
protected ResourceFilter	MIXIN_TYPE_FILTER	the general filter for mixin types
static String	NODE_TYPES_PATH
protected ServletOperationSet<SystemServlet.Extension,SystemServlet.Operation>	operations
protected org.apache.commons.collections4.map.LRUMap	PRIMARY_TYPE_CACHE	the cache for primary type queries and their results
protected ResourceFilter	PRIMARY_TYPE_FILTER	the general filter for primary types
static String	PROP_IS_MIXIN
static String[]	PROPERTY_TYPES
static String	SERVICE_KEY
static String	SERVLET_PATH

Fields inherited from class com.composum.sling.core.servlet.AbstractServiceServlet

DATE_FORMAT, PARAM_BEFORE, PARAM_CMD, PARAM_FILE, PARAM_FILTER, PARAM_ID, PARAM_INDEX, PARAM_JCR_CONTENT, PARAM_LABEL, PARAM_MIME_TYPE, PARAM_NAME, PARAM_PATH, PARAM_QUERY, PARAM_RESOURCE_TYPE, PARAM_TITLE, PARAM_TYPE, PARAM_URL, PARAM_VALUE, PARAM_VERSION

Constructor Summary

Constructors

Constructor	Description
SystemServlet()

Method Summary

Modifier and Type	Method	Description
protected @NotNull ServletOperationSet<SystemServlet.Extension,SystemServlet.Operation>	getOperations()	Each servlet implementation must provide access to its operation set for request delegation.
ServiceRestrictions.Key	getServiceKey()
void	init()	setup of the servlet operation set for this servlet instance

Methods inherited from class com.composum.sling.core.servlet.AbstractServiceServlet

deactivate, doDelete, doGet, doPost, doPut, getJsonObject, getJsonObject, getJsonObject, getPath, getResource, getRestrictions, isEnabled, jsonAnswerItemExists, jsonValue, methodDeletePermission, methodGetPermission, methodPostPermission, methodPutPermission, setNoCacheHeaders, tryToUseRawSuffix

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, log, log

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_KEY

public static final String SERVICE_KEY

See Also:

Constant Field Values

SERVLET_PATH

public static final String SERVLET_PATH

See Also:

Constant Field Values

NODE_TYPES_PATH

public static final String NODE_TYPES_PATH

See Also:

Constant Field Values

PROP_IS_MIXIN

public static final String PROP_IS_MIXIN

See Also:

Constant Field Values

ALL_QUERY_KEY

public static final String ALL_QUERY_KEY

See Also:

Constant Field Values

operations

protected ServletOperationSet<SystemServlet.Extension,SystemServlet.Operation> operations

PROPERTY_TYPES

public static final String[] PROPERTY_TYPES

PRIMARY_TYPE_FILTER

protected ResourceFilter PRIMARY_TYPE_FILTER

the general filter for primary types

PRIMARY_TYPE_CACHE

protected org.apache.commons.collections4.map.LRUMap PRIMARY_TYPE_CACHE

the cache for primary type queries and their results

MIXIN_TYPE_FILTER

protected ResourceFilter MIXIN_TYPE_FILTER

the general filter for mixin types

MIXIN_TYPE_CACHE

protected org.apache.commons.collections4.map.LRUMap MIXIN_TYPE_CACHE

the static cache for mixin type queries and their results

Constructor Detail

SystemServlet

public SystemServlet()

Method Detail

getServiceKey

@NotNull
public ServiceRestrictions.Key getServiceKey()

Specified by:

getServiceKey in interface RestrictedService

Overrides:

getServiceKey in class AbstractServiceServlet

getOperations

@NotNull
protected @NotNull ServletOperationSet<SystemServlet.Extension,SystemServlet.Operation> getOperations()

Description copied from class: AbstractServiceServlet

Each servlet implementation must provide access to its operation set for request delegation.

Specified by:

getOperations in class AbstractServiceServlet

init

public void init()
          throws javax.servlet.ServletException

setup of the servlet operation set for this servlet instance

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException