com.jivesoftware.forum.proxy
Class AttachmentProxy

java.lang.Object
  com.jivesoftware.forum.proxy.AttachmentProxy

All Implemented Interfaces:

Attachment

public class AttachmentProxy
extends java.lang.Object
implements Attachment

Field Summary

protected Permissions

permissions

Constructor Summary

AttachmentProxy(Attachment attachment, ForumMessageProxy message, AuthToken authToken, Permissions permissions)
Creates a new AttachmentProxy to protect the supplied attachment with the specified permissions

Method Summary

void	deleteProperty(java.lang.String name) Deletes an extended property.
java.lang.String	getContentType() Returns the content type of the attachment.
java.util.Date	getCreationDate() Returns the date the attachment was created.
java.io.InputStream	getData() Returns a InputStream for the binary contents of the attachment.
long	getID() Returns the unique ID of the attachment.
java.util.Date	getModificationDate() Returns the date the attachment was last modified.
java.lang.String	getName() Returns the name of the attachment.
java.util.Collection	getProperties(java.lang.String parentName) Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
java.lang.String	getProperty(java.lang.String name) Returns an extended property of the attachment.
java.util.Iterator	getPropertyNames() Returns an Iterator for the names of the extended properties.
long	getSize() Returns the size of the attachment in bytes.
void	setName(java.lang.String name) Sets the name of the attachment.
void	setProperty(java.lang.String name, java.lang.String value) Sets an extended property of the attachment.

Methods inherited from class java.lang.Object

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

Field Detail

permissions

protected Permissions permissions

Constructor Detail

AttachmentProxy

public AttachmentProxy(Attachment attachment,
                       ForumMessageProxy message,
                       AuthToken authToken,
                       Permissions permissions)

Creates a new AttachmentProxy to protect the supplied attachment with the specified permissions

Method Detail

getID

public long getID()

Description copied from interface: Attachment

Returns the unique ID of the attachment.

Specified by:

getID in interface Attachment

Returns:

the attachment ID.

getContentType

public java.lang.String getContentType()

Description copied from interface: Attachment

Returns the content type of the attachment. For example, the content type of an image attachment might be "image/gif" or "image/jpeg".

Specified by:

getContentType in interface Attachment

Returns:

the attachment content type.

getName

public java.lang.String getName()

Description copied from interface: Attachment

Returns the name of the attachment. Most often, the attachment name is the original name of the file that created the attachment, such as "report.doc"

Specified by:

getName in interface Attachment

Returns:

the name of the attachment.

setName

public void setName(java.lang.String name)
             throws UnauthorizedException

Description copied from interface: Attachment

Sets the name of the attachment. Most often, the attachment name is the original name of the file that created the attachment, such as "report.doc"

Specified by:

setName in interface Attachment

Parameters:

name - the new name of the attachment.

Throws:

UnauthorizedException - if not allowed to modify the attachment

getSize

public long getSize()

Description copied from interface: Attachment

Returns the size of the attachment in bytes.

Specified by:

getSize in interface Attachment

Returns:

the size of the attachment.

getData

public java.io.InputStream getData()
                            throws java.io.IOException

Description copied from interface: Attachment

Returns a InputStream for the binary contents of the attachment. The stream should be closed after reading the attachment is completed. The InputStream will already be buffered, so there is no advantage to using additional buffering.

Specified by:

getData in interface Attachment

Returns:

the binary contents of the attachment.

Throws:

java.io.IOException - if an error occurs reading the attachment from storage.

getCreationDate

public java.util.Date getCreationDate()

Description copied from interface: Attachment

Returns the date the attachment was created.

Specified by:

getCreationDate in interface Attachment

Returns:

the date the attachment was created.

getModificationDate

public java.util.Date getModificationDate()

Description copied from interface: Attachment

Returns the date the attachment was last modified.

Specified by:

getModificationDate in interface Attachment

Returns:

the date the attachment was last modified.

getProperty

public java.lang.String getProperty(java.lang.String name)

Description copied from interface: Attachment

Returns an extended property of the attachment. Each attachment can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

Specified by:

getProperty in interface Attachment

Parameters:

name - the name of the property to get.

Returns:

the value of the property specified by name.

getProperties

public java.util.Collection getProperties(java.lang.String parentName)

Description copied from interface: Attachment

Return all immediate children property values of a parent property as an unmodifiable Collection of String values. A parent/child relationship is denoted by the "." character. For example, given the properties X.Y.A, X.Y.B, X.Y.C and X.Y.C.D, then the immediate child properties of X.Y are X.Y.A, X.Y.B, and X.Y.C (the value of X.Y.C.D would not be returned using this method).

Specified by:

getProperties in interface Attachment

Parameters:

parentName - the name of the parent property to return the children for.

Returns:

all Collection of all child property values for the given parent.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws UnauthorizedException

Description copied from interface: Attachment

Sets an extended property of the attachment. Each attachment can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

If the property referenced by name already exists, its value will be updated.

Specified by:

setProperty in interface Attachment

Parameters:

name - the name of the property to set.

value - the new value for the property.

Throws:

UnauthorizedException - if does not have admin permissions.

deleteProperty

public void deleteProperty(java.lang.String name)
                    throws UnauthorizedException

Description copied from interface: Attachment

Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Specified by:

deleteProperty in interface Attachment

Parameters:

name - the name of the property to delete.

Throws:

UnauthorizedException - if does not have ADMIN permissions.

getPropertyNames

public java.util.Iterator getPropertyNames()

Description copied from interface: Attachment

Returns an Iterator for the names of the extended properties.

Specified by:

getPropertyNames in interface Attachment

Returns:

an Iterator for the names of the extended properties.