Package com.cumulocity.sdk.client.messaging.notifications

Class NotificationSubscriptionApiImpl

java.lang.Object

com.cumulocity.sdk.client.messaging.notifications.NotificationSubscriptionApiImpl

All Implemented Interfaces:

NotificationSubscriptionApi

public class NotificationSubscriptionApiImpl
extends Object
implements NotificationSubscriptionApi

Field Summary

Fields

Modifier and Type	Field	Description
static final CumulocityMediaType	MEDIA_TYPE
static final String	SUBSCRIPTION_REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
NotificationSubscriptionApiImpl(RestConnector restConnector, UrlProcessor urlProcessor, int pageSize)

Method Summary

Modifier and Type	Method	Description
void	delete(NotificationSubscriptionRepresentation subscription)	Delete by object.
void	deleteByFilter(NotificationSubscriptionFilter filter)	Deletes all subscriptions matching a given filter.
void	deleteById(String subscriptionId)	Delete by ID.
void	deleteBySource(String source)	Deletes all subscriptions to a source in managed object context.
void	deleteTenantSubscriptions()	Deletes all subscriptions of the current tenant.
NotificationSubscriptionCollection	getSubscriptions()	Gets all the subscriptions.
NotificationSubscriptionCollection	getSubscriptionsByFilter(NotificationSubscriptionFilter filter)	Gets all the subscriptions matching a filter.
NotificationSubscriptionRepresentation	subscribe(NotificationSubscriptionRepresentation representation)	Creates a subscription to a source.

Methods inherited from class java.lang.Object

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

Field Details

MEDIA_TYPE

public static final CumulocityMediaType MEDIA_TYPE

SUBSCRIPTION_REQUEST_URI

public static final String SUBSCRIPTION_REQUEST_URI

See Also:

• Constant Field Values

Constructor Details

NotificationSubscriptionApiImpl

public NotificationSubscriptionApiImpl(RestConnector restConnector,
 UrlProcessor urlProcessor,
 int pageSize)

Method Details

subscribe

public NotificationSubscriptionRepresentation subscribe(NotificationSubscriptionRepresentation representation)
                                                 throws SDKException

Description copied from interface: NotificationSubscriptionApi

Creates a subscription to a source.

Specified by:

subscribe in interface NotificationSubscriptionApi

Parameters:

representation - initial values for subscription

Returns:

subscription populated with an id

Throws:

SDKException

getSubscriptions

public NotificationSubscriptionCollection getSubscriptions()
                                                    throws SDKException

Description copied from interface: NotificationSubscriptionApi

Gets all the subscriptions.

Specified by:

getSubscriptions in interface NotificationSubscriptionApi

Returns:

all the subscriptions

Throws:

SDKException

getSubscriptionsByFilter

public NotificationSubscriptionCollection getSubscriptionsByFilter(NotificationSubscriptionFilter filter)
                                                            throws SDKException

Description copied from interface: NotificationSubscriptionApi

Gets all the subscriptions matching a filter. If the filter is null, return all subscriptions.

Specified by:

getSubscriptionsByFilter in interface NotificationSubscriptionApi

Parameters:

filter - values to be matched on

Returns:

subscriptions matching values

Throws:

SDKException

delete

public void delete(NotificationSubscriptionRepresentation subscription)
            throws SDKException

Description copied from interface: NotificationSubscriptionApi

Delete by object.

Specified by:

delete in interface NotificationSubscriptionApi

Parameters:

subscription - to delete

Throws:

SDKException

deleteById

public void deleteById(String subscriptionId)

Description copied from interface: NotificationSubscriptionApi

Delete by ID.

Specified by:

deleteById in interface NotificationSubscriptionApi

Parameters:

subscriptionId - of subscription to delete

deleteByFilter

public void deleteByFilter(NotificationSubscriptionFilter filter)

Description copied from interface: NotificationSubscriptionApi

Deletes all subscriptions matching a given filter.

Specified by:

deleteByFilter in interface NotificationSubscriptionApi

Parameters:

filter - the filter criteria for deleting matching subscriptions

deleteBySource

public void deleteBySource(String source)

Description copied from interface: NotificationSubscriptionApi

Deletes all subscriptions to a source in managed object context.

Specified by:

deleteBySource in interface NotificationSubscriptionApi

deleteTenantSubscriptions

public void deleteTenantSubscriptions()

Description copied from interface: NotificationSubscriptionApi

Deletes all subscriptions of the current tenant.

Specified by:

deleteTenantSubscriptions in interface NotificationSubscriptionApi