Package org.alfresco.rest.requests.syncServiceAPI

Class Subscriptions

java.lang.Object

org.alfresco.rest.requests.ModelRequest<RestPrivateAPI>

org.alfresco.rest.requests.syncServiceAPI.Subscriptions

public class Subscriptions
extends ModelRequest<RestPrivateAPI>

Declares all Rest API under the /subscribers//subscriptions/ path

Author:

Meenal Bhave

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Subscriptions.TYPE

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
Subscriptions(RestSubscriberModel subscriber, RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestSyncNodeSubscriptionModel	getSubscription(java.lang.String nodeSubscriptionId)	Get NODE Subscription using GET call on /subscribers/{deviceSubscriptionId}/subscriptions/{nodeSubscriptionId}
RestSyncNodeSubscriptionModelCollection	getSubscriptions()	Get NODE Subscription(s) using GET call on /subscribers/{deviceSubscriptionId}/subscriptions
RestSyncNodeSubscriptionModel	subscribeToNode(java.lang.String targetNodeId, Subscriptions.TYPE subscriberType)	Create Node Subscription for the specified target node using POST call on /subscribers/{deviceSubscriptionId}/subscriptions
RestSyncNodeSubscriptionModelCollection	subscribeToNodes(java.lang.String... targetNodeIds)	Create Node Subscriptions for multiple targets using POST call on /subscribers/{deviceSubscriptionId}/subscriptions

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Subscriptions

public Subscriptions(RestSubscriberModel subscriber,
                     RestWrapper restWrapper)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

subscribeToNodes

public RestSyncNodeSubscriptionModelCollection subscribeToNodes(java.lang.String... targetNodeIds)
                                                         throws java.lang.Exception

Create Node Subscriptions for multiple targets using POST call on /subscribers/{deviceSubscriptionId}/subscriptions

Parameters:

targetNodeIds - : one or more

Returns:

RestSyncNodeSubscriptionModel

Throws:

java.lang.Exception

subscribeToNode

public RestSyncNodeSubscriptionModel subscribeToNode(java.lang.String targetNodeId,
                                                     Subscriptions.TYPE subscriberType)

Create Node Subscription for the specified target node using POST call on /subscribers/{deviceSubscriptionId}/subscriptions

Parameters:

targetNodeId -

subscriberType -

Returns:

getSubscriptions

public RestSyncNodeSubscriptionModelCollection getSubscriptions()
                                                         throws java.lang.Exception

Get NODE Subscription(s) using GET call on /subscribers/{deviceSubscriptionId}/subscriptions

Returns:

RestSyncNodeSubscriptionModelCollection

Throws:

java.lang.Exception

getSubscription

public RestSyncNodeSubscriptionModel getSubscription(java.lang.String nodeSubscriptionId)
                                              throws java.lang.Exception

Get NODE Subscription using GET call on /subscribers/{deviceSubscriptionId}/subscriptions/{nodeSubscriptionId}

Returns:

RestSyncNodeSubscriptionModelCollection

Throws:

java.lang.Exception