Package net.bluemind.user.api

Interface IUserSubscription

All Known Subinterfaces:

IInternalUserSubscription

@Path("/users/{domainUid}/subscriptions")
public interface IUserSubscription

Method Summary

Modifier and Type	Method	Description
List<ContainerSubscriptionDescriptor>	listSubscriptions(String subject, String type)	List subscribed containers
void	subscribe(String subject, List<ContainerSubscription> subscriptions)	Subscribe current User to a list of containers
List<String>	subscribers(String containerUid)	Returns of list of subscribers to a given container
void	unsubscribe(String subject, List<String> containers)	Unsubscribe current User from a list of containers
void	updateAutomount(String subject, List<ContainerSubscription> subscriptions)

Method Details

listSubscriptions

@GET
@Path("{subject}")
List<ContainerSubscriptionDescriptor> listSubscriptions(@PathParam("subject")
 String subject,
 @QueryParam("type")
 String type)
                                                 throws ServerFault

List subscribed containers

Parameters:

subject -

type -

Returns:

Throws:

ServerFault

subscribers

@GET
@Path("_subscribers/{containerUid}")
List<String> subscribers(@PathParam("containerUid")
 String containerUid)

Returns of list of subscribers to a given container

Parameters:

containerUid -

Returns:

list of subscribers uid (as in BaseDirEntry.entryUid)

subscribe

@POST
@Path("{subject}/_subscribe")
void subscribe(@PathParam("subject")
 String subject,
 List<ContainerSubscription> subscriptions)
        throws ServerFault

Subscribe current User to a list of containers

Parameters:

subject -

containers -

Throws:

ServerFault

unsubscribe

@POST
@Path("{subject}/_unsubscribe")
void unsubscribe(@PathParam("subject")
 String subject,
 List<String> containers)
          throws ServerFault

Unsubscribe current User from a list of containers

Parameters:

subject -

containers -

Throws:

ServerFault

updateAutomount

@POST
@Path("{subject}/_automount")
void updateAutomount(@PathParam("subject")
 String subject,
 List<ContainerSubscription> subscriptions)