net.bluemind.attachment.api

Interface IAttachment

All Known Implementing Classes:

AttachmentService

@Path(value="/attachment/{domainUid}")
public interface IAttachment

API used in conjunction with IFileHosting to share mail attachments by replacing them with a link

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() Retrieves the configuration
AttachedFile	share(java.lang.String name, Stream document) Share a mail attachment
AttachedFile	shareDedup(java.lang.String extension, Stream document) Share a mail attachment.
void	unShare(java.lang.String url) Deactivate a link to a shared file

Method Detail

share

@PUT
 @Path(value="{name}/share")
AttachedFile share(@PathParam(value="name")
                                                     java.lang.String name,
                                                     Stream document)
                                              throws ServerFault

Share a mail attachment

Parameters:

name - the filename

document - Stream of the file data

Returns:

AttachedFile containg informations about the shared file

Throws:

ServerFault - common error object

shareDedup

@PUT
 @Path(value="{extension}/share_dedup")
AttachedFile shareDedup(@PathParam(value="extension")
                                                                     java.lang.String extension,
                                                                     Stream document)
                                                              throws ServerFault

Share a mail attachment. If a document with the same hash already exists, it will not be uploaded.

Parameters:

extension - the extension to use for the file (eg. 'png')

document - Stream of the file data

Returns:

AttachedFile containg informations about the shared file

Throws:

ServerFault - common error object

unShare

@DELETE
 @Path(value="{url}/unshare")
void unShare(@PathParam(value="url")
                                                   java.lang.String url)
                                            throws ServerFault

Deactivate a link to a shared file

Parameters:

url - Link to the shared file

Throws:

ServerFault - common error object

getConfiguration

@GET
 @Path(value="_config")
Configuration getConfiguration()
                                                     throws ServerFault

Retrieves the configuration

Returns:

the Filehosting service configuration

Throws:

ServerFault - common error object