net.bluemind.hsm.api

Interface IHSM

All Known Subinterfaces:

IInCoreHSM

All Known Implementing Classes:

HSMService

@Path(value="/hsm/{domainUid}")
public interface IHSM

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String sourceMailboxUid, java.lang.String destMailboxUid, java.util.List<java.lang.String> hsmIds)
void	deleteDomainPolicy()
void	deletePolicy(java.lang.String mailboxUid)
TierChangeResult	demote(Demote demote) Moves a message to a lower tier of storage (eg.
java.util.List<TierChangeResult>	demoteMultiple(java.util.List<Demote> demote) Moves messages to a lower tier of storage (eg.
byte[]	fetch(java.lang.String mailboxUid, java.lang.String hsmId) Fetches the content of a message from low-tier storage
StoragePolicy	getDomainPolicy()
StoragePolicy	getPolicy(java.lang.String mailboxUid)
double	getSize(java.lang.String mailboxUid) Get user archive size used in byte
TierChangeResult	promote(Promote promote) Moves a message to an upper tier of storage (eg.
java.util.List<TierChangeResult>	promoteMultiple(java.util.List<Promote> promote) Moves messages to an upper tier of storage (eg.
void	setDomainPolicy(StoragePolicy sp)
void	setPolicy(java.lang.String mailboxUid, StoragePolicy sp)

Method Detail

setDomainPolicy

@PUT
 @Path(value="_setDomainPolicy")
void setDomainPolicy(StoragePolicy sp)
                                                    throws ServerFault

Throws:

ServerFault

getDomainPolicy

@GET
 @Path(value="_getDomainPolicy")
StoragePolicy getDomainPolicy()
                                                             throws ServerFault

Throws:

ServerFault

deleteDomainPolicy

@DELETE
 @Path(value="_deleteDomainPolicy")
void deleteDomainPolicy()
                                                             throws ServerFault

Throws:

ServerFault

setPolicy

@PUT
 @Path(value="_setPolicy/{mailboxUid}")
void setPolicy(@PathParam(value="mailboxUid")
                                                            java.lang.String mailboxUid,
                                                            StoragePolicy sp)
                                                     throws ServerFault

Throws:

ServerFault

getPolicy

@GET
 @Path(value="_getPolicy/{mailboxUid}")
StoragePolicy getPolicy(@PathParam(value="mailboxUid")
                                                                     java.lang.String mailboxUid)
                                                              throws ServerFault

Throws:

ServerFault

deletePolicy

@DELETE
 @Path(value="_deletePolicy/{mailboxUid}")
void deletePolicy(@PathParam(value="mailboxUid")
                                                                     java.lang.String mailboxUid)
                                                              throws ServerFault

Throws:

ServerFault

demote

@POST
 @Path(value="_demote")
TierChangeResult demote(Demote demote)
                                               throws ServerFault

Moves a message to a lower tier of storage (eg. from the user mailbox to the archive)

Parameters:

demote -

Throws:

ServerFault

promote

@POST
 @Path(value="_promote")
TierChangeResult promote(Promote promote)
                                                 throws ServerFault

Moves a message to an upper tier of storage (eg. from archive to the user mailbox)

Parameters:

promote -

Throws:

ServerFault

fetch

@GET
 @Path(value="_fetch/{mailboxUid}/{hsmId}")
 @Produces(value="application/octet-stream")
byte[] fetch(@PathParam(value="mailboxUid")
                                                                                                           java.lang.String mailboxUid,
                                                                                                           @PathParam(value="hsmId")
                                                                                                           java.lang.String hsmId)
                                                                                                    throws ServerFault

Fetches the content of a message from low-tier storage

Parameters:

mailboxUid -

hsmId -

Throws:

ServerFault

getSize

@GET
 @Path(value="_getSize/{mailboxUid}")
double getSize(@PathParam(value="mailboxUid")
                                                          java.lang.String mailboxUid)
                                                   throws ServerFault

Get user archive size used in byte

Parameters:

mailboxUid -

Returns:

Throws:

ServerFault

copy

@POST
 @Path(value="_copy/{sourceMailboxUid}/{destMailboxUid}")
void copy(@PathParam(value="sourceMailboxUid")
                                                                          java.lang.String sourceMailboxUid,
                                                                          @PathParam(value="destMailboxUid")
                                                                          java.lang.String destMailboxUid,
                                                                          java.util.List<java.lang.String> hsmIds)
                                                                   throws ServerFault

Parameters:

sourceMailboxUid -

destMailboxUid -

hsmIds -

Throws:

ServerFault

demoteMultiple

@POST
 @Path(value="_massDemote")
java.util.List<TierChangeResult> demoteMultiple(java.util.List<Demote> demote)
                                                                           throws ServerFault

Moves messages to a lower tier of storage (eg. from the user mailbox to the archive)

Parameters:

demote -

Throws:

ServerFault

promoteMultiple

@POST
 @Path(value="_massPromote")
java.util.List<TierChangeResult> promoteMultiple(java.util.List<Promote> promote)
                                                                             throws ServerFault

Moves messages to an upper tier of storage (eg. from archive to the user mailbox)

Parameters:

promote -

Throws:

ServerFault