sapphire.attachment

Class BaseAttachmentRepository

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.attachment.BaseAttachmentRepository

public abstract class BaseAttachmentRepository
extends com.labvantage.sapphire.BaseCustom

Base Class for Attachment Repositories Extend this class and implement the abstract methods to create a custom Attachment repository. You would then need to register the repository in the Attachment Repositories Property Tree.

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseAttachmentRepository()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canBrowseRepository() Override and return true if the repository can browse a repository (default false) It is recomended to only enable this if an unmanaged repository.
abstract boolean	canCompress() Override and return true if the repository does not require local compression (as it does its own) or false if the system controls compression (default false)
abstract boolean	canEncrypt() Override and return true if the repository does not require local encrypting (as it does its own) or false if the system controls encrytion (default false)
abstract boolean	canGenerateThumbnail() Override and return true if the repository does its own thumbnail generation (default false)
abstract boolean	canHash() Override and return true if the repository does not require local hashing (as it does its own) or false if the system controls hashing (default false)
abstract boolean	checkHash(Attachment attachment) Override and add any hashing logic for validating the attachment.
abstract void	cleanUpRepository(Attachment oldAttachment) Override and implement this method to handle the deletion of the sdi attachment record.
abstract boolean	enableCaching() Override and return true if the repository does not require local caching or false if the system controls caching (default false)
PropertyList	getAttachmentPolicy() Returns the attachment policy property list
abstract java.lang.String	getBrowseButtonText() Returns the text for support of the browse button.
abstract java.lang.String[]	getBrowseIncludes() Returns the array of script includes for support of the browse button.
abstract java.lang.String	getBrowseScript(java.lang.String attachmentElementId) Returns the script for support of the browse button.
java.lang.ClassLoader	getClassLoader()
java.io.InputStream	getDirectInputStream(PropertyList propertyList) Overridable method to return inputstream directly
static java.io.InputStream	getDirectInputStream(java.lang.String repositoryId, java.lang.String repositoryNodeId, PropertyList props, com.labvantage.sapphire.services.SapphireConnection sapphireConnection)
java.lang.String	getFileViewerHTML(java.lang.String fileViewerId, PropertyList propertyList, PageContext pageContext) Overridable method to return fileviewerhtml directly
static java.lang.String	getFileViewerHTML(java.lang.String repositoryId, java.lang.String repositoryNodeId, java.lang.String fileViewerId, PropertyList propertyList, PageContext pageContext, com.labvantage.sapphire.services.SapphireConnection sapphireConnection)
static BaseAttachmentRepository	getRepository(java.lang.String filerepositoryid, java.lang.String filerepositorynode, com.labvantage.sapphire.services.SapphireConnection conn) Will return an Attachment Repository object based on the repository property tree id and node.
PropertyList	getRepositoryProperties() Returns the list of properties for the repository
protected com.labvantage.sapphire.services.SapphireConnection	getSapphireConnection() Returns the sapphire connection object
abstract void	getSDIAttachment(Attachment attachment, Attachment.ThumbnailGeneration thumbnailGeneration) Override and implement this method to handle the getting of the sdi attachment record.
protected DataSet	getUniqueFilesInAudit(Attachment oldAttachment) Will return a dataset of audit records where the files are not in any other audit record or in the sdiattachment table.
boolean	isCleanUpRepositoryEnabled() Returns true if clean up repository is enabled and false if not
protected boolean	isFilePresentInOtherAttachments(Attachment oldAttachment, boolean postDelete) Will return true if the repository reference is found on another attachment record or inside the audit table
protected boolean	isFilePresentInOtherAttachments(Attachment oldAttachment, boolean postDelete, boolean checkAudit) Will return true if the repository reference is found on another attachment record or inside the audit table
boolean	isManaged() Returns true if this is a managed repository and false if not It is recommended to use managed repositories where possible as they are more secure and robust.
abstract void	postAddSDIAttachment(Attachment attachment) Override and implement this method to handle the addition of the sdi attachment record.
abstract void	postDeleteSDIAttachment(Attachment oldAttachment) Override and implement this method to handle the deletion of the sdi attachment record.
abstract void	postEditSDIAttachment(Attachment attachment, Attachment oldAttachment) Override and implement this method to handle the update of the sdi attachment record.
abstract void	preAddSDIAttachment(Attachment attachment) Override and implement this method to handle the addition of the sdi attachment record.
abstract void	preDeleteSDIAttachment(Attachment attachment) Override and implement this method to handle the deletion of the sdi attachment record.
abstract boolean	preEditSDIAttachment(Attachment attachment, Attachment oldAttachment) Override and implement this method to handle the update of the sdi attachment record.
protected void	setAttachmentPolicy(PropertyList attachmentPolicy)
protected void	setClassLoader(java.lang.ClassLoader classLoader)
protected void	setCleanUpRepository(boolean enableCleanUpRepository)
protected void	setManaged(boolean managed)
protected void	setRepositoryProperties(PropertyList repositoryProperties)
protected void	setSapphireConnection(com.labvantage.sapphire.services.SapphireConnection sapphireConnection) Sets a sapphire connection
protected void	transferData(java.io.InputStream inputStream, java.io.File output, boolean closeInput, boolean closeOutput)
protected void	transferData(java.io.InputStream inputStream, java.io.OutputStream outputStream, boolean closeInput, boolean closeOutput)

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAttachmentRepository

