com.tsgrp.opencontent.rest

Class RESTService

java.lang.Object

com.tsgrp.opencontent.rest.RESTService

Direct Known Subclasses:

RESTAction, RESTAdlib, RESTAlfresco, RESTAnnotation, RESTAudit, RESTAuthentication, RESTBlazon, RESTCache, RESTCondition, RESTConfigService, RESTContent, RESTDictionaryService, RESTDynamo, RESTDynamoTest, RESTElasticsearch, RESTEmail, RESTEphesoft, RESTGoogle, RESTHBase, RESTHBaseTest, RESTHpi, RESTLicense, RESTLifecycle, RESTNotification, RESTOpenAnnotate, RESTPdf, RESTPerformanceLogging, RESTPermission, RESTPicklist, RESTPSAService, RESTQuery, RESTRepoInfo, RESTSalesforce, RESTSecurity, RESTShortLink, RESTSolr, RESTTemplate, RESTTransformation, RestUser, RESTUserPreferencesService, RESTUserUtil, RESTVideo, RESTWizard2, RESTWizard2Admin, RESTWizard2WorkflowAdmin, RESTWizardJobs, RESTWizardWorkflow, RESTWordDocumentTemplate, RESTWorkflow, RESTWorkshare

public class RESTService
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHUNKSIZE size of a multi-part byte range output buffer
static java.lang.String	HEADER_ACCEPT_LANGUAGE
static java.lang.String	HEADER_ACCEPT_RANGES
static java.lang.String	HEADER_CACHE_CONTROL
static java.lang.String	HEADER_CONTENT_DISPOSITION
static java.lang.String	HEADER_CONTENT_LANGUAGE
static java.lang.String	HEADER_CONTENT_LENGTH
static java.lang.String	HEADER_CONTENT_RANGE
static java.lang.String	HEADER_CONTENT_TYPE
static java.lang.String	HEADER_ETAG
static java.lang.String	HEADER_IF_MODIFIED_SINCE
static java.lang.String	HEADER_LAST_MODIFIED
static java.lang.String	HEADER_LOCATION
static java.lang.String	HEADER_RANGE
static java.lang.String	HEADER_USER_AGENT
static java.lang.String	MULTIPART_BYTERANGES_BOUNDRY
static java.lang.String	MULTIPART_BYTERANGES_BOUNDRY_END
static java.lang.String	MULTIPART_BYTERANGES_BOUNDRY_SEP
static java.lang.String	MULTIPART_BYTERANGES_HEADER

Constructor Summary

Constructors

Constructor and Description
RESTService()

Method Summary

