com.jivesoftware.community
Interface AttachmentManager

All Superinterfaces:

JiveManager

public interface AttachmentManager
extends JiveManager

Manages attachment settings. There are three main properties that can administered with respect to attachments:

• Size -- the maximum size in bytes of an individual attachment. Control this value in order to prevent users from uploading massive files that choke the server.
• Attachments Per Object -- control the number of attachments that people are allowed to add to each object.
• Allowed Types -- the file types that are allowed or disallowed to be attachments.

See Also:

Attachment

Method Summary

void	addAllowedType(String contentType) Adds a content type to the list of explicitly allowed types.
void	addDisallowedType(String contentType) Adds a content type to the list of explicitly disallowed types.
Attachment	createAttachment(AttachmentContentResource attachmentContentResource, String name, String contentType, InputStream data, File file) Creates a new attachment for the object.
void	deleteAttachment(Attachment attachment) Deletes an attachment that belongs to the object.
List<String>	getAllowedTypes() Returns a List of explicitly allowed types.
List<String>	getAllowedTypesAsFileExtensions() Returns a list of explicitly allowed file types by extensions.
Attachment	getAttachment(long attachmentID) Returns the attachment corresponding to the attachmentID.
int	getAttachmentCount(AttachmentContentResource attachmentContentResource) Returns the number of attachments the object has.
JiveIterator<Attachment>	getAttachments(AttachmentContentResource attachmentContentResource) Returns an Iterable for the object's attachments.
List<String>	getDisallowedTypes() Returns a List of explicitly disallowed types.
List<String>	getDisallowedTypesAsFileExtensions() Returns a list of explicitly disallowed file types by default extensions.
int	getImagePreviewMaxSize() Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
int	getMaxAttachmentSize() Returns the maximum size of an individual attachment in kilobytes.
int	getMaxAttachmentsPerBlogPost() Returns the maximum number of attachments per blog post.
int	getMaxAttachmentsPerDocument() Returns the maximum number of attachments per document.
int	getMaxAttachmentsPerMessage() Returns the maximum number of attachments per message.
boolean	isAllowAllByDefault() Returns true if in the "allow all content types by default" mode.
boolean	isAttachmentsEnabled() Returns true if attachments are enabled, false otherwise.
boolean	isImagePreviewEnabled() Returns true if image preview support is enabled.
boolean	isImagePreviewRatioEnabled() Returns true if the aspect ratio of thumbnails should be preserved.
boolean	isValidType(String contentType) Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.
void	removeAllowedType(String contentType) Removes a content type fromt he list of explicitly allowed types.
void	removeDisallowedType(String contentType) Removes a content type from the list of explicitly disallowed types.
void	setAllowAllByDefault(boolean allowAllByDefault) Sets the default allowed content types mode.
void	setAttachmentParent(Attachment attachment, AttachmentContentResource attachmentContentResource) Configures the attachment parent for an attachment which was added originally as a temporary attachment.
void	setAttachmentsEnabled(boolean enabled) Sets whether attachments are enabled, false otherwise.
void	setImagePreviewEnabled(boolean imagePreviewEnabled) Toggles whether image preview support is enabled.
void	setImagePreviewMaxSize(int imagePreviewMaxSize) Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
void	setImagePreviewRatioEnabled(boolean imagePreviewRatioEnabled) Toggles whether the aspect ratio of thumbnails should be preserved.
void	setMaxAttachmentSize(int maxAttachmentSize) Sets the maximum size of an individual attachment in kilobytes.
void	setMaxAttachmentsPerBlogPost(int maxAttachmentsPerBlogPost) Sets the maximum number of attachments per blog post.
void	setMaxAttachmentsPerDocument(int maxAttachmentsPerDocument) Sets the maximum number of attachments per document.
void	setMaxAttachmentsPerMessage(int maxAttachmentsPerMessage) Sets the maximum number of attachments per message.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy

Method Detail

isAttachmentsEnabled

boolean isAttachmentsEnabled()

Returns true if attachments are enabled, false otherwise.

Returns:

true if attachments are enabled, false otherwise.

setAttachmentsEnabled

void setAttachmentsEnabled(boolean enabled)
                           throws UnauthorizedException

Sets whether attachments are enabled, false otherwise.

Parameters:

enabled - true if attachments are enabled, false otherwise.

Throws:

UnauthorizedException - if not a system administrator.

getMaxAttachmentSize

int getMaxAttachmentSize()

Returns the maximum size of an individual attachment in kilobytes. Trying to create an attachment larger than the max size will fail with an exception. The default maximum attachment size is 1 megabyte, or 1,024 K.

Returns:

the max size in kilobytes of any single attachment.

setMaxAttachmentSize

void setMaxAttachmentSize(int maxAttachmentSize)
                          throws UnauthorizedException

Sets the maximum size of an individual attachment in kilobytes. Trying to create an attachment larger than the max size will fail with an exception. The default maximum attachment size is 1 megabyte, or 1024 K.

