com.tsgrp.opencontent.solr.extendedcontent

Class SolrExtendedContentImpl

java.lang.Object

com.tsgrp.opencontent.solr.extendedcontent.SolrExtendedContentImpl

All Implemented Interfaces:

IExtendedContent

public class SolrExtendedContentImpl
extends java.lang.Object
implements IExtendedContent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SolrExtendedContentImpl()

Method Summary

Modifier and Type	Method and Description
ExtendedContentResult	addRendition(java.lang.String ticket, java.lang.String objectId, EnhancedObjectContent rendition) Adds a rendition to a document.
void	changeType(java.lang.String ticket, java.lang.String objectId, java.lang.String newType) Changes the type of an object NOTE: May not be able to change type as will.
java.lang.String	copyObject(java.lang.String ticket, java.lang.String objectId, java.lang.String destFolderPath) Copy a given object with specified ID to a specified folder path.
java.lang.String	findCurrentVersionId(java.lang.String ticket, java.lang.String chronId) Given a chronId, find the CURRENT version of the object and return its objectId
java.lang.String	findFirstVersionId(java.lang.String ticket, java.lang.String objectId) Given an objectId, find the first version of the object
java.lang.String	findLatestVersionId(java.lang.String ticket, java.lang.String chronId) Given a chronId, find the LATEST version of the object and return its objectId
java.lang.String	getAcl(java.lang.String ticket, java.lang.String objectId) Return the object ID of the ACL for a given document ID.
java.lang.String	getAclName(java.lang.String ticket, java.lang.String objectId) Return the name of the ACL for a given document ID.
ExtendedContentResult	getAllSubtypes(java.lang.String ticket, java.lang.String parentTypeName) Returns the object type and all of its subtypes within the repository.
ExtendedContentResult	getAllVersions(java.lang.String ticket, java.lang.String objectId) Returns all versions of an object
java.util.Map<java.lang.String,java.lang.String>	getAvailableThumbnails(java.lang.String ticket, java.lang.String objectId, java.lang.String def) Get a list of available thumbnails for a content item (meaning thumbnails that have been generated)
ExtendedContentResult	getChildByName(java.lang.String ticket, java.lang.String parentId, java.lang.String objectName) Returns the child(ren) by the given name of the parent ID.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getChildFolders(java.lang.String ticket, java.lang.String id) Returns all children folders contained in the given object, only returns direct children.
ExtendedContentResult	getChildren(java.lang.String ticket, java.lang.String objectId) Returns all children objects (documents/folders) contained in the given object, only returns direct children.
java.util.List<OpenContentObject>	getChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String[] mimetype) Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.
java.util.List<OpenContentObject>	getChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String[] mimetype, java.lang.Boolean includeRenditionable) Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.
ObjectContentInfo	getContentInfo(java.lang.String ticket, java.lang.String objectId) Returns the ObjectContentInfo object for the given object.
java.lang.String	getContentPath(java.lang.String id, java.lang.String fileExtension) Returns the full filepath of the document's content.
ExtendedContentResult	getObjectPath(java.lang.String ticket, java.lang.String objectId) Returns the path to given objectId
ExtendedContentResult	getParents(java.lang.String ticket, java.lang.String objectId) Returns all the parents of the passed in objectId
ExtendedContentResult	getRelatedChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName) Returns all the children of the passed in objectId with the passed in relation
ExtendedContentResult	getRelatedParents(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName) Returns all the parents of the passed in objectId with the passed in relation
EnhancedObjectContent	getThumbnail(java.lang.String ticket, java.lang.String objectId, java.lang.String thumbnailName) Get a thumbnail of a given object that is represented by a thumbnail name (e.g.
java.lang.String	getUUID(java.lang.String ticket, java.lang.String objectId) Given an object id, return the unique identifier for that object.
boolean	hasRelations(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName, boolean parent) Returns true if an object with objectId has either a parent or child relationship of relationName.
boolean	isContainer(java.lang.String ticket, java.lang.String objectId) Return whether or not the object related to the ticket is a container or not
ExtendedContentResult	removeRendition(java.lang.String ticket, java.lang.String objectId, java.lang.String mimeType) Remove a rendition of a document.
java.lang.String	resolveVersion(java.lang.String ticket, java.lang.String objectId, java.lang.String label) Given an objectId (not necessarily the version we are looking for) find the version of the document that is labeled with the label that is passed in.
boolean	setAcl(java.lang.String ticket, java.lang.String aclId, java.lang.String objectId) Set the ACL for a given document.

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrExtendedContentImpl

protected SolrExtendedContentImpl()

Method Detail

copyObject

public java.lang.String copyObject(java.lang.String ticket,
                                   java.lang.String objectId,
                                   java.lang.String destFolderPath)

Description copied from interface: IExtendedContent

Copy a given object with specified ID to a specified folder path.

Specified by:

copyObject in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - the object ID to create a copy of

destFolderPath - location to copy the object to

Returns:

the object ID of the newly created object, or null on failure

See Also:

IExtendedContent.copyObject(java.lang.String, java.lang.String, java.lang.String)

getContentInfo

public ObjectContentInfo getContentInfo(java.lang.String ticket,
                                        java.lang.String objectId)

Description copied from interface: IExtendedContent

Returns the ObjectContentInfo object for the given object. NOTE: This method will not return any content, only info on the formats. Thumbnail content will NOT be returned. Only content formats that are known in the mimeType-extension map will be returned. If the object has more than one format, index 0 on the lists on the ObjectContentInfo will be the native content property, while the 2nd-N items will contain renditions.

Specified by:

getContentInfo in interface IExtendedContent

Parameters:

ticket - Authentication ticket

objectId - Object Id of the object whose content info is to be retrieved

Returns:

a ObjectContentInfo object with info on the known formats of the object

See Also:

Getting content size has not been implemented for Solr

getAcl

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

Description copied from interface: IExtendedContent

Return the object ID of the ACL for a given document ID.

Specified by:

getAcl in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the object ID of the ACL attached to the specified document

See Also:

IExtendedContent.getAcl(java.lang.String, java.lang.String)

getAclName

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

Description copied from interface: IExtendedContent

Return the name of the ACL for a given document ID.

Specified by:

getAclName in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the name of the ACL attached to the specified document

See Also:

IExtendedContent.getAclName(java.lang.String, java.lang.String)

setAcl

public boolean setAcl(java.lang.String ticket,
                      java.lang.String aclId,
                      java.lang.String objectId)

Description copied from interface: IExtendedContent

Set the ACL for a given document.

Specified by:

setAcl in interface IExtendedContent

Parameters:

ticket - an authentication ticket

aclId - the object ID of the ACL to apply to the document

objectId - the object ID of the document to apply the ACL to

Returns:

whether the ACL setting was successful

See Also:

IExtendedContent.setAcl(java.lang.String, java.lang.String, java.lang.String)

getChildren

public ExtendedContentResult getChildren(java.lang.String ticket,
                                         java.lang.String objectId)

Description copied from interface: IExtendedContent

Returns all children objects (documents/folders) contained in the given object, only returns direct children.

Specified by:

getChildren in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

See Also:

IExtendedContent.getChildren(java.lang.String, java.lang.String)

getChildFolders

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getChildFolders(java.lang.String ticket,
                                                                                        java.lang.String id)

Description copied from interface: IExtendedContent

Returns all children folders contained in the given object, only returns direct children.

Specified by:

getChildFolders in interface IExtendedContent

Returns:

list of child folders containing only the folder Id and folder name (map keys: objectId, objectName)

See Also:

IExtendedContent.getChildFolders(java.lang.String, java.lang.String)

getAllVersions

public ExtendedContentResult getAllVersions(java.lang.String ticket,
                                            java.lang.String objectId)

Description copied from interface: IExtendedContent

Returns all versions of an object

Specified by:

getAllVersions in interface IExtendedContent

Returns:

in order from most recent to oldest. ExtendedContentResult.objects[0] is current version

• ExtendedContentResult
• objects - one object for each version
• objectType - repo specific object type
• props - metadata for object

No content is brought back on the EnhancedCompleteObjects representing our versions

See Also:

No content is brought back on the EnhancedCompleteObjects representing our versions

addRendition

public ExtendedContentResult addRendition(java.lang.String ticket,
                                          java.lang.String objectId,
                                          EnhancedObjectContent rendition)

Description copied from interface: IExtendedContent

Adds a rendition to a document. The rendition. This method will delete renditions that already exist of the same mimeType as the new rendition being created. It then will create and add the new rendition.

Specified by:

addRendition in interface IExtendedContent

rendition - the content and the mimetype of the rendition

Returns:

• ExtendedContentResult
• boolean Error, true if addRendition failed, false if successful

getParents

public ExtendedContentResult getParents(java.lang.String ticket,
                                        java.lang.String objectId)

Description copied from interface: IExtendedContent

Returns all the parents of the passed in objectId

Specified by:

getParents in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each parent
• objectType - repo specific object type
• props - metadata for object

getAllSubtypes

public ExtendedContentResult getAllSubtypes(java.lang.String ticket,
                                            java.lang.String parentTypeName)

Description copied from interface: IExtendedContent

Returns the object type and all of its subtypes within the repository. NOTE: The type passed in is INCLUDED in the return objects.

Specified by:

getAllSubtypes in interface IExtendedContent

Parameters:

ticket - Authentication ticket

parentTypeName - name of the parent type

Returns:

• ExtendedContentResult
• objects - one object for object type
• objectType - repo specific object type

No content is brought back on the EnhancedCompleteObjects representing our versions

See Also:

IExtendedContent.getAllSubtypes(java.lang.String, java.lang.String)

getRelatedParents

public ExtendedContentResult getRelatedParents(java.lang.String ticket,
                                               java.lang.String objectId,
                                               java.lang.String relationName)

Description copied from interface: IExtendedContent

Returns all the parents of the passed in objectId with the passed in relation

Specified by:

getRelatedParents in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each parent
• objectType - repo specific object type
• props - metadata for object

getRelatedChildren

public ExtendedContentResult getRelatedChildren(java.lang.String ticket,
                                                java.lang.String objectId,
                                                java.lang.String relationName)

Description copied from interface: IExtendedContent

Returns all the children of the passed in objectId with the passed in relation

Specified by:

getRelatedChildren in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each child (NOTE: the content of each child should NOT be populated)
• objectType - repo specific object type
• props - metadata for object

getObjectPath

public ExtendedContentResult getObjectPath(java.lang.String ticket,
                                           java.lang.String objectId)

Description copied from interface: IExtendedContent

Returns the path to given objectId

Specified by:

getObjectPath in interface IExtendedContent

Parameters:

ticket - - session ticket

objectId - - objectId of a document or folder. (DCTM implementation doesn't support documents and will throw an error)

Returns:

the full path including the folder name, of the passed in objectId. ex. "/Wizard/Wizard/myPSIFolder" when given a folderId or "/Wizard/Wizard/myPSIFolder/mypsi.xml" when given a documentId (documents are only supported in Alfresco)

• ExtendedContentResult
• stringResult - repository folder path to the given object

See Also:

IExtendedContent.getObjectPath(java.lang.String, java.lang.String)

removeRendition

public ExtendedContentResult removeRendition(java.lang.String ticket,
                                             java.lang.String objectId,
                                             java.lang.String mimeType)

Description copied from interface: IExtendedContent

Remove a rendition of a document. Returns the stringResult attribute populated with the mimeType if the rendition was successfully removed. Returns a blank stringResult if the rendition was not removed.

Specified by:

removeRendition in interface IExtendedContent

Returns:

• ExtendedContentResult
• stringResult - mimeType of the rendition that was sucessfully removed

getAvailableThumbnails

public java.util.Map<java.lang.String,java.lang.String> getAvailableThumbnails(java.lang.String ticket,
                                                                               java.lang.String objectId,
                                                                               java.lang.String def)

Description copied from interface: IExtendedContent

Get a list of available thumbnails for a content item (meaning thumbnails that have been generated)

Specified by:

getAvailableThumbnails in interface IExtendedContent

Returns:

• List - Map of available Types

getThumbnail

public EnhancedObjectContent getThumbnail(java.lang.String ticket,
                                          java.lang.String objectId,
                                          java.lang.String thumbnailName)

Description copied from interface: IExtendedContent

Get a thumbnail of a given object that is represented by a thumbnail name (e.g. 'doclib-small')

Specified by:

getThumbnail in interface IExtendedContent

Returns:

• Byte[] - Byte Array containing the streamed content of the thumbnail image

See Also:

IExtendedContent.getThumbnail(String ticket, String objectId, String thumbnailName)

resolveVersion

public java.lang.String resolveVersion(java.lang.String ticket,
                                       java.lang.String objectId,
                                       java.lang.String label)

Description copied from interface: IExtendedContent

Given an objectId (not necessarily the version we are looking for) find the version of the document that is labeled with the label that is passed in. Implementations will find the given version and return the id of the document that fits the criteria passed in. If the label criteria matches more than one version in the tree, the impl should return the one that was most recently modified.

Specified by:

resolveVersion in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - any objectId of a document tree to search for a version for

label - the "version label" of the document to search the tree for and return

Returns:

the object ID of the object that matches the given label (blank if no id with criteria is found)

findFirstVersionId

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

Description copied from interface: IExtendedContent

Given an objectId, find the first version of the object

Specified by:

findFirstVersionId in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - any objectId of a document tree to search for the first version for

Returns:

the first version of the object specified by the objectId parameter, or null if the no objects with the given ID exist

findCurrentVersionId

public java.lang.String findCurrentVersionId(java.lang.String ticket,
                                             java.lang.String chronId)

Description copied from interface: IExtendedContent

Given a chronId, find the CURRENT version of the object and return its objectId

Specified by:

findCurrentVersionId in interface IExtendedContent

Parameters:

ticket - an authentication ticket

chronId - any chronId of a document tree to search for the first version for

Returns:

the objectId of the CURRENT version of the doc specified by the chronId parameter

getChildByName

public ExtendedContentResult getChildByName(java.lang.String ticket,
                                            java.lang.String parentId,
                                            java.lang.String objectName)

Description copied from interface: IExtendedContent

Returns the child(ren) by the given name of the parent ID. If a child or children are found, one EnhancedCompleteObject will be returned for each result, with the OBJECT ID AS THE ONLY PROPERTY. If no child is found, an empty objects array is returned.

Specified by:

getChildByName in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each child (NOTE: the content of each child should NOT be populated)
• props - metadata for object

findLatestVersionId

public java.lang.String findLatestVersionId(java.lang.String ticket,
                                            java.lang.String chronId)

Description copied from interface: IExtendedContent

Given a chronId, find the LATEST version of the object and return its objectId

Specified by:

findLatestVersionId in interface IExtendedContent

Parameters:

ticket - an authentication ticket

chronId - any chronId of a document tree to search for the first version for

Returns:

the objectId of the LATEST version of the doc specified by the chronId parameter

hasRelations

public boolean hasRelations(java.lang.String ticket,
                            java.lang.String objectId,
                            java.lang.String relationName,
                            boolean parent)

Description copied from interface: IExtendedContent

Returns true if an object with objectId has either a parent or child relationship of relationName. Returns false otherwise.

Specified by:

hasRelations in interface IExtendedContent

Parameters:

ticket - String of the authentication ticket

objectId - String to represent node's objectId

relationName - String of the relation to find

parent - boolean - if set to true, find parent relationship, else find child relationship

Returns:

True if relationship exists, false otherwise

getUUID

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

Description copied from interface: IExtendedContent

Given an object id, return the unique identifier for that object. In most cases, this will just return the objectId. For some impls (read: alfresco), this will strip off unnecessary characters from the objectId.

Specified by:

getUUID in interface IExtendedContent

Returns:

a String representing the unique identifier for a repo object

isContainer

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

Description copied from interface: IExtendedContent

Return whether or not the object related to the ticket is a container or not

Specified by:

isContainer in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the object ID of the ACL attached to the specified document

getChildren

public java.util.List<OpenContentObject> getChildren(java.lang.String ticket,
                                                     java.lang.String objectId,
                                                     java.lang.String[] mimetype)

Description copied from interface: IExtendedContent

Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied. IExtendedContent.getChildren(String, String, String[], Boolean) is called and defaults includeRenditionable to false.

Specified by:

getChildren in interface IExtendedContent

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

getChildren

public java.util.List<OpenContentObject> getChildren(java.lang.String ticket,
                                                     java.lang.String objectId,
                                                     java.lang.String[] mimetype,
                                                     java.lang.Boolean includeRenditionable)

Description copied from interface: IExtendedContent

Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.

Specified by:

getChildren in interface IExtendedContent

includeRenditionable - optional parameter to allow documents which don't but can match filters

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

changeType

public void changeType(java.lang.String ticket,
                       java.lang.String objectId,
                       java.lang.String newType)

Description copied from interface: IExtendedContent

Changes the type of an object NOTE: May not be able to change type as will. Depends on how type hierarchy works for the specific Impl

Specified by:

changeType in interface IExtendedContent

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to change type for

newType - the OCName of the target type

getContentPath

public java.lang.String getContentPath(java.lang.String id,
                                       java.lang.String fileExtension)

Description copied from interface: IExtendedContent

Returns the full filepath of the document's content. Note this is not supported in some implementations. e.g. store://2018/12/12/12/45/b2107d51-6bb3-485c-9874-e700192d38e5.bin ==> 2018/12/12/12/45/b2107d51-6bb3-485c-9874-e700192d38e5.bin

Specified by:

getContentPath in interface IExtendedContent