Modifier and Type	Method and Description
OCErrorResponse	contentNotProcessed(OCContentCannotBeProcessedException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	contentNotReady(OCContentNotReadyException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	genericException(java.lang.Throwable e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	notAuth(OCAuthenticationException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	notFoundException(OCObjectNotFoundException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	notSupported(OCNotSupportedException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	objectLocked(OCObjectLockedException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	ocConflict(OCConflictException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	ocConflict(OCContentFormatException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	ocForbidden(OCForbiddenRuntimeException e, javax.servlet.http.HttpServletResponse response)
OCErrorResponse	ocRuntimeException(OCRuntimeException e, javax.servlet.http.HttpServletResponse response)
protected java.lang.String	resolveTicket(java.lang.String cookieTicket, java.lang.String paramTicket) Resolves the ticket from the cookie or param.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_LOCATION

public static final java.lang.String HEADER_LOCATION

See Also:

Constant Field Values

HEADER_IF_MODIFIED_SINCE

public static final java.lang.String HEADER_IF_MODIFIED_SINCE

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

public static final java.lang.String HEADER_CONTENT_TYPE

See Also:

Constant Field Values

HEADER_CONTENT_RANGE

public static final java.lang.String HEADER_CONTENT_RANGE

See Also:

Constant Field Values

HEADER_CONTENT_LANGUAGE

public static final java.lang.String HEADER_CONTENT_LANGUAGE

See Also:

Constant Field Values

HEADER_CONTENT_LENGTH

public static final java.lang.String HEADER_CONTENT_LENGTH

See Also:

Constant Field Values

HEADER_ACCEPT_RANGES

public static final java.lang.String HEADER_ACCEPT_RANGES

See Also:

Constant Field Values

HEADER_ACCEPT_LANGUAGE

public static final java.lang.String HEADER_ACCEPT_LANGUAGE

See Also:

Constant Field Values

HEADER_RANGE

public static final java.lang.String HEADER_RANGE

See Also:

Constant Field Values

HEADER_ETAG

public static final java.lang.String HEADER_ETAG

See Also:

Constant Field Values

HEADER_CACHE_CONTROL

public static final java.lang.String HEADER_CACHE_CONTROL

See Also:

Constant Field Values

HEADER_LAST_MODIFIED

public static final java.lang.String HEADER_LAST_MODIFIED

See Also:

Constant Field Values

HEADER_USER_AGENT

public static final java.lang.String HEADER_USER_AGENT

See Also:

Constant Field Values

HEADER_CONTENT_DISPOSITION

public static final java.lang.String HEADER_CONTENT_DISPOSITION

See Also:

Constant Field Values

MULTIPART_BYTERANGES_BOUNDRY

public static final java.lang.String MULTIPART_BYTERANGES_BOUNDRY

See Also:

Constant Field Values

MULTIPART_BYTERANGES_HEADER

public static final java.lang.String MULTIPART_BYTERANGES_HEADER

See Also:

Constant Field Values

MULTIPART_BYTERANGES_BOUNDRY_SEP

public static final java.lang.String MULTIPART_BYTERANGES_BOUNDRY_SEP

See Also:

Constant Field Values

MULTIPART_BYTERANGES_BOUNDRY_END

public static final java.lang.String MULTIPART_BYTERANGES_BOUNDRY_END

See Also:

Constant Field Values

CHUNKSIZE

public static final int CHUNKSIZE

size of a multi-part byte range output buffer

See Also:

Constant Field Values

Constructor Detail

RESTService

public RESTService()

Method Detail

resolveTicket

protected java.lang.String resolveTicket(java.lang.String cookieTicket,
                                         java.lang.String paramTicket)

Resolves the ticket from the cookie or param. Ideally one of these is null and it returns the other. If both are present, the paramTicket is preferred.

Parameters:

cookieTicket -

paramTicket -

Returns:

the ticket value

genericException

@ExceptionHandler(value=java.lang.Throwable.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ResponseBody
public OCErrorResponse genericException(java.lang.Throwable e,
                                                                                                                                                           javax.servlet.http.HttpServletResponse response)

notFoundException

@ExceptionHandler(value=OCObjectNotFoundException.class)
 @ResponseStatus(value=NOT_FOUND)
 @ResponseBody
public OCErrorResponse notFoundException(OCObjectNotFoundException e,
                                                                                                                                                      javax.servlet.http.HttpServletResponse response)

ocRuntimeException

@ExceptionHandler(value=OCRuntimeException.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ResponseBody
public OCErrorResponse ocRuntimeException(OCRuntimeException e,
                                                                                                                                                            javax.servlet.http.HttpServletResponse response)

ocForbidden

@ExceptionHandler(value=OCForbiddenRuntimeException.class)
 @ResponseStatus(value=FORBIDDEN)
 @ResponseBody
public OCErrorResponse ocForbidden(OCForbiddenRuntimeException e,
                                                                                                                                                  javax.servlet.http.HttpServletResponse response)

notAuth

@ExceptionHandler(value=OCAuthenticationException.class)
 @ResponseStatus(value=UNAUTHORIZED)
 @ResponseBody
public OCErrorResponse notAuth(OCAuthenticationException e,
                                                                                                                                               javax.servlet.http.HttpServletResponse response)

objectLocked

@ExceptionHandler(value=OCObjectLockedException.class)
 @ResponseStatus(value=LOCKED)
 @ResponseBody
public OCErrorResponse objectLocked(OCObjectLockedException e,
                                                                                                                                            javax.servlet.http.HttpServletResponse response)

ocConflict

@ExceptionHandler(value=OCConflictException.class)
 @ResponseStatus(value=CONFLICT)
 @ResponseBody
public OCErrorResponse ocConflict(OCConflictException e,
                                                                                                                                        javax.servlet.http.HttpServletResponse response)

ocConflict

@ExceptionHandler(value=OCContentFormatException.class)
 @ResponseStatus(value=UNSUPPORTED_MEDIA_TYPE)
 @ResponseBody
public OCErrorResponse ocConflict(OCContentFormatException e,
                                                                                                                                                           javax.servlet.http.HttpServletResponse response)

contentNotReady

@ExceptionHandler(value=OCContentNotReadyException.class)
 @ResponseStatus(value=PRECONDITION_FAILED)
 @ResponseBody
public OCErrorResponse contentNotReady(OCContentNotReadyException e,
                                                                                                                                                               javax.servlet.http.HttpServletResponse response)

notSupported

@ExceptionHandler(value=OCNotSupportedException.class)
 @ResponseStatus(value=NOT_IMPLEMENTED)
 @ResponseBody
public OCErrorResponse notSupported(OCNotSupportedException e,
                                                                                                                                                     javax.servlet.http.HttpServletResponse response)

contentNotProcessed

@ExceptionHandler(value=OCContentCannotBeProcessedException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
 @ResponseBody
public OCErrorResponse contentNotProcessed(OCContentCannotBeProcessedException e,
                                                                                                                                                                             javax.servlet.http.HttpServletResponse response)