|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttachmentManagerService
A web service to manage attachment settings. Modeled after the CacheableService. This interface is a direct copy
of the com.jivesoftware.forum.AttachmentManager
interface, tailored for web service deployment. The
main difference is rather than return Iterators or Collections, sets of data are returned as arrays.
Method comments are copied from the original interface.
Method Summary | |
---|---|
void |
addAllowedType(java.lang.String contentType)
Adds a content type to the list of explicitly allowed types. |
void |
addDisallowedType(java.lang.String contentType)
Adds a content type to the list of explicitly disallowed types. |
java.lang.String[] |
allowedTypes()
Returns a String[] for the list of explicitly allowed types. |
java.lang.String[] |
disallowedTypes()
Returns an Iterator for the list of explicitly disallowed types. |
boolean |
getAllowAllByDefault()
Returns true if in the "allow all content types by default" mode. |
long |
getAttachmentDirectorySize()
Returns the size (in bytes) of the attachment directory on the file system. |
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 |
getMaxAttachmentsPerMessage()
Returns the maximum number of attachments per message. |
long |
getMaxFilesystemCacheSize()
Returns the maximum amount of storage (in bytes) that will be used by the file system cache when database attachment mode is enabled. |
boolean |
isDatabaseModeEnabled()
Returns true if the binary attachment data is stored in the database. |
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(java.lang.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(java.lang.String contentType)
Removes a content type fromt he list of explicitly allowed types. |
void |
removeDisallowedType(java.lang.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 |
setDatabaseModeEnabled(boolean enabled)
Enables or disables storage of binary attachment data in the database. |
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 |
setMaxAttachmentsPerMessage(int maxAttachmentsPerMessage)
Sets the maximum number of attachments per message. |
void |
setMaxFilesystemCacheSize(long maxSize)
Sets the maximum amount of storage (in bytes) that will be used by the file system cache when database attachment mode is enabled. |
Method Detail |
---|
boolean isDatabaseModeEnabled()
When database attachment mode is enabled, attachment data will be cached on the file system in the attachment directory in order to relieve load on the database.
void setDatabaseModeEnabled(boolean enabled) throws UnauthorizedException
When database attachment mode is enabled, attachment data will be cached on the file system in the attachment directory in order to relieve load on the database.
enabled
- true if attachment data should be stored in the database.
UnauthorizedException
- if not a system administrator.long getAttachmentDirectorySize() throws UnauthorizedException
The size of the attachment directory is computed asynchronously at system startup. Therefore, when the the size of the directory is not known, this method will return -1.
UnauthorizedException
- if not a system administrator.long getMaxFilesystemCacheSize() throws UnauthorizedException
UnauthorizedException
- if not a system administrator.void setMaxFilesystemCacheSize(long maxSize) throws UnauthorizedException
maxSize
- the max size of the file system cache for attachment data (in bytes).
UnauthorizedException
- if not a system administrator.int getMaxAttachmentSize()
void setMaxAttachmentSize(int maxAttachmentSize) throws UnauthorizedException
maxAttachmentSize
- the max size in kilobytes of any single
attachment.
UnauthorizedException
- if not an administrator.int getMaxAttachmentsPerMessage()
void setMaxAttachmentsPerMessage(int maxAttachmentsPerMessage) throws UnauthorizedException
maxAttachmentsPerMessage
- the max number of attachments allowed
per message.
UnauthorizedException
- if not an administrator.boolean isValidType(java.lang.String contentType)
contentType
- the content type to test.
void addAllowedType(java.lang.String contentType) throws UnauthorizedException
contentType
- a content type to add to the explicitly allowed types
list.
UnauthorizedException
- if not an administrator.void removeAllowedType(java.lang.String contentType) throws UnauthorizedException
contentType
- a content type to remove from the explicitly allowed
types list.
UnauthorizedException
- if not an administrator.java.lang.String[] allowedTypes()
void addDisallowedType(java.lang.String contentType) throws UnauthorizedException
contentType
- a content type to add to the explicitly disallowed
types list.
UnauthorizedException
- if not an administrator.void removeDisallowedType(java.lang.String contentType) throws UnauthorizedException
contentType
- a content type to remove from the explicitly disallowed
types list.
UnauthorizedException
- if not an administrator.java.lang.String[] disallowedTypes()
boolean getAllowAllByDefault()
void setAllowAllByDefault(boolean allowAllByDefault) throws UnauthorizedException
allowAllByDefault
- true if all content types should be
allowed by default.
UnauthorizedException
boolean isImagePreviewEnabled()
void setImagePreviewEnabled(boolean imagePreviewEnabled) throws UnauthorizedException
imagePreviewEnabled
- true if thumbnail support should be enabled.
UnauthorizedException
- if not a system administrator.int getImagePreviewMaxSize()
void setImagePreviewMaxSize(int imagePreviewMaxSize) throws UnauthorizedException
imagePreviewMaxSize
- the max dimension of a thumbnail.
UnauthorizedException
- if not a system administrator.boolean isImagePreviewRatioEnabled()
void setImagePreviewRatioEnabled(boolean imagePreviewRatioEnabled) throws UnauthorizedException
imagePreviewRatioEnabled
- true if the aspect ration should be preserved.
UnauthorizedException
- if not a system administrator.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |