com.tsgrp.opencontent.core.content

Class AbstractContentImpl

java.lang.Object

com.tsgrp.opencontent.core.content.AbstractContentImpl

All Implemented Interfaces:

IContent

Direct Known Subclasses:

AlfrescoEmbContentImpl, DCTMContentImpl, DynamoContentImpl, ElasticsearchContentImpl, HBaseContentImpl, S3ContentImpl, SolrContentImpl

public abstract class AbstractContentImpl
extends java.lang.Object
implements IContent

The abstract implementation of a contentImpl. This contains all the common methods that a content implementation must implement. Many of these methods currently relate to Events.

Field Summary

Fields

Modifier and Type	Field and Description
OCPolicyComponent	ocPolicyComponent This is Event stuff.

Constructor Summary

Constructors

Constructor and Description
AbstractContentImpl()

Method Summary

Modifier and Type	Method and Description
java.util.List<ContentResult>	bulkEnhancedCreateObjects(java.lang.String ticket, java.util.List<EnhancedCompleteObject> objects) Attempts to create new enhanced objects in the system, and returns the results.
java.util.List<ContentResult>	bulkEnhancedCreateObjects(java.lang.String ticket, java.util.List<EnhancedCompleteObject> objects, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Attempts to create new enhanced objects in the system, and returns the results.
abstract ContentResult	doEnhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object)
abstract ContentResult	doEnhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete)
abstract ContentResult	doEnhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion)
abstract OpenContentObject	doUpdateObject(java.lang.String ticket, OpenContentObject oco)
ContentResult	enhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object) Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties
ContentResult	enhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties
ContentResult	enhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete) Retrieves document content and properties
ContentResult	enhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Delete the object specified by id
ContentResult	enhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion) Updates existing document object in the repository.
ContentResult	enhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Updates existing document object in the repository.
java.net.URL	generatePresignedUrl(java.lang.String ticket, java.lang.String objectId, java.lang.String[] fileExtensions, boolean download, boolean inline) Returns a presigned url to requested content
OpenContentObject	getObject(java.lang.String ticket, java.lang.String id) Obtain object by passing its unique id
void	setOcPolicyComponent(OCPolicyComponent ocPolicyComponent)
OpenContentObject	updateObject(java.lang.String ticket, OpenContentObject oco) Updates the object with the same ID as the id provided on the new object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tsgrp.opencontent.core.content.IContent

addRelation, applyAspect, cancelCheckout, checkin, checkin, checkin, checkout, copyDocument, createObject, deleteObjects, enhancedGetObject, enhancedGetObjectByPath, enhancedGetPathByFolderId, enhancedGetProperties, getAppliedAspects, getContent, getLockOwner, getObjectByPath, getObjectByPath, getObjectByVersion, getPermissionsRequest, link, lockDocument, moveObject, removeRelation, unlockDocument, updateObject, updateObjects

Field Detail

ocPolicyComponent

public OCPolicyComponent ocPolicyComponent

This is Event stuff.

Constructor Detail

AbstractContentImpl

public AbstractContentImpl()

Method Detail

doEnhancedCreateObject

public abstract ContentResult doEnhancedCreateObject(java.lang.String ticket,
                                                     EnhancedCompleteObject object)

doEnhancedUpdateObject

public abstract ContentResult doEnhancedUpdateObject(java.lang.String ticket,
                                                     java.lang.String id,
                                                     EnhancedCompleteObject object,
                                                     boolean newVersion,
                                                     boolean majorVersion)

doUpdateObject

public abstract OpenContentObject doUpdateObject(java.lang.String ticket,
                                                 OpenContentObject oco)

doEnhancedDeleteObject

public abstract ContentResult doEnhancedDeleteObject(java.lang.String ticket,
                                                     java.lang.String id,
                                                     boolean allVersions,
                                                     boolean forceDelete)

enhancedCreateObject

public ContentResult enhancedCreateObject(java.lang.String ticket,
                                          EnhancedCompleteObject object)

Description copied from interface: IContent

Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties

Specified by:

enhancedCreateObject in interface IContent

Parameters:

ticket - String representing the session's ticket

object - EnhancedCompleteObject object to create in the system

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

enhancedCreateObject

public ContentResult enhancedCreateObject(java.lang.String ticket,
                                          EnhancedCompleteObject object,
                                          java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Description copied from interface: IContent

Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties

Specified by:

enhancedCreateObject in interface IContent

Parameters:

ticket - String representing the session's ticket

object - EnhancedCompleteObject object to create in the system

additionalEventParams - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection)

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

bulkEnhancedCreateObjects

public java.util.List<ContentResult> bulkEnhancedCreateObjects(java.lang.String ticket,
                                                               java.util.List<EnhancedCompleteObject> objects)

