com.tsgrp.opencontent.core.action.service

Class RESTAction

java.lang.Object

com.tsgrp.opencontent.rest.RESTService

com.tsgrp.opencontent.core.action.service.RESTAction

@Controller
public class RESTAction
extends RESTService

REST endpoints for executing and evaluating actions.

Field Summary

Fields inherited from class com.tsgrp.opencontent.rest.RESTService

CHUNKSIZE, HEADER_ACCEPT_LANGUAGE, HEADER_ACCEPT_RANGES, HEADER_CACHE_CONTROL, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_RANGE, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_IF_MODIFIED_SINCE, HEADER_LAST_MODIFIED, HEADER_LOCATION, HEADER_RANGE, HEADER_USER_AGENT, MULTIPART_BYTERANGES_BOUNDRY, MULTIPART_BYTERANGES_BOUNDRY_END, MULTIPART_BYTERANGES_BOUNDRY_SEP, MULTIPART_BYTERANGES_HEADER

Constructor Summary

Constructors

Constructor and Description
RESTAction()

Method Summary

Modifier and Type	Method and Description
Action	asyncThreadCheckActionStatus(java.lang.String paramTicket, java.lang.String uniqueId, java.lang.String cookieTicket)
Action	asyncThreadCheckActionStatusForDownload(java.lang.String paramTicket, java.lang.String uniqueId, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	downloadFileInAsyncMap(java.lang.String paramTicket, java.lang.String uniqueId, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Action[]	evaluateActions(java.lang.String paramTicket, java.lang.String id, java.lang.String[] idList, java.lang.String[] actionList, java.lang.String collectionId, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request)
void	executeActionAndReturnFileStream(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String ticketParam, java.lang.String cookie, java.lang.String actionName, java.lang.String actionParameters, boolean download, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Action	executeActionAndStreamFile(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String actionAsJson, boolean download, java.lang.String mimeType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) For triggering actions that modify or read something in the repository.
void	executeActionAndStreamFile(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String actionName, java.lang.String actionParameters, boolean download, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.lang.Object	executeActionGet(java.lang.String paramTicket, Action action, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest req) Deprecated. Use POST request istead
org.springframework.http.ResponseEntity<java.lang.Object>	executeActionGetWithStringResponse(java.lang.String paramTicket, Action action, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest req) Deprecated. This method was used for Uploadify support in IE9. No longer supported
Action	executeActionPost(java.lang.String paramTicket, Action action, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest req)
org.springframework.http.ResponseEntity<java.lang.Object>	executeActionPostWithAttachment(java.lang.String paramTicket, java.lang.String actionAsJson, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request)
java.lang.Object	executeActionPostWithAttachmentObjectResponse(java.lang.String paramTicket, java.lang.String actionAsJson, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<java.lang.Object>	executeActionPostWithAttachmentStringResponse(java.lang.String paramTicket, java.lang.String actionAsJson, java.lang.String cookieTicket, javax.servlet.http.HttpServletRequest request) Deprecated. This method was used for Uploadify support in IE9. No longer supported
java.util.Map<java.lang.String,ActionExecuter>	getAllAvailableActions(java.lang.String paramTicket, java.lang.String cookieTicket)

Methods inherited from class com.tsgrp.opencontent.rest.RESTService

contentNotProcessed, contentNotReady, genericException, notAuth, notFoundException, notSupported, objectLocked, ocConflict, ocConflict, ocForbidden, ocRuntimeException, resolveTicket

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTAction

public RESTAction()

Method Detail

evaluateActions

@RequestMapping(value="/action/evaluate",
                method=GET)
 @ResponseBody
public Action[] evaluateActions(@RequestParam(value="ticket",required=false)
                                                                                                                        java.lang.String paramTicket,
                                                                                                                        @RequestParam(value="id",required=false)
                                                                                                                        java.lang.String id,
                                                                                                                        @RequestParam(value="idList[]",required=false)
                                                                                                                        java.lang.String[] idList,
                                                                                                                        @RequestParam(value="actionList[]")
                                                                                                                        java.lang.String[] actionList,
                                                                                                                        @RequestParam(value="collectionId",required=false)
                                                                                                                        java.lang.String collectionId,
                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                        java.lang.String cookieTicket,
                                                                                                                        javax.servlet.http.HttpServletRequest request)

executeActionGet

@Deprecated
 @RequestMapping(value="/action/execute",
                method=GET)
 @ResponseBody
public java.lang.Object executeActionGet(@RequestParam(value="ticket",required=false)
                                                                                                                                              java.lang.String paramTicket,
                                                                                                                                              @RequestParam(value="action",required=true)
                                                                                                                                              Action action,
                                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                                              java.lang.String cookieTicket,
                                                                                                                                              javax.servlet.http.HttpServletRequest req)

Deprecated. Use POST request istead

Executes the specified action. NOTE: This endpoint is NOT compatible with IE<10. It should only be used in modern browsers.

Parameters:

paramTicket - A valid OC ticket.

action - The action to execute. This parameter should contain all the action parameters needed to execute the action.

cookieTicket - A valid OC ticket.

Returns:

The action that was passed in is returned to the caller.

See Also:

executeActionPost(String, Action, String, HttpServletRequest)

executeActionGetWithStringResponse

@Deprecated
 @RequestMapping(value="/action/executeWithStringResponse",
                method=GET)
 @ResponseBody
public org.springframework.http.ResponseEntity<java.lang.Object> executeActionGetWithStringResponse(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                                           java.lang.String paramTicket,
                                                                                                                                                                                                                           @RequestParam(value="action",required=true)
                                                                                                                                                                                                                           Action action,
                                                                                                                                                                                                                           @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                                           java.lang.String cookieTicket,
                                                                                                                                                                                                                           javax.servlet.http.HttpServletRequest req)

Deprecated. This method was used for Uploadify support in IE9. No longer supported

Executes the passed in action. This endpoint returns a string response that is compatible with IE<10 (and modern browsers).

Parameters:

paramTicket - A valid OC ticket.

action - The action to execute. This parameter should contain all the action parameters needed to execute the action.

cookieTicket - A valid OC ticket.

Returns:

A ResponseEntity object containing the result of executing the action.

executeActionPost

@RequestMapping(value="/action/execute",
                method=POST)
 @ResponseBody
public Action executeActionPost(@RequestParam(value="ticket",required=false)
                                                                                                                        java.lang.String paramTicket,
                                                                                                                        @RequestBody
                                                                                                                        Action action,
                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                        java.lang.String cookieTicket,
                                                                                                                        javax.servlet.http.HttpServletRequest req)

asyncThreadCheckActionStatus

@RequestMapping(value="/asyncThread/status",
                method=POST)
 @ResponseBody
public Action asyncThreadCheckActionStatus(@RequestParam(value="ticket",required=false)
                                                                                                                                       java.lang.String paramTicket,
                                                                                                                                       @RequestParam(value="uniqueId",required=false)
                                                                                                                                       java.lang.String uniqueId,
                                                                                                                                       @CookieValue(value="ticket",required=false)
                                                                                                                                       java.lang.String cookieTicket)

asyncThreadCheckActionStatusForDownload

@RequestMapping(value="/asyncThread/download/status",
                method=POST)
 @ResponseBody
public Action asyncThreadCheckActionStatusForDownload(@RequestParam(value="ticket",required=false)
                                                                                                                                                           java.lang.String paramTicket,
                                                                                                                                                           @RequestParam(value="uniqueId",required=false)
                                                                                                                                                           java.lang.String uniqueId,
                                                                                                                                                           @CookieValue(value="ticket",required=false)
                                                                                                                                                           java.lang.String cookieTicket,
                                                                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                                                                           javax.servlet.http.HttpServletResponse response)
                                                                                                                                                    throws java.io.IOException

Throws:

java.io.IOException

downloadFileInAsyncMap

@RequestMapping(value="/asyncMap/download/file",
                method=POST)
 @ResponseBody
public void downloadFileInAsyncMap(@RequestParam(value="ticket",required=false)
                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                   @RequestParam(value="uniqueId",required=false)
                                                                                                                                   java.lang.String uniqueId,
                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                                                   javax.servlet.http.HttpServletResponse response)
                                                                                                                            throws java.io.IOException

Throws:

java.io.IOException

executeActionAndStreamFile

@RequestMapping(value="/action/executeAndReturnStream",
                method=POST)
 @ResponseBody
public void executeActionAndStreamFile(@RequestParam(value="ticket",required=false)
                                                                                                                                              java.lang.String paramTicket,
                                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                                              java.lang.String cookieTicket,
                                                                                                                                              @RequestParam(value="name")
                                                                                                                                              java.lang.String actionName,
                                                                                                                                              @RequestParam(value="parameters")
                                                                                                                                              java.lang.String actionParameters,
                                                                                                                                              @RequestParam(value="download",required=true)
                                                                                                                                              boolean download,
                                                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                                                              javax.servlet.http.HttpServletResponse response)

executeActionAndReturnFileStream

@RequestMapping(value="/action/executeAndReturnFileStream",
                method=POST)
 @ResponseBody
public void executeActionAndReturnFileStream(@RequestParam(value="ticket",required=false)
                                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                                        java.lang.String cookieTicket,
                                                                                                                                                        @RequestParam(value="ticket",required=false)
                                                                                                                                                        java.lang.String ticketParam,
                                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                                        java.lang.String cookie,
                                                                                                                                                        @RequestParam(value="name")
                                                                                                                                                        java.lang.String actionName,
                                                                                                                                                        @RequestParam(value="parameters")
                                                                                                                                                        java.lang.String actionParameters,
                                                                                                                                                        @RequestParam(value="download",required=true)
                                                                                                                                                        boolean download,
                                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                                        javax.servlet.http.HttpServletResponse response)

executeActionAndStreamFile

@RequestMapping(value="/action/executeAndReturnStream",
                method=GET)
 @ResponseBody
public Action executeActionAndStreamFile(@RequestParam(value="ticket",required=false)
                                                                                                                                               java.lang.String paramTicket,
                                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                                               java.lang.String cookieTicket,
                                                                                                                                               @RequestParam(value="action",required=true)
                                                                                                                                               java.lang.String actionAsJson,
                                                                                                                                               @RequestParam(value="download",required=true)
                                                                                                                                               boolean download,
                                                                                                                                               @RequestParam(value="contentType",required=false)
                                                                                                                                               java.lang.String mimeType,
                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                               javax.servlet.http.HttpServletResponse response)

For triggering actions that modify or read something in the repository. It accepts the action as a JSON and conditionally streams back a result. (GET request)

Parameters:

paramTicket -

cookieTicket -

actionAsJson - The JSON string representation of the action, requiring the properties "name" and "parameters" (EX: { "name": "makeDocsEffective", "parameters":{}}). This will be parsed into an Action object to be executed

download - Whether or not to stream the result into the HttpServletResponse

mimeType - Mimetype of the expected stream response

request -

response -

Returns:

executeActionPostWithAttachment

@RequestMapping(value="/action/executeWithAttachment",
                method=POST)
 @ResponseBody
public org.springframework.http.ResponseEntity<java.lang.Object> executeActionPostWithAttachment(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                       java.lang.String paramTicket,
                                                                                                                                                                                                       @RequestParam(value="action",required=true)
                                                                                                                                                                                                       java.lang.String actionAsJson,
                                                                                                                                                                                                       @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                       java.lang.String cookieTicket,
                                                                                                                                                                                                       javax.servlet.http.HttpServletRequest request)

executeActionPostWithAttachmentObjectResponse

@RequestMapping(value="/action/executeWithAttachmentObjectResponse",
                method=POST)
 @ResponseBody
public java.lang.Object executeActionPostWithAttachmentObjectResponse(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                          java.lang.String paramTicket,
                                                                                                                                                                                          @RequestParam(value="action",required=true)
                                                                                                                                                                                          java.lang.String actionAsJson,
                                                                                                                                                                                          @CookieValue(value="ticket",required=false)
                                                                                                                                                                                          java.lang.String cookieTicket,
                                                                                                                                                                                          javax.servlet.http.HttpServletRequest request)

executeActionPostWithAttachmentStringResponse

@Deprecated
 @RequestMapping(value="/action/executeWithAttachmentStringResponse",
                method=POST)
 @ResponseBody
public org.springframework.http.ResponseEntity<java.lang.Object> executeActionPostWithAttachmentStringResponse(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                                                                 java.lang.String paramTicket,
                                                                                                                                                                                                                                                 @RequestParam(value="action",required=true)
                                                                                                                                                                                                                                                 java.lang.String actionAsJson,
                                                                                                                                                                                                                                                 @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                                                                 java.lang.String cookieTicket,
                                                                                                                                                                                                                                                 javax.servlet.http.HttpServletRequest request)

Deprecated. This method was used for Uploadify support in IE9. No longer supported

Executes the passed in action. This endpoint expects the request to contain a file to parse and pass to the called action. This endpoint is compatible with IE<10 (and modern browsers).

Parameters:

paramTicket - A valid OC ticket.

actionAsJson - The action to execute as a JSON string. This will be parsed into an Action object to be executed.

cookieTicket - A valid OC ticket.

request - The HttpServletRequest object that contains a file to parse and add to the action parameters.

Returns:

A ResponseEntity object containing the result of executing the passed in action.

getAllAvailableActions

@RequestMapping(value="/action/available",
                method=GET)
 @ResponseBody
public java.util.Map<java.lang.String,ActionExecuter> getAllAvailableActions(@RequestParam(value="ticket",required=false)
                                                                                                                                                                      java.lang.String paramTicket,
                                                                                                                                                                      @CookieValue(value="ticket",required=false)
                                                                                                                                                                      java.lang.String cookieTicket)