org.apache.chemistry.opencmis.server.support.wrapper

Class AbstractBindingCmisServiceWrapper

java.lang.Object

org.apache.chemistry.opencmis.server.support.wrapper.AbstractCmisServiceWrapper

org.apache.chemistry.opencmis.server.support.wrapper.AbstractBindingCmisServiceWrapper

All Implemented Interfaces:

CmisService, ProgressControlCmisService, AclService, DiscoveryService, MultiFilingService, NavigationService, ObjectService, PolicyService, RelationshipService, RepositoryService, VersioningService, CallContextAwareCmisService

public abstract class AbstractBindingCmisServiceWrapper
extends AbstractCmisServiceWrapper

This abstract service wrapper is intended for manipulating and replacing server responses.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.chemistry.opencmis.commons.server.ProgressControlCmisService

ProgressControlCmisService.Progress

Constructor Summary

Constructors

Constructor and Description
AbstractBindingCmisServiceWrapper(CmisService service)

Method Summary

Modifier and Type	Method and Description
ProgressControlCmisService.Progress	afterServiceCall() Called by the server framework after the requested service method has been called.
ProgressControlCmisService.Progress	beforeServiceCall() Called by the server framework before the requested service method is called.
BindingType	getBindingType() Returns the binding type.
Date	getDateRequestHeader(String name) Gets a request header value as Date.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Returns the HttpServletRequest object.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Returns the HttpServletResponse object.
String	getRequestHeader(String name) Gets a request header value as String.
boolean	isNotModified(Date date) Compares the provided date with the "If-Modified-Since" HTTP header (if present) and returns whether the resource has been modified or not.
void	setAfterServiceCall(ProgressControlCmisService.Progress progress) Sets whether the server framework should continue after the service is called.
void	setBeforeServiceCall(ProgressControlCmisService.Progress progress) Sets whether the server framework should continue before the service is called.
void	setResponseHeader(String name, Date value) Sets a Date response header.
void	setResponseHeader(String name, String value) Sets a String response header.

Methods inherited from class org.apache.chemistry.opencmis.server.support.wrapper.AbstractCmisServiceWrapper

addObjectToFolder, appendContentStream, applyAcl, applyAcl, applyPolicy, bulkUpdateProperties, cancelCheckOut, checkIn, checkOut, close, create, createDocument, createDocumentFromSource, createFolder, createItem, createPolicy, createRelationship, createType, deleteContentStream, deleteObject, deleteObjectOrCancelCheckOut, deleteTree, deleteType, getAcl, getAllowableActions, getAllVersions, getAppliedPolicies, getCallContext, getCheckedOutDocs, getChildren, getContentChanges, getContentStream, getDescendants, getFolderParent, getFolderTree, getObject, getObjectByPath, getObjectInfo, getObjectOfLatestVersion, getObjectParents, getObjectRelationships, getProperties, getPropertiesOfLatestVersion, getRenditions, getRepositoryInfo, getRepositoryInfos, getTypeChildren, getTypeDefinition, getTypeDescendants, getWrappedService, initialize, moveObject, query, removeObjectFromFolder, removePolicy, setCallContext, setContentStream, updateProperties, updateType

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBindingCmisServiceWrapper

public AbstractBindingCmisServiceWrapper(CmisService service)

Method Detail

beforeServiceCall

public ProgressControlCmisService.Progress beforeServiceCall()

Description copied from interface: ProgressControlCmisService

Called by the server framework before the requested service method is called.

Specified by:

beforeServiceCall in interface ProgressControlCmisService

Overrides:

beforeServiceCall in class AbstractCmisServiceWrapper

Returns:

ProgressControlCmisService.Progress.CONTINUE if the server framework should continue processing the request, ProgressControlCmisService.Progress.STOP id the server framework should stop

afterServiceCall

public ProgressControlCmisService.Progress afterServiceCall()

Description copied from interface: ProgressControlCmisService

Called by the server framework after the requested service method has been called.

Specified by:

afterServiceCall in interface ProgressControlCmisService

Overrides:

afterServiceCall in class AbstractCmisServiceWrapper

Returns:

ProgressControlCmisService.Progress.CONTINUE if the server framework should continue processing the request, ProgressControlCmisService.Progress.STOP id the server framework should stop

setBeforeServiceCall

public void setBeforeServiceCall(ProgressControlCmisService.Progress progress)

Sets whether the server framework should continue before the service is called.

Parameters:

progress - Progress#CONTINUE if the server framework should continue, Progress#STOP if the server framework should stop

setAfterServiceCall

public void setAfterServiceCall(ProgressControlCmisService.Progress progress)

Sets whether the server framework should continue after the service is called.

Parameters:

progress - Progress#CONTINUE if the server framework should continue, Progress#STOP if the server framework should stop

getBindingType

public BindingType getBindingType()

Returns the binding type.

Returns:

the binding type

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Returns the HttpServletRequest object.

Returns:

the HttpServletRequest object or null if the binding is a non-HTTP binding

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Returns the HttpServletResponse object.

Returns:

the HttpServletResponse object or null if the binding is a non-HTTP binding

getRequestHeader

public String getRequestHeader(String name)

Gets a request header value as String.

Parameters:

name - the header name

Returns:

the header value or null if the header isn't set or if the binding is a non-HTTP binding

getDateRequestHeader

public Date getDateRequestHeader(String name)

Gets a request header value as Date.

Parameters:

name - the header name

Returns:

the header value or null if the header isn't set or if the binding is a non-HTTP binding or if the date cannot be parsed

setResponseHeader

public void setResponseHeader(String name,
                              String value)

Sets a String response header. If the binding is a non-HTTP binding, this method does nothing.

Parameters:

name - the header name

value - the header value

setResponseHeader

public void setResponseHeader(String name,
                              Date value)

Sets a Date response header. If the binding is a non-HTTP binding, this method does nothing.

Parameters:

name - the header name

value - the header value

isNotModified

public boolean isNotModified(Date date)

Compares the provided date with the "If-Modified-Since" HTTP header (if present) and returns whether the resource has been modified or not.

Parameters:

date - date to compare the "If-Modified-Since" HTTP header to

Returns:

true if the "If-Modified-Since" HTTP header is set and , false otherwise