Package net.bluemind.core.container.api

Interface IContainers

@Path("/containers/_manage")
public interface IContainers

Method Summary

Modifier and Type	Method	Description
List<ContainerDescriptor>	all(ContainerQuery query)
List<ContainerDescriptor>	allForUser(String domainUid, String userUid, ContainerQuery query)
List<BaseContainerDescriptor>	allLight(ContainerQuery query)
BaseContainerDescriptor	create(String uid, ContainerDescriptor descriptor)	Create a container
void	delete(String uid)	Delete a container
ContainerDescriptor	get(String uid)	Get a container
List<ContainerDescriptor>	getContainers(List<String> containerIds)	Get container
List<BaseContainerDescriptor>	getContainersLight(List<String> containerIds)	Get container
ContainerDescriptor	getForUser(String domainUid, String userUid, String uid)	Get a container as if it where requested by another user.
ContainerDescriptor	getIfPresent(String uid)	Get a container
BaseContainerDescriptor	getLight(String uid)
BaseContainerDescriptor	getLightIfPresent(String uid)
void	setAccessControlList(String uid, List<AccessControlEntry> entries)
void	update(String uid, ContainerModifiableDescriptor descriptor)	Update a container

Method Details

get

@GET
@Path("{uid}")
ContainerDescriptor get(@PathParam("uid")
 String uid)
                 throws ServerFault

Get a container

Parameters:

uid - the containers unique identifier

Returns:

non null description, throws if not found

Throws:

ServerFault - with ErrorCode.NOT_FOUND if the container does not exist

getLight

@GET
@Path("_light/{uid}")
BaseContainerDescriptor getLight(@PathParam("uid")
 String uid)
                          throws ServerFault

Throws:

ServerFault

getLightIfPresent

@GET
@Path("_ifPresentLight/{uid}")
BaseContainerDescriptor getLightIfPresent(@PathParam("uid")
 String uid)
                                   throws ServerFault

Throws:

ServerFault

getForUser

@GET
@Path("_forUser")
ContainerDescriptor getForUser(@QueryParam("domainUid")
 String domainUid,
 @QueryParam("userUid")
 String userUid,
 @QueryParam("uid")
 String uid)
                        throws ServerFault

Get a container as if it where requested by another user.

Parameters:

domainUid -

userUid -

uid -

Returns:

Throws:

ServerFault

getIfPresent

@GET
@Path("_ifPresent/{uid}")
ContainerDescriptor getIfPresent(@PathParam("uid")
 String uid)
                          throws ServerFault

Get a container

Parameters:

uid -

Returns:

Throws:

ServerFault

create

@PUT
@Path("{uid}")
BaseContainerDescriptor create(@PathParam("uid")
 String uid,
 ContainerDescriptor descriptor)
                        throws ServerFault

Create a container

Parameters:

uid -

descriptor -

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)
     throws ServerFault

Delete a container

Parameters:

uid -

Throws:

ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 ContainerModifiableDescriptor descriptor)
     throws ServerFault

Update a container

Parameters:

uid -

descriptor -

Throws:

ServerFault

all

@POST
@Path("_list")
List<ContainerDescriptor> all(ContainerQuery query)
                       throws ServerFault

Parameters:

containerQuery -

Returns:

List of all "readeable" containers for current User

Throws:

ServerFault

allLight

@POST
@Path("_listLight")
List<BaseContainerDescriptor> allLight(ContainerQuery query)
                                throws ServerFault

Throws:

ServerFault

allForUser

@POST
@Path("_listforuser")
List<ContainerDescriptor> allForUser(@QueryParam("domainUid")
 String domainUid,
 @QueryParam("userUid")
 String userUid,
 ContainerQuery query)
                              throws ServerFault

Parameters:

containerQuery -

Returns:

List of all "readeable" containers for current User

Throws:

ServerFault

getContainers

@POST
@Path("_mget")
List<ContainerDescriptor> getContainers(List<String> containerIds)
                                 throws ServerFault

Get container

Parameters:

containerIds -

Returns:

ContainerDescriptor list

Throws:

ServerFault

getContainersLight

@POST
@Path("_mgetLight")
List<BaseContainerDescriptor> getContainersLight(List<String> containerIds)
                                          throws ServerFault

Get container

Parameters:

containerIds -

Returns:

BaseContainerDescriptor list

Throws:

ServerFault

setAccessControlList

@POST
@Path("{uid}/_acl")
void setAccessControlList(@PathParam("uid")
 String uid,
 List<AccessControlEntry> entries)
                   throws ServerFault

Throws:

ServerFault