com.tsgrp.opencontent.elasticsearch.content

Class ElasticsearchContentImpl

java.lang.Object

com.tsgrp.opencontent.core.content.AbstractContentImpl

com.tsgrp.opencontent.elasticsearch.content.ElasticsearchContentImpl

All Implemented Interfaces:

IContent

public class ElasticsearchContentImpl
extends AbstractContentImpl

Field Summary

Fields inherited from class com.tsgrp.opencontent.core.content.AbstractContentImpl

ocPolicyComponent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElasticsearchContentImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	addRelation(AddRelationRequest req) Adds a relation between parent document and children.
void	addSecurityToContentRequest(java.lang.String ticket, java.lang.StringBuffer readQuery) Abstract method used to append additional security to a query for a specific user retrieved from a ticket number.
void	applyAspect(java.lang.String ticket, java.lang.String objectId, java.lang.String aspectType, java.util.Map<java.lang.String,java.lang.Object> mandatoryProperties) Adds an aspect to a document.
boolean	cancelCheckout(java.lang.String ticket, java.lang.String objectId) Cancels checkout of document.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion) Checks in a node to the repository.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion, OpenContentObject object, boolean newVersion, javax.activation.DataHandler dataHandler) Checks in a node to the repository.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion, OpenContentObject object, boolean newVersion, java.lang.Long size, javax.activation.DataHandler dataHandler) Checks in a node to the repository.
boolean	checkout(java.lang.String ticket, java.lang.String objectId) Checks out a document.
ContentResult	copyDocument(java.lang.String ticket, java.lang.String id, java.lang.String copyName) Returns objectId for the given copied document only, no content returned.
java.lang.String	createObject(java.lang.String ticket, CompleteObject object) Imports document content and properties to the repository.
boolean	deleteObjects(java.lang.String ticket, java.lang.String[] objectIds, boolean allVersions) Deletes objects in the content store.
ContentResult	doEnhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object)
ContentResult	doEnhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete)
ContentResult	doEnhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion)
OpenContentObject	doUpdateObject(java.lang.String ticket, OpenContentObject oco)
ContentResult	enhancedGetObject(java.lang.String ticket, java.lang.String id, java.lang.String[] fileExtensionArr) Retrieves document content and properties.
ContentResult	enhancedGetObjectByPath(java.lang.String ticket, java.lang.String path, java.lang.String[] fileExtensionArr)
ContentResult	enhancedGetPathByFolderId(java.lang.String ticket, java.lang.String objectId) Obtain folder path by passing in folder ID
ContentResult	enhancedGetProperties(java.lang.String ticket, java.lang.String id) Returns metadata for the given id only, no content returned.
java.util.List<java.lang.String>	getAppliedAspects(java.lang.String ticket, java.lang.String objectId) Retrieves a list of aspects applied to the provided objectId.
ObjectContent	getContent(GetContentRequest request) GetContent streams runs another query returning only the filePath that streams the file from the filesystem via HPI
EnhancedObjectProperty[]	getEnhancedProperties(java.lang.String ticket, java.lang.String objectId) Retrieves document properties.
UserResult	getLockOwner(java.lang.String ticket, java.lang.String objectId) Returns a UserResult.
OpenContentObject	getObjectByPath(java.lang.String ticket, java.lang.String path) Obtain object by passing its path WARNING: This method opens an InputStream.
OpenContentObject	getObjectByPath(java.lang.String ticket, java.lang.String path, boolean quiet) Obtain object by passing its path This accepts a 'quietMode' parameter that will not throw an error if the object doesn't exist at that path.
ContentResult	getObjectByVersion(java.lang.String ticket, java.lang.String id, java.lang.String versionLabel, java.lang.String[] fileExtensionArr) Obtain object for a specific version
int	getPermissionsRequest(java.lang.String ticket, java.lang.String objectId) Retrieves permissions set on document.
java.util.ArrayList<java.lang.String>	link(java.lang.String ticket, java.lang.String childId, java.lang.String[] unLinkFrom, java.lang.String[] linkTo) Creates a link request between document and folders.
java.lang.String	lockDocument(java.lang.String ticket, java.lang.String objectId) Locks a document.
void	moveObject(java.lang.String ticket, java.lang.String objectId, java.lang.String parentPathOrId) Moves an object in the repository from one folder to another.
protected StringArray[]	performContentQuery(java.lang.String ticket, java.lang.String objectId, java.lang.String idAttr, java.lang.String mimeTypeAttr, java.lang.String contentLocationAttr) Queries for the necessary attributes need to fetch content for a given object id.
ContentResult	removeRelation(java.lang.String ticket, java.lang.String parentObjectId, java.lang.String[] childIds, java.lang.String relationName) Removes the relationship between the parentId and the childIds passed in of the relation type passed in
java.lang.String	unlockDocument(java.lang.String ticket, java.lang.String objectId) Unlocks out a document.
java.lang.String	updateObject(java.lang.String ticket, java.lang.String objectId, CompleteObject object, boolean newVersion, boolean majorVersion) Updates existing document object in the repository.
OpenContentObject[]	updateObjects(java.lang.String ticket, OpenContentObject[] ocos) Updates the objects with the same IDs as provided objects.

