org.jasig.portlet.attachment.service.impl

Class AttachmentService

java.lang.Object

org.jasig.portlet.attachment.service.impl.AttachmentService

All Implemented Interfaces:

IAttachmentService

@Component
public class AttachmentService
extends java.lang.Object
implements IAttachmentService

Author:

Chris Waymire (chris@waymire.net)

Constructor Summary

Constructors

Constructor and Description
AttachmentService()

Method Summary

Modifier and Type	Method and Description
void	delete(Attachment attachment)
void	delete(long attachmentId)
java.util.List<Attachment>	find(java.lang.String creator)
java.util.List<Attachment>	find(java.lang.String creator, java.lang.String filename)
java.util.List<Attachment>	findAll(int offset, int maxresults)
Attachment	get(long attachmentId)
Attachment	get(java.lang.String guid)
IAttachmentDao	getAttachmentDao()
IDocumentPersistenceStrategy	getDocumentPersistenceStrategy()
boolean	isPersistenceIntoDatabaseRequired() Boolean indicating whether or not attachment data is stored into the database.
Attachment	save(Attachment attachment, java.lang.String username, javax.servlet.http.HttpServletRequest request) Saves the metadata about the attachment to the database and persists the attachment to the configured documentPersistenceStrategy store.
void	setAttachmentDao(IAttachmentDao attachmentDao)
void	setDocumentPersistenceStrategy(IDocumentPersistenceStrategy documentPersistenceStrategy)
protected void	updateTimestamps(Attachment attachment, java.lang.String user)

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentService

public AttachmentService()

Method Detail

get

public Attachment get(long attachmentId)

Specified by:

get in interface IAttachmentService

get

public Attachment get(java.lang.String guid)

Specified by:

get in interface IAttachmentService

find

public java.util.List<Attachment> find(java.lang.String creator)

Specified by:

find in interface IAttachmentService

find

public java.util.List<Attachment> find(java.lang.String creator,
                                       java.lang.String filename)

Specified by:

find in interface IAttachmentService

findAll

public java.util.List<Attachment> findAll(int offset,
                                          int maxresults)

Specified by:

findAll in interface IAttachmentService

save

public Attachment save(Attachment attachment,
                       java.lang.String username,
                       javax.servlet.http.HttpServletRequest request)

Description copied from interface: IAttachmentService

Saves the metadata about the attachment to the database and persists the attachment to the configured documentPersistenceStrategy store.

Specified by:

save in interface IAttachmentService

Parameters:

attachment - Attachment to persist

username - username of the user uploading the document

request - HttpServlet request. Will be null with a data import operation

Returns:

Updated attachment object

delete

public void delete(Attachment attachment)

Specified by:

delete in interface IAttachmentService

delete

public void delete(long attachmentId)

Specified by:

delete in interface IAttachmentService

updateTimestamps

protected void updateTimestamps(Attachment attachment,
                                java.lang.String user)

getAttachmentDao

public IAttachmentDao getAttachmentDao()

setAttachmentDao

public void setAttachmentDao(IAttachmentDao attachmentDao)

getDocumentPersistenceStrategy

public IDocumentPersistenceStrategy getDocumentPersistenceStrategy()

setDocumentPersistenceStrategy

public void setDocumentPersistenceStrategy(IDocumentPersistenceStrategy documentPersistenceStrategy)

isPersistenceIntoDatabaseRequired

public boolean isPersistenceIntoDatabaseRequired()

Description copied from interface: IAttachmentService

Boolean indicating whether or not attachment data is stored into the database. Some persistence stores, such as the local filesystem, would want the data stored into the database to allow for hydrating the data from the database in case it is not on the local file system. This is used when you have a cluster of portal servers and a server may not have the content hydrated locally. Other persistence stores, such as a network share or S3, store their data external to the portal server so there is no need to have the file data stored into a database.

Specified by:

isPersistenceIntoDatabaseRequired in interface IAttachmentService

Returns:

True if the file data is stored in the database, else false.