Description copied from interface: IContent

Attempts to create new enhanced objects in the system, and returns the results. Expects an objectName property to be set in each object's properties.

Specified by:

bulkEnhancedCreateObjects in interface IContent

Parameters:

ticket - - String representing the session's ticket.

objects - - List of EnhancedCompleteObject objects to create in the system.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

bulkEnhancedCreateObjects

public java.util.List<ContentResult> bulkEnhancedCreateObjects(java.lang.String ticket,
                                                               java.util.List<EnhancedCompleteObject> objects,
                                                               java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Description copied from interface: IContent

Attempts to create new enhanced objects in the system, and returns the results. Expects an objectName property to be set in each object's properties.

Specified by:

bulkEnhancedCreateObjects in interface IContent

Parameters:

ticket - - String representing the session's ticket.

objects - - List of EnhancedCompleteObject objects to create in the system.

additionalEventParams - - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection).

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

enhancedUpdateObject

public ContentResult enhancedUpdateObject(java.lang.String ticket,
                                          java.lang.String id,
                                          EnhancedCompleteObject object,
                                          boolean newVersion,
                                          boolean majorVersion)

Description copied from interface: IContent

Updates existing document object in the repository. This call does NOT retain the current lock, regardless if a new version is created or not. In other words, if this call is made and there is currently a lock on the document object, it will be released.

Specified by:

enhancedUpdateObject in interface IContent

Parameters:

ticket - String representing the session's ticket

id - ID of the object to update

object - an EnhancedCompleteObject

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

• ContentResult
• error returns true if update failed, otherwise false
• result contains number of rows updated

enhancedUpdateObject

public ContentResult enhancedUpdateObject(java.lang.String ticket,
                                          java.lang.String id,
                                          EnhancedCompleteObject object,
                                          boolean newVersion,
                                          boolean majorVersion,
                                          java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Description copied from interface: IContent

Updates existing document object in the repository. This call does NOT retain the current lock, regardless if a new version is created or not. In other words, if this call is made and there is currently a lock on the document object, it will be released.

Specified by:

enhancedUpdateObject in interface IContent

Parameters:

ticket - String representing the session's ticket

id - ID of the object to update

object - an EnhancedCompleteObject

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

• ContentResult
• error returns true if update failed, otherwise false
• result contains number of rows updated

updateObject

public OpenContentObject updateObject(java.lang.String ticket,
                                      OpenContentObject oco)

Description copied from interface: IContent

Updates the object with the same ID as the id provided on the new object. Note: This method 'replaces' the object the repo with the object you provide. Any properties on the repo object that are NOT on the supplied object will be removed/nulled out. Will attempt to update objectType, aspects, and properties. Note that this does not version or check in.

Specified by:

updateObject in interface IContent

oco - - The modified Object

Returns:

- The new OCO

enhancedDeleteObject

public ContentResult enhancedDeleteObject(java.lang.String ticket,
                                          java.lang.String id,
                                          boolean allVersions,
                                          boolean forceDelete)

Description copied from interface: IContent

Retrieves document content and properties

Specified by:

enhancedDeleteObject in interface IContent

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object contains the Object we are trying to get

enhancedDeleteObject

public ContentResult enhancedDeleteObject(java.lang.String ticket,
                                          java.lang.String id,
                                          boolean allVersions,
                                          boolean forceDelete,
                                          java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Description copied from interface: IContent

Delete the object specified by id

Specified by:

enhancedDeleteObject in interface IContent

Parameters:

ticket - String representing the session's ticket

id - ID of the object to delete

allVersions - true to delete all versions of the object defined by id, otherwise false

forceDelete - currently only implemented for Alfresco, otherwise false

additionalEventParams - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection)

Returns:

• ContentResult
• error returns true if method failed, otherwise false

getObject

public OpenContentObject getObject(java.lang.String ticket,
                                   java.lang.String id)

Description copied from interface: IContent

Obtain object by passing its unique id

Specified by:

getObject in interface IContent

Parameters:

ticket - String representing the session's ticket

Returns:

OpenContentObject

setOcPolicyComponent

public void setOcPolicyComponent(OCPolicyComponent ocPolicyComponent)

generatePresignedUrl

public java.net.URL generatePresignedUrl(java.lang.String ticket,
                                         java.lang.String objectId,
                                         java.lang.String[] fileExtensions,
                                         boolean download,
                                         boolean inline)

Description copied from interface: IContent

Returns a presigned url to requested content

Specified by:

generatePresignedUrl in interface IContent

download - - if set to true, will set the content-disposition header to 'attachment' so signal download

inline - - if set to true, will set the content-disposition header to 'inline' so that files are shown inline

Returns:

presigned url