Methods inherited from class com.tsgrp.opencontent.core.content.AbstractContentImpl

bulkEnhancedCreateObjects, bulkEnhancedCreateObjects, enhancedCreateObject, enhancedCreateObject, enhancedDeleteObject, enhancedDeleteObject, enhancedUpdateObject, enhancedUpdateObject, generatePresignedUrl, getObject, setOcPolicyComponent, updateObject

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticsearchContentImpl

protected ElasticsearchContentImpl()

Method Detail

addRelation

public java.lang.String[] addRelation(AddRelationRequest req)

Description copied from interface: IContent

Adds a relation between parent document and children.

Parameters:

req - an AddRelationRequest object

Returns:

an array of IDs of relation objects added by this method

See Also:

IContent.addRelation(com.tsgrp.opencontent.core.content.model.AddRelationRequest)

cancelCheckout

public boolean cancelCheckout(java.lang.String ticket,
                              java.lang.String objectId)

Description copied from interface: IContent

Cancels checkout of document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

true if the operation was successful, otherwise false. Note that this method returns true if the object is not locked.

See Also:

IContent.cancelCheckout(java.lang.String, java.lang.String)

checkin

public ContentResult checkin(java.lang.String ticket,
                             java.lang.String objectId,
                             boolean keepLock,
                             java.lang.String versionLabels,
                             java.lang.String comment,
                             boolean majorVersion)

Description copied from interface: IContent

Checks in a node to the repository.

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

Returns:

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

See Also:

com.tsgrp.opencontent.core.content.IContent#checkin(com.tsgrp.opencontent.core.content.model.CheckinRequest)

checkin

public ContentResult checkin(java.lang.String ticket,
                             java.lang.String objectId,
                             boolean keepLock,
                             java.lang.String versionLabels,
                             java.lang.String comment,
                             boolean majorVersion,
                             OpenContentObject object,
                             boolean newVersion,
                             java.lang.Long size,
                             javax.activation.DataHandler dataHandler)

Description copied from interface: IContent

Checks in a node to the repository. Overloaded for impls that require size

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

object - the object to use for setting new property values on checkin - NOTE: this is currently not implemented.

newVersion - whether this should be a new version or the same version.

size - the object size in bytes

dataHandler - the data handler containing the input stream for the new content of the checked in object.

Returns:

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

checkout

public boolean checkout(java.lang.String ticket,
                        java.lang.String objectId)

Description copied from interface: IContent

Checks out a document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

true if the checkout occurred successfully, otherwise false. Note, if the object is already checked out, this method will return false.

See Also:

IContent.checkout(java.lang.String, java.lang.String)

createObject

public java.lang.String createObject(java.lang.String ticket,
                                     CompleteObject object)

Description copied from interface: IContent

Imports document content and properties to the repository. WARNING: This method opens an InputStream. You must close this in the calling method.

Parameters:

ticket - an authentication ticket

object - a CompleteObject obj

Returns:

the object ID of the newly created object

See Also:

IContent.createObject(java.lang.String, com.tsgrp.opencontent.core.content.model.CompleteObject)

deleteObjects

public boolean deleteObjects(java.lang.String ticket,
                             java.lang.String[] objectIds,
                             boolean allVersions)

