# Index

A C D F G H I J L M N O P R S T U W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

AbstractContentTypeHandler - Class in org.apache.struts2.rest.handler
AbstractContentTypeHandler() - Constructor for class org.apache.struts2.rest.handler.AbstractContentTypeHandler
addDefaultPermissions(ActionInvocation, XStream) - Method in class org.apache.struts2.rest.handler.XStreamHandler
allowedClasses() - Method in interface org.apache.struts2.rest.handler.xstream.XStreamAllowedClasses
allowedClassNames() - Method in interface org.apache.struts2.rest.handler.xstream.XStreamAllowedClassNames
apply(HttpServletRequest, HttpServletResponse, Object) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
apply(HttpServletRequest, HttpServletResponse, Object) - Method in interface org.apache.struts2.rest.HttpHeaders
  Applies the configured information to the response

## C

CONTENT_TYPE - Static variable in class org.apache.struts2.rest.handler.FormUrlEncodedHandler
CONTENT_TYPE - Static variable in class org.apache.struts2.rest.handler.MultipartFormDataHandler
ContentTypeHandler - Interface in org.apache.struts2.rest.handler
  Handles transferring content to and from objects for a specific content type
ContentTypeHandlerManager - Interface in org.apache.struts2.rest
  Manages content type handlers
ContentTypeInterceptor - Class in org.apache.struts2.rest
  Uses the content handler to apply the request body to the action
ContentTypeInterceptor() - Constructor for class org.apache.struts2.rest.ContentTypeInterceptor
createActionProxy(String, String, String, Map<String, Object>, boolean, boolean) - Method in class org.apache.struts2.rest.RestActionProxyFactory
createContinue() - Method in class org.apache.struts2.rest.RestActionSupport
  By default, return continue.
createXStream() - Method in interface org.apache.struts2.rest.handler.xstream.XStreamProvider
createXStream(ActionInvocation) - Method in class org.apache.struts2.rest.handler.XStreamHandler

## D

DefaultContentTypeHandlerManager - Class in org.apache.struts2.rest
  Manages `ContentTypeHandler` instances and uses them to process results
DefaultContentTypeHandlerManager() - Constructor for class org.apache.struts2.rest.DefaultContentTypeHandlerManager
DefaultHttpHeaders - Class in org.apache.struts2.rest
  Default implementation of rest info that uses fluent-style construction
DefaultHttpHeaders() - Constructor for class org.apache.struts2.rest.DefaultHttpHeaders
DefaultHttpHeaders(String) - Constructor for class org.apache.struts2.rest.DefaultHttpHeaders
disableCaching() - Method in class org.apache.struts2.rest.DefaultHttpHeaders
doIntercept(ActionInvocation) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
  Intercept `ActionInvocation` and processes the errors using the `ContentTypeHandler` appropriate for the request.

## F

findExtension(String) - Method in interface org.apache.struts2.rest.ContentTypeHandlerManager
  Finds the extension in the url
findExtension(String) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
  Finds the extension in the url
FormUrlEncodedHandler - Class in org.apache.struts2.rest.handler
  Handles the default content type for requests that originate from a browser's HTML form content-type: application/x-www-form-urlencoded This handler is intended for requests only, not for responses
FormUrlEncodedHandler() - Constructor for class org.apache.struts2.rest.handler.FormUrlEncodedHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in interface org.apache.struts2.rest.handler.ContentTypeHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.FormUrlEncodedHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.HtmlHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.JacksonJsonHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.JacksonXmlHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.JuneauXmlHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.MultipartFormDataHandler
fromObject(ActionInvocation, Object, String, Writer) - Method in class org.apache.struts2.rest.handler.XStreamHandler

## G

getAllAsStringsMap() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getContentType() - Method in interface org.apache.struts2.rest.handler.ContentTypeHandler
  Gets the content type for this handler
getContentType() - Method in class org.apache.struts2.rest.handler.FormUrlEncodedHandler
getContentType() - Method in class org.apache.struts2.rest.handler.HtmlHandler
getContentType() - Method in class org.apache.struts2.rest.handler.JacksonJsonHandler
getContentType() - Method in class org.apache.struts2.rest.handler.JacksonXmlHandler
getContentType() - Method in class org.apache.struts2.rest.handler.JuneauXmlHandler
getContentType() - Method in class org.apache.struts2.rest.handler.MultipartFormDataHandler
getContentType() - Method in class org.apache.struts2.rest.handler.XStreamHandler
getExtension() - Method in interface org.apache.struts2.rest.handler.ContentTypeHandler
  Gets the extension this handler supports