public BaseAttachmentRepository()

Method Detail

setClassLoader

protected void setClassLoader(java.lang.ClassLoader classLoader)

getClassLoader

public java.lang.ClassLoader getClassLoader()

getRepository

public static BaseAttachmentRepository getRepository(java.lang.String filerepositoryid,
                                                     java.lang.String filerepositorynode,
                                                     com.labvantage.sapphire.services.SapphireConnection conn)
                                              throws SapphireException

Will return an Attachment Repository object based on the repository property tree id and node.

Parameters:

filerepositoryid - The property tree id of the repository

filerepositorynode - The node in the property tree of the repository

conn - The sapphire connection

Returns:

Returns the BaseAttachmentRepository instance

Throws:

SapphireException

setSapphireConnection

protected void setSapphireConnection(com.labvantage.sapphire.services.SapphireConnection sapphireConnection)

Sets a sapphire connection

Parameters:

sapphireConnection - The sapphire connection object

setCleanUpRepository

protected void setCleanUpRepository(boolean enableCleanUpRepository)

setManaged

protected void setManaged(boolean managed)

setAttachmentPolicy

protected void setAttachmentPolicy(PropertyList attachmentPolicy)

setRepositoryProperties

protected void setRepositoryProperties(PropertyList repositoryProperties)

getSapphireConnection

protected com.labvantage.sapphire.services.SapphireConnection getSapphireConnection()

Returns the sapphire connection object

Returns:

The sapphire connection

isManaged

public boolean isManaged()

Returns true if this is a managed repository and false if not It is recommended to use managed repositories where possible as they are more secure and robust.

Returns:

True or false

isCleanUpRepositoryEnabled

public boolean isCleanUpRepositoryEnabled()

Returns true if clean up repository is enabled and false if not

Returns:

True or false

getAttachmentPolicy

public PropertyList getAttachmentPolicy()

Returns the attachment policy property list

Returns:

The property list for the attachment policy

getRepositoryProperties

public PropertyList getRepositoryProperties()

Returns the list of properties for the repository

Returns:

The property list of repository values

checkHash

public abstract boolean checkHash(Attachment attachment)

Override and add any hashing logic for validating the attachment. This will only be executed if the canHash returned true. Return true if the hash is valid. This may be done at the writing data to repository and so the default is to return true so this check is skipped and you can check downstrea

Returns:

True or false

canGenerateThumbnail

public abstract boolean canGenerateThumbnail()