Description copied from interface: IContent

Deletes objects in the content store.

Parameters:

ticket - an authentication ticket

objectIds - a list of object identifiers to delete

allVersions - if true, deletes all versions

Returns:

true if deletion of all objects was successful, otherwise false

See Also:

IContent.deleteObjects(java.lang.String, java.lang.String[], boolean)

doEnhancedCreateObject

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

Specified by:

doEnhancedCreateObject in class AbstractContentImpl

See Also:

IContent.enhancedCreateObject(java.lang.String, EnhancedCompleteObject)

doEnhancedDeleteObject

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

Specified by:

doEnhancedDeleteObject in class AbstractContentImpl

Parameters:

forceDelete - - Not implemented for Solr, should always be set to False

See Also:

IContent.enhancedDeleteObject(java.lang.String, java.lang.String, boolean, boolean)

enhancedGetObject

public ContentResult enhancedGetObject(java.lang.String ticket,
                                       java.lang.String id,
                                       java.lang.String[] fileExtensionArr)

Description copied from interface: IContent

Retrieves document content and properties. If you only need properties, use IContent.enhancedGetProperties(String, String) instead. Note that since this method gets both content and properties, calling code must close the ContentResult with OCUtil.closeQuietly(ContentResult).

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get

fileExtensionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

Returns:

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

See Also:

IContent.enhancedGetObject(java.lang.String, java.lang.String, java.lang.String[])

getEnhancedProperties

public EnhancedObjectProperty[] getEnhancedProperties(java.lang.String ticket,
                                                      java.lang.String objectId)

Retrieves document properties.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

the properties of the object in array form

enhancedGetObjectByPath

public ContentResult enhancedGetObjectByPath(java.lang.String ticket,
                                             java.lang.String path,
                                             java.lang.String[] fileExtensionArr)

Parameters:

ticket - String representing the session's ticket

path - path to the object to get

fileExtensionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

Returns:

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

See Also:

IContent.enhancedGetObjectByPath(java.lang.String, java.lang.String, java.lang.String[])

enhancedGetPathByFolderId

public ContentResult enhancedGetPathByFolderId(java.lang.String ticket,
                                               java.lang.String objectId)

Description copied from interface: IContent

Obtain folder path by passing in folder ID

Parameters:

ticket - String representing the session's ticket

objectId - id of the folder to get path from

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• ContentResult.result contains the folder path we are trying to get

See Also:

IContent.enhancedGetPathByFolderId(java.lang.String, java.lang.String)

doEnhancedUpdateObject

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

Specified by:

doEnhancedUpdateObject in class AbstractContentImpl

See Also:

IContent.enhancedUpdateObject(java.lang.String, java.lang.String, EnhancedCompleteObject, boolean, boolean)

getContent

public ObjectContent getContent(GetContentRequest request)

GetContent streams runs another query returning only the filePath that streams the file from the filesystem via HPI

Parameters:

request - GetContentRequest that is provided by HPI

Returns:

ObjectContent object that contains the mimetype, objectName, and full file path on the filessystem

See Also:

IContent.getContent(com.tsgrp.opencontent.core.content.model.GetContentRequest)

getPermissionsRequest

public int getPermissionsRequest(java.lang.String ticket,
                                 java.lang.String objectId)

Description copied from interface: IContent

Retrieves permissions set on document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

the permission on the object

See Also:

IContent.getPermissionsRequest(java.lang.String, java.lang.String)

link

public java.util.ArrayList<java.lang.String> link(java.lang.String ticket,
                                                  java.lang.String childId,
                                                  java.lang.String[] unLinkFrom,
                                                  java.lang.String[] linkTo)

Description copied from interface: IContent

Creates a link request between document and folders.

Parameters:

ticket - String representing the session's ticket

childId - ID of the object that is to be linked

unLinkFrom - String[] representing the folders that the object will be unlinked from

linkTo - String[] representing the folders that the object will be linked to

Returns:

A of folder IDs that objectId was linked to

See Also:

IContent.link(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])

updateObject

public java.lang.String updateObject(java.lang.String ticket,
                                     java.lang.String objectId,
                                     CompleteObject object,
                                     boolean newVersion,
                                     boolean majorVersion)

