Package net.bluemind.core.container.api

Interface IContainerManagement

All Known Subinterfaces:

IInternalContainerManagement

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

Management container

Method Summary

Modifier and Type	Method	Description
void	allowOfflineSync(String subject)
boolean	canAccess(List<String> verbsOrRoles)	Deprecated, for removal: This API element is subject to removal in a future version.
PermittedVerbs	canAccessVerbs(List<String> verbsOrRoles)
void	disallowOfflineSync(String subject)
List<AccessControlEntry>	getAccessControlList()	Retrieve container ACL
List<ItemDescriptor>	getAllItems()	Get all container items
ContainerDescriptor	getDescriptor()	Retrieve container descriptor
List<ItemDescriptor>	getFilteredItems(ItemFlagFilter filter)	Get all container items matching the given filter
Count	getItemCount()
List<ItemDescriptor>	getItems(List<String> uids)	Get container items
Map<String,String>	getSettings()	Get container settings
void	setAccessControlList(List<AccessControlEntry> entries)	store container ACL
void	setPersonalSettings(Map<String,String> settings)	Set container personal settings
void	setSetting(String key, String value)	Set a container setting, only one key at a time
void	setSettings(Map<String,String> settings)	Set container settings
List<String>	subscribers()
void	update(ContainerModifiableDescriptor descriptor)	Update container descriptor

Method Details

setAccessControlList

@PUT
@Path("_acl")
void setAccessControlList(List<AccessControlEntry> entries)
                   throws ServerFault

store container ACL

Parameters:

entries - acl

Throws:

ServerFault

getAccessControlList

@GET
@Path("_acl")
List<AccessControlEntry> getAccessControlList()
                                       throws ServerFault

Retrieve container ACL

Returns:

List of access control entries

Throws:

ServerFault

getDescriptor

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

Retrieve container descriptor

Returns:

ContainerDescriptor

Throws:

ServerFault

update

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

Update container descriptor

Parameters:

descriptor -

Throws:

ServerFault

subscribers

@GET
@Path("_subscription")
List<String> subscribers()
                  throws ServerFault

Throws:

ServerFault

getAllItems

@GET
@Path("_list")
List<ItemDescriptor> getAllItems()
                          throws ServerFault

Get all container items

Returns:

ItemDescriptor list

Throws:

ServerFault

getFilteredItems

@GET
@Path("_filtered")
List<ItemDescriptor> getFilteredItems(ItemFlagFilter filter)
                               throws ServerFault

Get all container items matching the given filter

Returns:

ItemDescriptor list

Throws:

ServerFault

getItems

@POST
@Path("_mget")
List<ItemDescriptor> getItems(List<String> uids)
                       throws ServerFault

Get container items

Parameters:

uids -

Returns:

ItemDescriptor list

Throws:

ServerFault

setPersonalSettings

@PUT
@Path("_personalSettings")
void setPersonalSettings(Map<String,String> settings)
                  throws ServerFault

Set container personal settings

Parameters:

settings -

Throws:

ServerFault

setSettings

@PUT
@Path("_settings")
void setSettings(Map<String,String> settings)
          throws ServerFault

Set container settings

Parameters:

settings -

Throws:

ServerFault

setSetting

@PUT
@Path("_settings/{key}")
void setSetting(@PathParam("key")
 String key,
 String value)
         throws ServerFault

Set a container setting, only one key at a time

Parameters:

key - string: look ContainerSettingsKeys

value -

Throws:

ServerFault

getSettings

@GET
@Path("_settings")
Map<String,String> getSettings()
                        throws ServerFault

Get container settings

Throws:

ServerFault

allowOfflineSync

@PUT
@Path("{subject}/offlineSync")
void allowOfflineSync(@PathParam("subject")
 String subject)
               throws ServerFault

Throws:

ServerFault

disallowOfflineSync

@DELETE
@Path("{subject}/offlineSync")
void disallowOfflineSync(@PathParam("subject")
 String subject)
                  throws ServerFault

Throws:

ServerFault

canAccess

@POST
@Path("_canAccess")
@Deprecated(forRemoval=true)
boolean canAccess(List<String> verbsOrRoles)
           throws ServerFault

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

ServerFault

canAccessVerbs

@POST
@Path("_canAccessVerbs")
PermittedVerbs canAccessVerbs(List<String> verbsOrRoles)
                       throws ServerFault

Throws:

ServerFault

getItemCount

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

Throws:

ServerFault