Override and return true if the repository does its own thumbnail generation (default false)

Returns:

True or false

canBrowseRepository

public abstract boolean canBrowseRepository()

Override and return true if the repository can browse a repository (default false) It is recomended to only enable this if an unmanaged repository. You can also then return the browsing script in another method.

Returns:

True or false

getBrowseIncludes

public abstract java.lang.String[] getBrowseIncludes()

Returns the array of script includes for support of the browse button. The default is to return null. Note that these includes are included by the attachment element to show the browse repository button. This is only used if the canBrowseRepository return true.

Returns:

The string array of script includes.

getBrowseScript

public abstract java.lang.String getBrowseScript(java.lang.String attachmentElementId)

Returns the script for support of the browse button. The default is to return empty string. Note that this script is included by the attachment element to show the browse repository button. This is only used if the canBrowseRepository return true.

Parameters:

attachmentElementId - The element id of the attachment element

Returns:

The script for the browse button

getBrowseButtonText

public abstract java.lang.String getBrowseButtonText()

Returns the text for support of the browse button. The default is to return empty string. Note that this text is included by the attachment element to show the browse repository button. This is only used if the canBrowseRepository return true.

Returns:

The text for the browse button

enableCaching

public abstract boolean enableCaching()

Override and return true if the repository does not require local caching or false if the system controls caching (default false)

Returns:

True or false

canEncrypt

public abstract boolean canEncrypt()

Override and return true if the repository does not require local encrypting (as it does its own) or false if the system controls encrytion (default false)

Returns:

True or false

canCompress

public abstract boolean canCompress()

Override and return true if the repository does not require local compression (as it does its own) or false if the system controls compression (default false)

Returns:

True or false

canHash

public abstract boolean canHash()

Override and return true if the repository does not require local hashing (as it does its own) or false if the system controls hashing (default false)

Returns:

True or false

getSDIAttachment

public abstract void getSDIAttachment(Attachment attachment,
                                      Attachment.ThumbnailGeneration thumbnailGeneration)
                               throws SapphireException

Override and implement this method to handle the getting of the sdi attachment record. In the method you should read the data from the respository and set the input stream of the attachment object The incoming attachment will have a repository id property which is the external id for the repository

Parameters:

attachment - The attachment object we are working on

thumbnailGeneration - The thumbnail rules as to generate the thumbnail or not. You can chose to return the external thumbnail or allow the system to generate one.

Throws:

SapphireException

preAddSDIAttachment

public abstract void preAddSDIAttachment(Attachment attachment)
                                  throws SapphireException

Override and implement this method to handle the addition of the sdi attachment record. This method is called prior to the insert of the sdiattachment record so is the time to update any sdi attachment variables and set the external repository id (the repository id). The inputstream on the incoming attachment will create the file data.

Parameters:

attachment - The attachment object we are working on

Throws:

SapphireException

postAddSDIAttachment

public abstract void postAddSDIAttachment(Attachment attachment)
                                   throws SapphireException

Override and implement this method to handle the addition of the sdi attachment record. This method is called after to the insert of the sdiattachment record so is the time to update any repository information or clean up any temporary data. The inputstream on the incoming attachment will create the file data.

Parameters:

attachment - The attachment object we are working on

Throws:

SapphireException

preEditSDIAttachment

public abstract boolean preEditSDIAttachment(Attachment attachment,
                                             Attachment oldAttachment)
                                      throws SapphireException

Override and implement this method to handle the update of the sdi attachment record. This method is called prior to the update of the sdiattachment record so is the time to update any sdi attachment variables and set the external repository id (the repository id). The inputstream on the incoming attachment will create the file data.

Parameters:

attachment - The attachment object we are working on

Throws:

SapphireException

postEditSDIAttachment

public abstract void postEditSDIAttachment(Attachment attachment,
                                           Attachment oldAttachment)
                                    throws SapphireException