Description copied from interface: IContent

Updates existing document object in the repository.

Parameters:

ticket - an authentication ticket

objectId - the identifier for the document to update

object - a CompleteObject obj

newVersion - true to version or overwrite the existing object, otherwise false

majorVersion - true to increment the version to a new major version, otherwise false

Returns:

the object id of the updated or newly-versioned object

See Also:

IContent.updateObject(java.lang.String, java.lang.String, com.tsgrp.opencontent.core.content.model.CompleteObject, boolean, boolean)

updateObjects

public OpenContentObject[] updateObjects(java.lang.String ticket,
                                         OpenContentObject[] ocos)

Description copied from interface: IContent

Updates the objects with the same IDs as provided objects. 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.

ocos - - The objects to update

Returns:

- The updated objects

See Also:

IContent.updateObjects(String, com.tsgrp.opencontent.core.model.json.OpenContentObject[])

getObjectByVersion

public ContentResult getObjectByVersion(java.lang.String ticket,
                                        java.lang.String id,
                                        java.lang.String versionLabel,
                                        java.lang.String[] fileExtensionArr)

Description copied from interface: IContent

Obtain object for a specific version

Parameters:

ticket - String representing the session's ticket

id - id of the object we are trying to get

versionLabel - version of the object we are trying to get

fileExtensionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

Returns:

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

See Also:

IContent.getObjectByVersion(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])

enhancedGetProperties

public ContentResult enhancedGetProperties(java.lang.String ticket,
                                           java.lang.String id)

Description copied from interface: IContent

Returns metadata for the given id only, no content returned.

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get properties from

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object
• objectType - repo specific object type
• props - metadata for object

See Also:

IContent.enhancedGetProperties(java.lang.String, java.lang.String)

removeRelation

public ContentResult removeRelation(java.lang.String ticket,
                                    java.lang.String parentObjectId,
                                    java.lang.String[] childIds,
                                    java.lang.String relationName)

Description copied from interface: IContent

Removes the relationship between the parentId and the childIds passed in of the relation type passed in

Parameters:

ticket - An authentication ticket

parentObjectId - ID of the parent object to remove the rendition relation from

childIds - An array of child IDs to remove from relation

relationName - - name of parent-child relation to remove

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• result set to parentId if the remove succeeded, null if it failed

No content is brought back on the EnhancedCompleteObjects representing our versions

copyDocument

public ContentResult copyDocument(java.lang.String ticket,
                                  java.lang.String id,
                                  java.lang.String copyName)

Description copied from interface: IContent

Returns objectId for the given copied document only, no content returned.

Parameters:

ticket - String representing the session's ticket

id - id of the object we want to make a copy of

copyName - name of the newly copied object. If set to null or "", the name of the new object will be "Copy of ${original object's name}".

Returns:

• ContentResult
• error returns true if get object by version failed, otherwise false
• object contains the newly copied object

lockDocument

public java.lang.String lockDocument(java.lang.String ticket,
                                     java.lang.String objectId)

Description copied from interface: IContent

Locks a document.

Returns:

String

null if the document is already locked.

See Also:

IContent.lockDocument(java.lang.String, java.lang.String)

unlockDocument

public java.lang.String unlockDocument(java.lang.String ticket,
                                       java.lang.String objectId)

Description copied from interface: IContent

Unlocks out a document.

Returns:

String

null if the document is already locked.

See Also:

IContent.unlockDocument(java.lang.String, java.lang.String)

getLockOwner

public UserResult getLockOwner(java.lang.String ticket,
                               java.lang.String objectId)

Description copied from interface: IContent

Returns a UserResult. If the document is locked the UserBean[] will be populated with the UserBean of the locking User, otherwise, the UserBean[] field will be null.

Returns:

UserResult

• UserResult.getError() - True if there is an error
• UserResult.getErrorDetails() - Details about the error
• UserResult.getUserBeans() - If the document is locked, an array of length 1, containing the userbean of the locking user or null of there is no lock.

See Also:

IContent.getLockOwner(java.lang.String, java.lang.String)

doUpdateObject

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

Specified by:

doUpdateObject in class AbstractContentImpl

getObjectByPath