getExtension() - Method in class org.apache.struts2.rest.handler.FormUrlEncodedHandler
getExtension() - Method in class org.apache.struts2.rest.handler.HtmlHandler
getExtension() - Method in class org.apache.struts2.rest.handler.JacksonJsonHandler
getExtension() - Method in class org.apache.struts2.rest.handler.JacksonXmlHandler
getExtension() - Method in class org.apache.struts2.rest.handler.JuneauXmlHandler
getExtension() - Method in class org.apache.struts2.rest.handler.MultipartFormDataHandler
getExtension() - Method in class org.apache.struts2.rest.handler.XStreamHandler
getExtensionIfPresent(String) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
  Gets the extension in the url
getHandlerForRequest(HttpServletRequest) - Method in interface org.apache.struts2.rest.ContentTypeHandlerManager
  Gets the handler for the request by looking at the request content type and extension
getHandlerForRequest(HttpServletRequest) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
  Gets the handler for the request by looking at the request content type and extension
getHandlerForResponse(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.struts2.rest.ContentTypeHandlerManager
  Gets the handler for the response by looking at the extension of the request
getHandlerForResponse(HttpServletRequest, HttpServletResponse) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
  Gets the handler for the response by looking at the extension of the request
getIdParameterName() - Method in class org.apache.struts2.rest.RestActionMapper
getMapperDeleteMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperEditMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperGetMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperIndexMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperNewMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperOptionsMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperPostContinueMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperPostMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperPutContinueMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapperPutMethodName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getMapping(HttpServletRequest, ConfigurationManager) - Method in class org.apache.struts2.rest.RestActionMapper
getRestContentRestrictToGet() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getRestDefaultErrorResultName() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getRestDefaultExtension() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getRestLogger() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getRestNamespace() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getRestValidationFailureStatusCode() - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
getResultCode() - Method in class org.apache.struts2.rest.DefaultHttpHeaders
getResultCode() - Method in interface org.apache.struts2.rest.HttpHeaders
getStatus() - Method in class org.apache.struts2.rest.DefaultHttpHeaders
getStatus() - Method in interface org.apache.struts2.rest.HttpHeaders
getTypePermissions() - Method in interface org.apache.struts2.rest.handler.xstream.XStreamPermissionProvider

## H

handleResult(ActionInvocation, Object, Object) - Method in interface org.apache.struts2.rest.ContentTypeHandlerManager
  Handles the result using handlers to generate content type-specific content
handleResult(ActionInvocation, Object, Object) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
  Handles the result using handlers to generate content type-specific content
hasErrors - Variable in class org.apache.struts2.rest.RestActionInvocation
HtmlHandler - Class in org.apache.struts2.rest.handler
  Handles HTML content, usually just a simple passthrough to the framework
HtmlHandler() - Constructor for class org.apache.struts2.rest.handler.HtmlHandler
HTTP_METHOD_PARAM - Static variable in class org.apache.struts2.rest.RestActionMapper
httpHeaders - Variable in class org.apache.struts2.rest.RestActionInvocation
HttpHeaders - Interface in org.apache.struts2.rest
  Type-safe rest-related information to apply to a response

## I

index() - Method in class org.apache.struts2.rest.RestActionSupport
  Default execution.
intercept(ActionInvocation) - Method in class org.apache.struts2.rest.ContentTypeInterceptor
invoke() - Method in class org.apache.struts2.rest.RestActionInvocation
isDelete(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper
isExpectContinue(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper
isFirstInterceptor - Variable in class org.apache.struts2.rest.RestActionInvocation
isGet(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper
isOptions(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper
isPost(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper
isPut(HttpServletRequest) - Method in class org.apache.struts2.rest.RestActionMapper

## J

JacksonJsonHandler - Class in org.apache.struts2.rest.handler
  Handles JSON content using jackson-lib
JacksonJsonHandler() - Constructor for class org.apache.struts2.rest.handler.JacksonJsonHandler
JacksonXmlHandler - Class in org.apache.struts2.rest.handler
  Handles XML content using Jackson
JacksonXmlHandler() - Constructor for class org.apache.struts2.rest.handler.JacksonXmlHandler
JuneauXmlHandler - Class in org.apache.struts2.rest.handler
  Handles XML content using Apache Juneau http://juneau.apache.org/#marshall.html
JuneauXmlHandler() - Constructor for class org.apache.struts2.rest.handler.JuneauXmlHandler

## L

lastModified(Date) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
LOG - Static variable in class org.apache.struts2.rest.RestActionMapper

## M

MultipartFormDataHandler - Class in org.apache.struts2.rest.handler
  Handles the default content type for requests that originate from a browser's HTML form with a file upload and multipart/from-data encoding content-type: multipart/form-data This handler is intended for requests only, not for responses
MultipartFormDataHandler() - Constructor for class org.apache.struts2.rest.handler.MultipartFormDataHandler

## N

namespace - Variable in class org.apache.struts2.rest.RestActionProxyFactory

## O

options() - Method in class org.apache.struts2.rest.RestActionSupport
  Inspect the implemented methods to know the allowed http methods.
org.apache.struts2.rest - package org.apache.struts2.rest
org.apache.struts2.rest.config.entities - package org.apache.struts2.rest.config.entities
org.apache.struts2.rest.handler - package org.apache.struts2.rest.handler
org.apache.struts2.rest.handler.xstream - package org.apache.struts2.rest.handler.xstream

## P

parseNameAndNamespace(String, ActionMapping, ConfigurationManager) - Method in class org.apache.struts2.rest.RestActionMapper
  Parses the name and namespace from the uri.
processResult() - Method in class org.apache.struts2.rest.RestActionInvocation

## R

readResultCode(Object) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
readStatusCode(Object) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
renderResult(String) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
REST_CONTENT_RESTRICT_TO_GET - Static variable in class org.apache.struts2.rest.RestConstants
REST_DEFAULT_ERROR_RESULT_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_DEFAULT_EXTENSION - Static variable in class org.apache.struts2.rest.RestConstants
REST_LOGGER - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_DELETE_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_EDIT_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_GET_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_INDEX_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_NEW_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_OPTIONS_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_POST_CONTINUE_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_POST_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_PUT_CONTINUE_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_MAPPER_PUT_METHOD_NAME - Static variable in class org.apache.struts2.rest.RestConstants
REST_VALIDATION_FAILURE_STATUS_CODE - Static variable in class org.apache.struts2.rest.RestConstants
RestActionInvocation - Class in org.apache.struts2.rest
  Extends the usual `ActionInvocation` to add support for processing the object returned from the action execution.
RestActionInvocation(Map<String, Object>, boolean) - Constructor for class org.apache.struts2.rest.RestActionInvocation
RestActionMapper - Class in org.apache.struts2.rest
  This Restful action mapper enforces Ruby-On-Rails Rest-style mappings.
RestActionMapper() - Constructor for class org.apache.struts2.rest.RestActionMapper
RestActionProxyFactory - Class in org.apache.struts2.rest
  Factory that creates the `RestActionInvocation`
RestActionProxyFactory() - Constructor for class org.apache.struts2.rest.RestActionProxyFactory
RestActionSupport - Class in org.apache.struts2.rest
  Extends `ActionSupport` to provides a default implementation of the index method that can be invoked for unknown actions by the `UnknownHandler`.
RestActionSupport() - Constructor for class org.apache.struts2.rest.RestActionSupport
RestConstantConfig - Class in org.apache.struts2.rest.config.entities
RestConstantConfig() - Constructor for class org.apache.struts2.rest.config.entities.RestConstantConfig
RestConstants - Class in org.apache.struts2.rest
RestConstants() - Constructor for class org.apache.struts2.rest.RestConstants
RestWorkflowInterceptor - Class in org.apache.struts2.rest
  An interceptor that makes sure there are not validation errors before allowing the interceptor chain to continue.
RestWorkflowInterceptor() - Constructor for class org.apache.struts2.rest.RestWorkflowInterceptor

## S

saveResult(ActionConfig, Object) - Method in class org.apache.struts2.rest.RestActionInvocation
  Save the result to be used later.
selectTarget() - Method in class org.apache.struts2.rest.RestActionInvocation
setAllowDynamicMethodCalls(String) - Method in class org.apache.struts2.rest.RestActionMapper
setContainer(Container) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
setContentTypeHandlerManager(ContentTypeHandlerManager) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
setContentTypeHandlerSelector(ContentTypeHandlerManager) - Method in class org.apache.struts2.rest.ContentTypeInterceptor
setDefaultEncoding(String) - Method in class org.apache.struts2.rest.handler.JacksonJsonHandler
setDefaultErrorResultName(String) - Method in class org.apache.struts2.rest.RestActionInvocation
setDefaultExtension(String) - Method in class org.apache.struts2.rest.DefaultContentTypeHandlerManager
setDeleteMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setEditMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setEditMethodName(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
setGetMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setIdParameterName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setIndexMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setInputResultName(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
  Set the `inputResultName` (result name to be returned when a action / field error is found registered).
setLocation(String) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
setLocationId(Object) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
setLogger(String) - Method in class org.apache.struts2.rest.RestActionInvocation
setMapperDeleteMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperEditMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperGetMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperIndexMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperNewMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperOptionsMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperPostContinueMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperPostMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperPutContinueMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMapperPutMethodName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setMimeTypeHandlerSelector(ContentTypeHandlerManager) - Method in class org.apache.struts2.rest.RestActionInvocation
setNamespace(String) - Method in class org.apache.struts2.rest.RestActionProxyFactory
setNewMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setNewMethodName(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
setOptionsMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setPostContinueMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setPostMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setPostMethodName(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
setPutContinueMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setPutMethodName(String) - Method in class org.apache.struts2.rest.RestActionMapper
setPutMethodName(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
setRestContentRestrictToGet(Boolean) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setRestDefaultErrorResultName(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setRestDefaultExtension(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setRestLogger(Boolean) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setRestNamespace(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setRestrictToGet(String) - Method in class org.apache.struts2.rest.RestActionInvocation
  If set to true (by default) blocks returning content from any other methods than GET, if set to false, the content can be returned for any kind of method
setRestValidationFailureStatusCode(String) - Method in class org.apache.struts2.rest.config.entities.RestConstantConfig
setStatus(int) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
setStatus(int) - Method in interface org.apache.struts2.rest.HttpHeaders
setValidationFailureStatusCode(String) - Method in class org.apache.struts2.rest.RestWorkflowInterceptor
STRUTS_REST_HANDLER_OVERRIDE_PREFIX - Static variable in interface org.apache.struts2.rest.ContentTypeHandlerManager
STRUTS_REST_NAMESPACE - Static variable in class org.apache.struts2.rest.RestConstants

## T

target - Variable in class org.apache.struts2.rest.RestActionInvocation
toObject(ActionInvocation, Reader, Object) - Method in interface org.apache.struts2.rest.handler.ContentTypeHandler
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.FormUrlEncodedHandler
  No transformation is required as the framework handles this data
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.HtmlHandler
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.JacksonJsonHandler
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.JacksonXmlHandler
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.JuneauXmlHandler
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.MultipartFormDataHandler
  No transformation is required as the framework handles this data
toObject(ActionInvocation, Reader, Object) - Method in class org.apache.struts2.rest.handler.XStreamHandler

## U

updateContinue() - Method in class org.apache.struts2.rest.RestActionSupport
  By default, return continue.
updateStatusFromResult() - Method in class org.apache.struts2.rest.RestActionInvocation
  Get the status code from HttpHeaderResult and it is saved in the HttpHeaders object.

## W

withETag(Object) - Method in class org.apache.struts2.rest.DefaultHttpHeaders
withNoETag() - Method in class org.apache.struts2.rest.DefaultHttpHeaders
withStatus(int) - Method in class org.apache.struts2.rest.DefaultHttpHeaders

## X

XStreamAllowedClasses - Interface in org.apache.struts2.rest.handler.xstream
XStreamAllowedClassNames - Interface in org.apache.struts2.rest.handler.xstream
XStreamHandler - Class in org.apache.struts2.rest.handler
  Handles XML content
XStreamHandler() - Constructor for class org.apache.struts2.rest.handler.XStreamHandler
XStreamPermissionProvider - Interface in org.apache.struts2.rest.handler.xstream
XStreamProvider - Interface in org.apache.struts2.rest.handler.xstream
  An interface to be implemented by an action to create/provide an instance of XStream - it allows customisation per action

A C D F G H I J L M N O P R S T U W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form