Override and implement this method to handle the update of the sdi attachment record. This method is called after to the update of the sdiattachment record so is the time to update any repository information or clean up any temporary data. The inputstream on the incoming attachment will create the file data.

Parameters:

attachment - The attachment object we are working on

oldAttachment - The attachment object representing the state before the update

Throws:

SapphireException

preDeleteSDIAttachment

public abstract void preDeleteSDIAttachment(Attachment attachment)
                                     throws SapphireException

Override and implement this method to handle the deletion of the sdi attachment record. This method is called prior to the delete of the sdiattachment record so is the time to validation the deletion and update any repository settings.

Parameters:

attachment - The attachment object we are working on

Throws:

SapphireException

postDeleteSDIAttachment

public abstract void postDeleteSDIAttachment(Attachment oldAttachment)
                                      throws SapphireException

Override and implement this method to handle the deletion of the sdi attachment record. This method is called after the delete of the sdiattachment record so is the time to update any repository settings.

Parameters:

oldAttachment - The attachment object as it was before deletion

Throws:

SapphireException

cleanUpRepository

public abstract void cleanUpRepository(Attachment oldAttachment)
                                throws SapphireException

Override and implement this method to handle the deletion of the sdi attachment record.

Parameters:

oldAttachment - The attachment object as it was before deletion

Throws:

SapphireException

isFilePresentInOtherAttachments

protected boolean isFilePresentInOtherAttachments(Attachment oldAttachment,
                                                  boolean postDelete)

Will return true if the repository reference is found on another attachment record or inside the audit table

Parameters:

oldAttachment -

postDelete -

Returns:

isFilePresentInOtherAttachments

protected boolean isFilePresentInOtherAttachments(Attachment oldAttachment,
                                                  boolean postDelete,
                                                  boolean checkAudit)

Will return true if the repository reference is found on another attachment record or inside the audit table

Parameters:

oldAttachment -

postDelete -

checkAudit -

Returns:

getUniqueFilesInAudit

protected DataSet getUniqueFilesInAudit(Attachment oldAttachment)

Will return a dataset of audit records where the files are not in any other audit record or in the sdiattachment table. This is used prior to a delete to validate if any audit files need deleting.

Returns:

DataSet of audit records

transferData

protected void transferData(java.io.InputStream inputStream,
                            java.io.File output,
                            boolean closeInput,
                            boolean closeOutput)
                     throws SapphireException

Throws:

SapphireException

transferData

protected void transferData(java.io.InputStream inputStream,
                            java.io.OutputStream outputStream,
                            boolean closeInput,
                            boolean closeOutput)
                     throws SapphireException

Throws:

SapphireException

getDirectInputStream

public java.io.InputStream getDirectInputStream(PropertyList propertyList)
                                         throws SapphireException

Overridable method to return inputstream directly

Parameters:

propertyList -

Returns:

Throws:

SapphireException

getFileViewerHTML

public java.lang.String getFileViewerHTML(java.lang.String fileViewerId,
                                          PropertyList propertyList,
                                          PageContext pageContext)
                                   throws SapphireException

Overridable method to return fileviewerhtml directly

Parameters:

propertyList -

Returns:

Throws:

SapphireException

getFileViewerHTML

public static java.lang.String getFileViewerHTML(java.lang.String repositoryId,
                                                 java.lang.String repositoryNodeId,
                                                 java.lang.String fileViewerId,
                                                 PropertyList propertyList,
                                                 PageContext pageContext,
                                                 com.labvantage.sapphire.services.SapphireConnection sapphireConnection)
                                          throws SapphireException

Throws:

SapphireException

getDirectInputStream

public static java.io.InputStream getDirectInputStream(java.lang.String repositoryId,
                                                       java.lang.String repositoryNodeId,
                                                       PropertyList props,
                                                       com.labvantage.sapphire.services.SapphireConnection sapphireConnection)
                                                throws SapphireException

Throws:

SapphireException