public OpenContentObject getObjectByPath(java.lang.String ticket,
                                         java.lang.String path)

Description copied from interface: IContent

Obtain object by passing its path WARNING: This method opens an InputStream. You must close this in the calling method.

Parameters:

ticket - String representing the session's ticket

path - path to the object to get

Returns:

OpenContentObject

getObjectByPath

public OpenContentObject getObjectByPath(java.lang.String ticket,
                                         java.lang.String path,
                                         boolean quiet)

Description copied from interface: IContent

Obtain object by passing its path This accepts a 'quietMode' parameter that will not throw an error if the object doesn't exist at that path. In certain scenarios, a majority of the time the object won't be there, so we don't want to pollute the logs with stacktraces and/or errors.

Parameters:

ticket - sessions ticket

path - path to the object to het

quiet - If true, we will not throw an error if the object doesn't exist

Returns:

if object exists and the user has access, the OCO will be returned. if not and if quietMode is TRUE, it will return null and if quietMode is FALSE, it will throw an error

checkin

public ContentResult checkin(java.lang.String ticket,
                             java.lang.String objectId,
                             boolean keepLock,
                             java.lang.String versionLabels,
                             java.lang.String comment,
                             boolean majorVersion,
                             OpenContentObject object,
                             boolean newVersion,
                             javax.activation.DataHandler dataHandler)

Description copied from interface: IContent

Checks in a node to the repository. This may fail on implementations that require size (e.g. Dynamo). Use the overloaded checkin for implementations that require size.

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

object - the object to use for setting new property values on checkin - NOTE: this is currently not implemented.

newVersion - whether this should be a new version or the same version.

dataHandler - the data handler containing the input stream for the new content of the checked in object.

Returns:

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

getAppliedAspects

public java.util.List<java.lang.String> getAppliedAspects(java.lang.String ticket,
                                                          java.lang.String objectId)

Description copied from interface: IContent

Retrieves a list of aspects applied to the provided objectId. Note: For obvious reasons, this method will only produce results on an Alfresco backend. For other filesystems, will return an empty list of strings.

Returns:

A list of aspects applied to the given objectId in bean format eg, tsg_rendition

applyAspect

public void applyAspect(java.lang.String ticket,
                        java.lang.String objectId,
                        java.lang.String aspectType,
                        java.util.Map<java.lang.String,java.lang.Object> mandatoryProperties)

Description copied from interface: IContent

Adds an aspect to a document. Note: This will throw an error if called from a non Alfresco backend.

Parameters:

ticket - a valid OC ticket

objectId - the object the aspect will be applied to

aspectType - the type of aspect to be added (in OCName format)

mandatoryProperties - a list of properties that are mandatory for the aspect (in OCName format). Set to null/empty map for no properties

See Also:

IContent.applyAspect(java.lang.String, java.lang.String, java.lang.String, java.util.Map)

moveObject

public void moveObject(java.lang.String ticket,
                       java.lang.String objectId,
                       java.lang.String parentPathOrId)

Description copied from interface: IContent

Moves an object in the repository from one folder to another.

Parameters:

ticket - a valid OC ticket.

objectId - the ID of the object to move to a new folder.

parentPathOrId - the path or ID of the folder to move the new object to.

addSecurityToContentRequest

public void addSecurityToContentRequest(java.lang.String ticket,
                                        java.lang.StringBuffer readQuery)

Abstract method used to append additional security to a query for a specific user retrieved from a ticket number.

Parameters:

ticket - - An authentication ticket.

queryString - - The query to be modified. Expect this query's OC implementation to be complete prior to entering this method.

performContentQuery

protected StringArray[] performContentQuery(java.lang.String ticket,
                                            java.lang.String objectId,
                                            java.lang.String idAttr,
                                            java.lang.String mimeTypeAttr,
                                            java.lang.String contentLocationAttr)

Queries for the necessary attributes need to fetch content for a given object id.

Parameters:

ticket - A valid OC ticket.

objectId - A valid object id for the object we wish to fetch content for.

idAttr - The name of the id attribute in Elasticsearch.

mimeTypeAttr - The name of the mimetype attribute in Elasticsearch

contentLocationAttr - The name of the attribute in Elasticsearch that governs the content's location.

Returns:

A string array of query results.