sapphire.accessor

Class AttachmentProcessor

java.lang.Object

com.labvantage.sapphire.BaseClass

com.labvantage.sapphire.BaseAccessor

sapphire.accessor.AttachmentProcessor

public class AttachmentProcessor
extends com.labvantage.sapphire.BaseAccessor

Support attachment and related function AttachmentProcessor.java

Created on April 2, 2003, 9:40 AM

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseAccessor

jndiPrefix, local, localJNDIPrefix, remoteAccessKey

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
AttachmentProcessor(java.io.File rakFile, java.lang.String connectionid) Constructor for a client application with an existing connection
AttachmentProcessor(javax.servlet.jsp.PageContext pageContext) Constructor for a client web application with a page Context and existing connectionid
AttachmentProcessor(java.lang.String connectionid) Constructor for creating an accessor from components
AttachmentProcessor(java.lang.String nameserverlist, java.lang.String connectionid) Deprecated.

Method Summary

Modifier and Type	Method and Description
sapphire.attachment.Attachment	addSDIAttachment(sapphire.attachment.Attachment attachment) Method for adding an attachment to an SDI from an Attachment object
sapphire.attachment.Attachment	addSDIAttachment(sapphire.attachment.Attachment attachment, boolean applyLock, boolean index, java.lang.String attachmentPolicyNode) Method for adding an attachment to an SDI from an Attachment object
int	addSDIAttachment(java.util.HashMap properties, byte[] data) Method for adding an attachment to an SDI from an byte Array.
int	addSDIAttachment(java.util.HashMap properties, java.io.InputStream data) Method for adding an attachment to an SDI from an input stream
int	deleteSDIAttachment(sapphire.attachment.Attachment attachment) Method for deleting an sdi attachment record.
int	deleteSDIAttachment(sapphire.attachment.Attachment attachment, boolean applyLock, java.lang.String attachmentPolicyNode) Method for deleting an sdi attachment record.
sapphire.attachment.Attachment	editSDIAttachment(sapphire.attachment.Attachment attachment) Method for updating an attachment to an SDI from an Attachment object
sapphire.attachment.Attachment	editSDIAttachment(sapphire.attachment.Attachment attachment, boolean applyLock, boolean index, java.lang.String attachmentPolicyNode) Method for updating an attachment to an SDI from an Attachment object
int	editSDIAttachment(java.util.HashMap properties, byte[] data) Method for updating an attachment to an SDI from an byte Array Please note it is recommended to avoid using byte arrays and instead use the inputstream or attachment object methods which are more efficient on memory.
int	editSDIAttachment(java.util.HashMap properties, java.io.InputStream data) Method for adding an attachment to an SDI from an input stream
sapphire.attachment.Attachment	getSDIAttachment(sapphire.attachment.Attachment attachment, sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration) Get an attachment record in the form of an Attachment object
sapphire.attachment.Attachment	getSDIAttachment(sapphire.attachment.Attachment attachment, int auditLog, sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration) Get an attachment record in the form of an Attachment object from the sdiattachment audit table
sapphire.attachment.Attachment	getTempAttachment(sapphire.attachment.Attachment attachment, sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration) Get an attachment record in the form of an Attachment object to represent the temporary attachment

Methods inherited from class com.labvantage.sapphire.BaseAccessor

createRemoteAccessKey, getAttachmentManager, getAutomationManager, getConfigurationManager, getConnectionid, getErrorCodeList, getErrorCodeStack, getErrorHandler, getErrorStack, getErrorStack, getErrorString, getInfoErrorString, getLastError, getLastErrorCode, getLastErrorMessage, getLastException, getLocalAccessManager, getNameserverlist, getQueryManager, getRemoteAccessManager, getRequestManager, getStatusManager, getWebAdminManager, hasErrors, hasInfoErrors, parseServiceExceptionMsg, resetConnectionid, resetErrorStack, setConnectionDetails, setConnectionid, setError, setError, setErrorString, setInfoErrorString, setJNDIPrefix, setLocal, setLocalJNDIPrefix, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentProcessor

public AttachmentProcessor(java.lang.String connectionid)

Constructor for creating an accessor from components

Parameters:

connectionid - The connection to use for component calls

AttachmentProcessor

public AttachmentProcessor(java.lang.String nameserverlist,
                           java.lang.String connectionid)

Deprecated.

Constructor for a client application with an existing connection

Parameters:

nameserverlist - list of the application sever names

connectionid - A valid connectionid

AttachmentProcessor

public AttachmentProcessor(java.io.File rakFile,
                           java.lang.String connectionid)

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

connectionid - A valid connectionid

AttachmentProcessor

public AttachmentProcessor(javax.servlet.jsp.PageContext pageContext)

Constructor for a client web application with a page Context and existing connectionid

Parameters:

pageContext - The current page context

Method Detail

getSDIAttachment

public sapphire.attachment.Attachment getSDIAttachment(sapphire.attachment.Attachment attachment,
                                                       sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration)

Get an attachment record in the form of an Attachment object

Parameters:

attachment - The preloaded attachment object with sdcid, keyid1,2,3 and attachmentnum/attachmentclass set.

thumbnailGeneration - The Thumbnail Generation enumeration setting

Returns:

Returns a new Attachment object which is a representation of the sdiattachment record with all the storage repository information and binary data

getSDIAttachment

public sapphire.attachment.Attachment getSDIAttachment(sapphire.attachment.Attachment attachment,
                                                       int auditLog,
                                                       sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration)

Get an attachment record in the form of an Attachment object from the sdiattachment audit table

Parameters:

attachment - The preloaded attachment object with sdcid, keyid1,2,3 and attachmentnum/attachmentclass set.

auditLog - The audit log id so that the attachment can be fetched from the audit table

thumbnailGeneration - The Thumbnail Generation enumeration setting

Returns:

Returns a new Attachment object which is a representation of the sdiattachment record with all the storage repository information and binary data

getTempAttachment

public sapphire.attachment.Attachment getTempAttachment(sapphire.attachment.Attachment attachment,
                                                        sapphire.attachment.Attachment.ThumbnailGeneration thumbnailGeneration)

Get an attachment record in the form of an Attachment object to represent the temporary attachment

Parameters:

attachment - The preloaded attachment object with sdcid, keyid1,2,3 and attachmentnum/attachmentclass set.

thumbnailGeneration - The Thumbnail Generation enumeration setting

Returns:

Returns a new Attachment object which is a representation of the sditemp record with all the storage repository information and binary data

deleteSDIAttachment

public int deleteSDIAttachment(sapphire.attachment.Attachment attachment)

Method for deleting an sdi attachment record.

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1 and attachmentnum

Returns:

Returns Successfule or failure integer

deleteSDIAttachment

public int deleteSDIAttachment(sapphire.attachment.Attachment attachment,
                               boolean applyLock,
                               java.lang.String attachmentPolicyNode)

Method for deleting an sdi attachment record.

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1 and attachmentnum

applyLock - Set to true to apply locking to the primary while deleting the attachment

attachmentPolicyNode - The attachment policy node where the rules and settings are found

Returns:

Returns Successfule or failure integer

addSDIAttachment

public sapphire.attachment.Attachment addSDIAttachment(sapphire.attachment.Attachment attachment)

Method for adding an attachment to an SDI from an Attachment object

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1, attachmentnum and the file or data

Returns:

Returns the added attachment with all data populated including repository and storage information

addSDIAttachment

public sapphire.attachment.Attachment addSDIAttachment(sapphire.attachment.Attachment attachment,
                                                       boolean applyLock,
                                                       boolean index,
                                                       java.lang.String attachmentPolicyNode)

Method for adding an attachment to an SDI from an Attachment object

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1, attachmentnum and the file or data

applyLock - Set to true to apply locking to the primary while deleting the attachment

attachmentPolicyNode - The attachment policy node where the rules and settings are found

Returns:

Returns the added attachment with all data populated including repository and storage information

addSDIAttachment

public int addSDIAttachment(java.util.HashMap properties,
                            java.io.InputStream data)

Method for adding an attachment to an SDI from an input stream

Parameters:

properties - Hashmap of attachment properties for the addition

data - The input stream for the data

Returns:

Returns successful or failure integer

addSDIAttachment

public int addSDIAttachment(java.util.HashMap properties,
                            byte[] data)

Method for adding an attachment to an SDI from an byte Array. Please note it is recommended to avoid using byte arrays and instead use the inputstream or attachment object methods which are more efficient on memory.

Parameters:

properties - Hashmap of attachment properties for the addition

data - The file data in a byte array

Returns:

Returns successful or failure integer

editSDIAttachment

public sapphire.attachment.Attachment editSDIAttachment(sapphire.attachment.Attachment attachment)

Method for updating an attachment to an SDI from an Attachment object

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1, attachmentnum and the file or data

Returns:

Returns the added attachment with all data populated including repository and storage information

editSDIAttachment

public sapphire.attachment.Attachment editSDIAttachment(sapphire.attachment.Attachment attachment,
                                                        boolean applyLock,
                                                        boolean index,
                                                        java.lang.String attachmentPolicyNode)

Method for updating an attachment to an SDI from an Attachment object

Parameters:

attachment - The attachment object representing the attachment row which at a minimum needs sdcid, keyid1, attachmentnum and the file or data

applyLock - Set to true to apply locking to the primary while deleting the attachment

attachmentPolicyNode - The attachment policy node where the rules and settings are found

Returns:

Returns the added attachment with all data populated including repository and storage information

editSDIAttachment

public int editSDIAttachment(java.util.HashMap properties,
                             byte[] data)

Method for updating an attachment to an SDI from an byte Array Please note it is recommended to avoid using byte arrays and instead use the inputstream or attachment object methods which are more efficient on memory.

Parameters:

properties - Hashmap of attachment properties for the addition

data - The file data in a byte array

Returns:

Returns successful or failure integer

editSDIAttachment

public int editSDIAttachment(java.util.HashMap properties,
                             java.io.InputStream data)

Method for adding an attachment to an SDI from an input stream

Parameters:

properties - Hashmap of attachment properties for the addition

data - The input stream for the data

Returns:

Returns successful or failure integer