net.bluemind.core.container.api

Interface IContainerManagement

All Known Implementing Classes:

ContainerManagement

@Path(value="/containers/_manage/{containerUid}")
public interface IContainerManagement

Management container

Method Summary

Modifier and Type	Method and Description
void	allowOfflineSync(java.lang.String subject)
boolean	canAccess(java.util.List<java.lang.String> verbsOrRoles)
void	disallowOfflineSync(java.lang.String subject)
java.util.List<AccessControlEntry>	getAccessControlList() Retrieve container ACL
java.util.List<ItemDescriptor>	getAllItems() Get all container items
ContainerDescriptor	getDescriptor() Retrieve container descriptor
java.util.List<ItemDescriptor>	getFilteredItems(ItemFlagFilter filter) Get all container items matching the given filter
Count	getItemCount()
java.util.List<ItemDescriptor>	getItems(java.util.List<java.lang.String> uids) Get container items
java.util.Map<java.lang.String,java.lang.String>	getSettings() Get container settings
void	setAccessControlList(java.util.List<AccessControlEntry> entries) store container ACL
void	setPersonalSettings(java.util.Map<java.lang.String,java.lang.String> settings) Set container personal settings
void	setSettings(java.util.Map<java.lang.String,java.lang.String> settings) Set container settings
java.util.List<java.lang.String>	subscribers()
void	update(ContainerModifiableDescriptor descriptor) Update container descriptor

Method Detail

setAccessControlList

@PUT
 @Path(value="_acl")
void setAccessControlList(java.util.List<AccessControlEntry> entries)
                                             throws ServerFault

store container ACL

Parameters:

entries - acl

Throws:

ServerFault

getAccessControlList

@GET
 @Path(value="_acl")
java.util.List<AccessControlEntry> getAccessControlList()
                                                                           throws ServerFault

Retrieve container ACL

Returns:

List of access control entries

Throws:

ServerFault

getDescriptor

@GET
 @Path(value="_descriptor")
ContainerDescriptor getDescriptor()
                                                            throws ServerFault

Retrieve container descriptor

Returns:

ContainerDescriptor

Throws:

ServerFault

update

@POST
 @Path(value="_descriptor")
void update(ContainerModifiableDescriptor descriptor)
                                       throws ServerFault

Update container descriptor

Parameters:

descriptor -

Throws:

ServerFault

subscribers

@GET
 @Path(value="_subscription")
java.util.List<java.lang.String> subscribers()
                                                                         throws ServerFault

Throws:

ServerFault

getAllItems

@GET
 @Path(value="_list")
java.util.List<ItemDescriptor> getAllItems()
                                                               throws ServerFault

Get all container items

Returns:

ItemDescriptor list

Throws:

ServerFault

getFilteredItems

@GET
 @Path(value="_filtered")
java.util.List<ItemDescriptor> getFilteredItems(ItemFlagFilter filter)
                                                                        throws ServerFault

Get all container items matching the given filter

Returns:

ItemDescriptor list

Throws:

ServerFault

getItems

@POST
 @Path(value="_mget")
java.util.List<ItemDescriptor> getItems(java.util.List<java.lang.String> uids)
                                                             throws ServerFault

Get container items

Parameters:

uids -

Returns:

ItemDescriptor list

Throws:

ServerFault

setPersonalSettings

@PUT
 @Path(value="_personalSettings")
void setPersonalSettings(java.util.Map<java.lang.String,java.lang.String> settings)
                                                         throws ServerFault

Set container personal settings

Parameters:

settings -

Throws:

ServerFault

setSettings

@PUT
 @Path(value="_settings")
void setSettings(java.util.Map<java.lang.String,java.lang.String> settings)
                                         throws ServerFault

Set container settings

Parameters:

settings -

Throws:

ServerFault

getSettings

@GET
 @Path(value="_settings")
java.util.Map<java.lang.String,java.lang.String> getSettings()
                                                                                     throws ServerFault

Get container settings

Throws:

ServerFault

allowOfflineSync

@PUT
 @Path(value="{subject}/offlineSync")
void allowOfflineSync(@PathParam(value="subject")
                                                                 java.lang.String subject)
                                                          throws ServerFault

Throws:

ServerFault

disallowOfflineSync

@DELETE
 @Path(value="{subject}/offlineSync")
void disallowOfflineSync(@PathParam(value="subject")
                                                                       java.lang.String subject)
                                                                throws ServerFault

Throws:

ServerFault

canAccess

@POST
 @Path(value="_canAccess")
boolean canAccess(java.util.List<java.lang.String> verbsOrRoles)
                                            throws ServerFault

Throws:

ServerFault

getItemCount

@GET
 @Path(value="_itemCount")
Count getItemCount()
                                            throws ServerFault

Throws:

ServerFault