er.attachment.processors

Class ERDatabaseAttachmentProcessor

java.lang.Object

er.attachment.processors.ERAttachmentProcessor<ERDatabaseAttachment>

er.attachment.processors.ERDatabaseAttachmentProcessor

public class ERDatabaseAttachmentProcessor
extends ERAttachmentProcessor<ERDatabaseAttachment>

ERDatabaseAttachmentProcessor implements storing attachment data as an attribute of an EO. For more information about configuring an ERDatabaseAttachmentProcessor, see the top level documentation.

Author:

mschrag

Properties

Name	Description
er.attachment.[configurationName].db.webPath	er.attachment.[configurationName].db.webPath
er.attachment.db.webPath	er.attachment.db.webPath
er.attachment.[configurationName].db.smallData	er.attachment.[configurationName].db.smallData
er.attachment.db.smallData	er.attachment.db.smallData

Nested Class Summary

Nested classes/interfaces inherited from class er.attachment.processors.ERAttachmentProcessor

ERAttachmentProcessor.ERXAttachmentExceedsLengthException

Field Summary

Fields inherited from class er.attachment.processors.ERAttachmentProcessor

log

Constructor Summary

Constructors

Constructor and Description
ERDatabaseAttachmentProcessor()

Method Summary

Modifier and Type	Method and Description
ERDatabaseAttachment	_process(com.webobjects.eocontrol.EOEditingContext editingContext, File uploadedFile, String recommendedFileName, String mimeType, String configurationName, String ownerID, boolean pendingDelete) Processes an uploaded file, imports it into the appropriate data store, and returns an ERAttachment that represents it.
ERDatabaseAttachment	_process(com.webobjects.eocontrol.EOEditingContext editingContext, com.webobjects.foundation.NSData data, String recommendedFileName, String mimeType, String configurationName)
InputStream	attachmentInputStream(ERDatabaseAttachment attachment) Returns an InputStream to the data of the given attachment.
String	attachmentUrl(ERDatabaseAttachment attachment, com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Returns a URL to the attachment's data.
void	deleteAttachment(ERDatabaseAttachment attachment) Deletes the attachment from the data store.

Methods inherited from class er.attachment.processors.ERAttachmentProcessor

_parsePathTemplate, addAttachmentProcessorForType, attachmentInserted, delegate, process, process, process, process, process, process, processorForConfigurationName, processorForType, processorForType, processors, proxiedUrl, proxyAsAttachment, setDelegate

Methods inherited from class java.lang.Object

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

Constructor Detail

ERDatabaseAttachmentProcessor

public ERDatabaseAttachmentProcessor()

Method Detail

_process

public ERDatabaseAttachment _process(com.webobjects.eocontrol.EOEditingContext editingContext,
                                     File uploadedFile,
                                     String recommendedFileName,
                                     String mimeType,
                                     String configurationName,
                                     String ownerID,
                                     boolean pendingDelete)
                              throws IOException

Description copied from class: ERAttachmentProcessor

Processes an uploaded file, imports it into the appropriate data store, and returns an ERAttachment that represents it. uploadedFile will be deleted after the import process is complete.

Specified by:

_process in class ERAttachmentProcessor<ERDatabaseAttachment>

Parameters:

editingContext - the EOEditingContext to create the ERAttachment in

uploadedFile - the uploaded temporary file (which will be deleted at the end)

recommendedFileName - the filename recommended by the user during import

mimeType - the mimeType to use (null = guess based on file extension)

configurationName - the name of the configuration settings to use for this processor (see top level docs)

ownerID - an arbitrary string that represents the ID of the "owner" of this thumbnail (Person.primaryKey, for instance)

pendingDelete - if true, the uploadedFile will be deleted after import; if false, it will be left alone

Returns:

an ERAttachment that represents the file

Throws:

IOException - if the processing fails

_process

public ERDatabaseAttachment _process(com.webobjects.eocontrol.EOEditingContext editingContext,
                                     com.webobjects.foundation.NSData data,
                                     String recommendedFileName,
                                     String mimeType,
                                     String configurationName)

attachmentInputStream

public InputStream attachmentInputStream(ERDatabaseAttachment attachment)
                                  throws FileNotFoundException

Description copied from class: ERAttachmentProcessor

Returns an InputStream to the data of the given attachment.

Specified by:

attachmentInputStream in class ERAttachmentProcessor<ERDatabaseAttachment>

Parameters:

attachment - the attachment to retrieve the data for

Returns:

an InputStream onto the data

Throws:

FileNotFoundException

attachmentUrl

public String attachmentUrl(ERDatabaseAttachment attachment,
                            com.webobjects.appserver.WORequest request,
                            com.webobjects.appserver.WOContext context)

Description copied from class: ERAttachmentProcessor

Returns a URL to the attachment's data.

Specified by:

attachmentUrl in class ERAttachmentProcessor<ERDatabaseAttachment>

Parameters:

attachment - the attachment to generate a URL for

request - the current request

context - the current context

Returns:

a URL to the attachment's data

deleteAttachment

public void deleteAttachment(ERDatabaseAttachment attachment)

Description copied from class: ERAttachmentProcessor

Deletes the attachment from the data store.

Specified by:

deleteAttachment in class ERAttachmentProcessor<ERDatabaseAttachment>

Parameters:

attachment - the attachment to delete