Parameters:

maxAttachmentSize - the max size in kilobytes of any single attachment.

Throws:

UnauthorizedException - if not an administrator.

getMaxAttachmentsPerDocument

int getMaxAttachmentsPerDocument()

Returns the maximum number of attachments per document. The default is 5 attachments.

Returns:

the max number of attachments allowed per document.

setMaxAttachmentsPerDocument

void setMaxAttachmentsPerDocument(int maxAttachmentsPerDocument)
                                  throws UnauthorizedException

Sets the maximum number of attachments per document. The default is 5 attachments.

Parameters:

maxAttachmentsPerDocument - the max number of attachments allowed per document.

Throws:

UnauthorizedException - if not an administrator.

isValidType

boolean isValidType(String contentType)

Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.

Parameters:

contentType - the content type to test.

Returns:

true if the content type is valid.

addAllowedType

void addAllowedType(String contentType)
                    throws UnauthorizedException

Adds a content type to the list of explicitly allowed types.

Parameters:

contentType - a content type to add to the explicitly allowed types list.

Throws:

UnauthorizedException - if not an administrator.

removeAllowedType

void removeAllowedType(String contentType)
                       throws UnauthorizedException

Removes a content type fromt he list of explicitly allowed types. If the given content type does not exist in the list, this method does nothing.

Parameters:

contentType - a content type to remove from the explicitly allowed types list.

Throws:

UnauthorizedException - if not an administrator.

getAllowedTypes

List<String> getAllowedTypes()

Returns a List of explicitly allowed types.

Returns:

a List of all explicitly allowed types.

getAllowedTypesAsFileExtensions

List<String> getAllowedTypesAsFileExtensions()

Returns a list of explicitly allowed file types by extensions. For example, image/png would return .png. Since not all allowed mime types may have a ful list of extensions (e.g. application/octet-stream) it's possible that an extension will not be present in the returned list that otherwise will be a valid extension.

Returns:

a list of explicitly allowed file types by extensions

addDisallowedType

void addDisallowedType(String contentType)
                       throws UnauthorizedException

Adds a content type to the list of explicitly disallowed types.

Parameters:

contentType - a content type to add to the explicitly disallowed types list.

Throws:

UnauthorizedException - if not an administrator.

removeDisallowedType

void removeDisallowedType(String contentType)
                          throws UnauthorizedException

Removes a content type from the list of explicitly disallowed types.

Parameters:

contentType - a content type to remove from the explicitly disallowed types list.

Throws:

UnauthorizedException - if not an administrator.

getDisallowedTypes

List<String> getDisallowedTypes()

Returns a List of explicitly disallowed types.

Returns:

a list of all explicitly disallowed types.

getDisallowedTypesAsFileExtensions

List<String> getDisallowedTypesAsFileExtensions()

Returns a list of explicitly disallowed file types by default extensions. For example, image/png would return .png.

Returns:

a list of explicitly disallowed file types by extensions

isAllowAllByDefault

boolean isAllowAllByDefault()

Returns true if in the "allow all content types by default" mode. The alternative is that all content types are disallowed unless they're on the "allowed" list.

Returns:

true if all content types are allowed by default.

setAllowAllByDefault

void setAllowAllByDefault(boolean allowAllByDefault)
                          throws UnauthorizedException

Sets the default allowed content types mode. The value true means that all content types will be allowed unless they're on the "disallowed list". If false, no content types will be allowed unless on the "allowed list".

Parameters:

allowAllByDefault - true if all content types should be allowed by default.

Throws:

UnauthorizedException - if does not have admin permissions.

isImagePreviewEnabled

boolean isImagePreviewEnabled()

Returns true if image preview support is enabled. When enabled, the JiveServlet will generate thumbnails for image attachments. False by default.

Returns:

true if thumbnail support is enabled.

setImagePreviewEnabled

void setImagePreviewEnabled(boolean imagePreviewEnabled)
                            throws UnauthorizedException

Toggles whether image preview support is enabled. When enabled, the JiveServlet will generate thumbnails for image attachments. False by default.

Parameters:

imagePreviewEnabled - true if thumbnail support should be enabled.

Throws:

UnauthorizedException - if not a system administrator.

getImagePreviewMaxSize

int getImagePreviewMaxSize()

Returns the max dimension of generated thumbnails (ie, the max value for the width or height). The default value is 25.

Returns:

the max dimension of a thumbnail.

setImagePreviewMaxSize

void setImagePreviewMaxSize(int imagePreviewMaxSize)
                            throws UnauthorizedException

Sets the max dimension of generated thumbnails (ie, the max value for the width or height). The default value is 25.

Parameters:

imagePreviewMaxSize - the max dimension of a thumbnail.

Throws:

UnauthorizedException - if not a system administrator.

isImagePreviewRatioEnabled

boolean isImagePreviewRatioEnabled()

