com.communote.server.core.vo.content

Class AttachmentTO

java.lang.Object

com.communote.server.core.vo.AbstractTransferObject

com.communote.server.core.vo.content.AttachmentTO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AttachmentFileTO, AttachmentRedirectTO, AttachmentStreamTO

public abstract class AttachmentTO
extends AbstractTransferObject
implements Serializable

The AttachmentTO encapsulates the logic to access an attachment by streams. The streams source can be either a file or a stream which is defined by the subclasses. The encapsulation is necessary to assure the closing of the input streams as they got accessed. Use the write methods to write an attachment either to a file or to another stream.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttachmentTO(AttachmentStatus status)

Method Summary

Modifier and Type	Method and Description
protected void	close(InputStream inputStream) Close the stream
long	getContentLength() Get the content length.
ContentMetadata	getMetadata()
Long	getNoteId()
List<StringPropertyTO>	getProperties()
AttachmentStatus	getStatus() The status of the attachment to be used
Date	getUploadDate()
Long	getUploaderId()
protected abstract InputStream	open() Open the inputstream
void	sendInResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String characterEncoding, boolean dipositionTypeAsAttachment)
void	setContentLength(long contentLength) Set the content length, that will set it on the metadata, if not null.
void	setMetadata(ContentMetadata metadata) Sets the metadata, it will also update metadata.getContentSize if the content size might be known and the metadata content length is not set
void	setNoteId(Long noteId) NoteId is ignored on creating a note and associating it.
void	setProperties(List<StringPropertyTO> properties)
void	setStatus(AttachmentStatus status)
void	setUploadDate(Date uploadDate)
void	setUploaderId(Long uploaderId)
void	setVirusScanner(VirusScanner scanner)
String	toString()
void	write(File file) Open the stream and write its content to the file.
void	write(File file, long maxLength) Open the stream and write at most maxLength bytes of the content to the file.
void	write(OutputStream outStream) Write the attachment to the output stream.
void	write(OutputStream outStream, long maxLength) Write the attachment to the output stream.

Methods inherited from class com.communote.server.core.vo.AbstractTransferObject

copy

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentTO

public AttachmentTO(AttachmentStatus status)

Parameters:

status - set the status, can be null

Method Detail

close

protected void close(InputStream inputStream)
              throws IOException

Close the stream

Parameters:

inputStream - the input stream

Throws:

IOException - in case of an io error

getContentLength

public long getContentLength()

Get the content length. That will be length of the meta data, if set, or the length that could be predetermined (e.g. if the source is a file). However after the write method has been called the length is updated (also in the meta data, if not null).

Returns:

the content length

getMetadata

public ContentMetadata getMetadata()

Returns:

the metadata

getNoteId

public Long getNoteId()

Returns:

id of the note the attachment is associated with. null if no note connected.

getProperties

public List<StringPropertyTO> getProperties()

getStatus

public AttachmentStatus getStatus()

The status of the attachment to be used

Returns:

the status

getUploadDate

public Date getUploadDate()

Returns:

The date the attachment was uploaded.

getUploaderId

public Long getUploaderId()

Returns:

Id of the user, who uploaded the attachment.

open

protected abstract InputStream open()
                             throws IOException

Open the inputstream

Returns:

the inputstream to read from

Throws:

IOException - in case of an io error

sendInResponse

public void sendInResponse(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           String characterEncoding,
                           boolean dipositionTypeAsAttachment)
                    throws IOException

Throws:

IOException

setContentLength

public void setContentLength(long contentLength)

Set the content length, that will set it on the metadata, if not null.

Parameters:

contentLength - the content length

setMetadata

public void setMetadata(ContentMetadata metadata)

Sets the metadata, it will also update metadata.getContentSize if the content size might be known and the metadata content length is not set

Parameters:

metadata - the metadata to be set

setNoteId

public void setNoteId(Long noteId)

NoteId is ignored on creating a note and associating it. Use create note of NoteManagement to connect attachments with notes.

Parameters:

noteId - id of the note the attachment is associated with. null if no note connected.

setProperties

public void setProperties(List<StringPropertyTO> properties)

setStatus

public void setStatus(AttachmentStatus status)

Parameters:

status - set the attachment status

setUploadDate

public void setUploadDate(Date uploadDate)

Parameters:

uploadDate - The date the attachment was uploaded.

setUploaderId

public void setUploaderId(Long uploaderId)

Parameters:

uploaderId - Method to set the uploaders id.

setVirusScanner

public void setVirusScanner(VirusScanner scanner)

Parameters:

scanner - the virus scanner to be used then writing

toString

public String toString()

Overrides:

toString in class Object

write

public void write(File file)
           throws IOException

Open the stream and write its content to the file. After writing the stream will be closed and the number of written bytes will be stored in the content length member of the metadata ( #metadata#setContentLength(long)) if metadata is not null.

Parameters:

file - the file to write to

Throws:

IOException - in case of an error

write

public void write(File file,
                  long maxLength)
           throws IOException

Open the stream and write at most maxLength bytes of the content to the file. After writing the stream will be closed and the number of written bytes will be stored in the content length member of the metadata ( #metadata#setContentLength(long)) if metadata is not null.

Parameters:

file - the file to write to

maxLength - See IOHelper.write(InputStream, OutputStream, long) for more information.

Throws:

IOException - in case of an error

write

public void write(OutputStream outStream)
           throws IOException

Write the attachment to the output stream. Will not close the output stream.

Parameters:

outStream - the output stream

Throws:

IOException - in case of an error

write

public void write(OutputStream outStream,
                  long maxLength)
           throws IOException

Write the attachment to the output stream. Will not close the output stream.

Parameters:

outStream - the output stream

maxLength - See IOHelper.write(InputStream, OutputStream, long) for more information.

Throws:

IOException - in case of an error