org.jbei.ice.lib.entry.attachment

Class Attachments

java.lang.Object

org.jbei.ice.lib.entry.attachment.Attachments

public class Attachments
extends Object

ICE Entry Attachments

Author:

Hector Plahar

Field Summary

Fields

Modifier and Type	Field and Description
static String	attachmentDirName

Constructor Summary

Constructors

Constructor and Description
Attachments()

Method Summary

Modifier and Type	Method and Description
AttachmentInfo	addAttachmentToEntry(String userId, long partId, AttachmentInfo info)
boolean	delete(String userId, long partId, long attachmentId)
ByteArrayWrapper	getAttachmentByFileId(String userId, String fileId) Retrieves a previously uploaded attachment to an entry by it's unique file identifier This file identifier is assigned on upload
ArrayList<AttachmentInfo>	getByEntry(String userId, long entryId)
String	getFileName(String userId, String fileId) Retrieves the name of the file represented by the file identifer
Attachment	save(String userId, Attachment attachment, InputStream inputStream) Save attachment to the database and the disk.

Methods inherited from class java.lang.Object

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

Field Detail

attachmentDirName

public static final String attachmentDirName

See Also:

Constant Field Values

Constructor Detail

Attachments

public Attachments()

Method Detail

getAttachmentByFileId

public ByteArrayWrapper getAttachmentByFileId(String userId,
                                              String fileId)
                                       throws IOException

Retrieves a previously uploaded attachment to an entry by it's unique file identifier This file identifier is assigned on upload

Returns:

wrapper around file byte array and name

Throws:

PermissionException - if the attachment referenced by the fileId exists but the user does not have read permissions on the entry associated with the attachment

IOException - on exception retrieving file

getFileName

public String getFileName(String userId,
                          String fileId)

Retrieves the name of the file represented by the file identifer

Parameters:

userId - unique identifier for user making request

fileId - unique file identifier for attachment

Returns:

name of file associated with attachment if found, or null is there is no such attachment

Throws:

PermissionException - if the user making the request does not have read permissions on the entry associated with the attachment

save

public Attachment save(String userId,
                       Attachment attachment,
                       InputStream inputStream)

Save attachment to the database and the disk. Entry has to be a transferred entry (Visibility of 2) or the account must have write permissions to it

Parameters:

userId - account for user making request. Can be null if method is called as a result of a transfer

attachment - attachment

inputStream - The data stream of the file.

Returns:

Saved attachment.

delete

public boolean delete(String userId,
                      long partId,
                      long attachmentId)

getByEntry

public ArrayList<AttachmentInfo> getByEntry(String userId,
                                            long entryId)

addAttachmentToEntry

public AttachmentInfo addAttachmentToEntry(String userId,
                                           long partId,
                                           AttachmentInfo info)