Returns true if the aspect ratio of thumbnails should be preserved. When enabled, the aspect ratio of the original image will be preserved when generating the thumbnail. When false, the thumbnail will always be a square (which may distort the image). The default is true.

Returns:

true if the aspect ration should be preserved.

setImagePreviewRatioEnabled

void setImagePreviewRatioEnabled(boolean imagePreviewRatioEnabled)
                                 throws UnauthorizedException

Toggles whether the aspect ratio of thumbnails should be preserved. When enabled, the aspect ratio of the original image will be preserved when generating the thumbnail. When false, the thumbnail will always be a square (which may distort the image). The default is true.

Parameters:

imagePreviewRatioEnabled - true if the aspect ration should be preserved.

Throws:

UnauthorizedException - if not a system administrator.

getMaxAttachmentsPerMessage

int getMaxAttachmentsPerMessage()

Returns the maximum number of attachments per message. The default is 5 attachments.

Returns:

the max number of attachments allowed per message.

setMaxAttachmentsPerMessage

void setMaxAttachmentsPerMessage(int maxAttachmentsPerMessage)
                                 throws UnauthorizedException

Sets the maximum number of attachments per message. The default is 5 attachments.

Parameters:

maxAttachmentsPerMessage - the max number of attachments allowed per message.

Throws:

UnauthorizedException - if not an administrator.

getMaxAttachmentsPerBlogPost

int getMaxAttachmentsPerBlogPost()

Returns the maximum number of attachments per blog post. The default is 5 attachments.

Returns:

the max number of attachments allowed per blog post.

setMaxAttachmentsPerBlogPost

void setMaxAttachmentsPerBlogPost(int maxAttachmentsPerBlogPost)
                                  throws UnauthorizedException

Sets the maximum number of attachments per blog post. The default is 5 attachments.

Parameters:

maxAttachmentsPerBlogPost - the max number of attachments allowed per blog post.

Throws:

UnauthorizedException - if not an administrator.

getAttachmentCount

int getAttachmentCount(AttachmentContentResource attachmentContentResource)

Returns the number of attachments the object has.

Parameters:

attachmentContentResource - the resource to get the attachment count for

Returns:

the number of attachments the object has.

getAttachments

JiveIterator<Attachment> getAttachments(AttachmentContentResource attachmentContentResource)

Returns an Iterable for the object's attachments.

Parameters:

attachmentContentResource - the resource to get attachments for

Returns:

an Iterable of Attachment objects for the object.

See Also:

Attachment

getAttachment

Attachment getAttachment(long attachmentID)
                         throws IllegalArgumentException,
                                AttachmentNotFoundException

Returns the attachment corresponding to the attachmentID.

Parameters:

attachmentID - the id of the attachment to retrieve.

Returns:

the attachment.

Throws:

IllegalArgumentException - if the attachment doesn't exist or belong to the object.

AttachmentNotFoundException - if the attachment cannot be found

createAttachment

Attachment createAttachment(AttachmentContentResource attachmentContentResource,
                            String name,
                            String contentType,
                            InputStream data,
                            File file)
                            throws IllegalStateException,
                                   AttachmentException,
                                   UnauthorizedException

Creates a new attachment for the object. Each attachment has a name, content type and binary data. Rules about who can create attachments and what kind attachments are allowed are controlled via permissions and this manager.

Parameters:

attachmentContentResource - the resource to create the attachment for

name - the name of the new attachment, usually the file name.

contentType - the content type of the attachment.

data - an InputStream that contains the binary data of the attachment. The stream will never be closed so you must close it manually after calling this method.

file - object if it is available. Null value is allowed when missing the File instance

Returns:

an Attachment object representing the new attachment created.

Throws:

AttachmentException - if an error occurred while creating the attachment.

UnauthorizedException - if not allowed to create attachments.

IllegalStateException - if the object hasn't yet been saved.

See Also:

Attachment, AttachmentManager

deleteAttachment

void deleteAttachment(Attachment attachment)
                      throws AttachmentException,
                             UnauthorizedException

Deletes an attachment that belongs to the object. Only administrators or the creator of the object are allowed to call this method.

Parameters:

attachment - the attachment to delete.

Throws:

IllegalArgumentException - if the attachment doesn't belong to the object.

UnauthorizedException - if not authorized to delete the attachment.

AttachmentException - if there was an error deleting the attachment.

setAttachmentParent

void setAttachmentParent(Attachment attachment,
                         AttachmentContentResource attachmentContentResource)
                         throws AttachmentException,
                                AttachmentNotFoundException

Configures the attachment parent for an attachment which was added originally as a temporary attachment. A temporary attachment is one whose parent was unknown at the time it was created.

Parameters:

attachment - the attachment which is being created

attachmentContentResource - the parent which is being created for the attachment.

Throws:

AttachmentException - indecates there was an error updating the attachment

AttachmentNotFoundException - indicates that the attachment could not be loaded.

Since:

Jive Clearspace 2.5.9, Jive SBS 3.0.1