com.cumulocity.sdk.client.cep

Interface CepApi

All Known Implementing Classes:

CepApiImpl

public interface CepApi

API for integration with Custom Event Processing modules from the platform.

Method Summary

Modifier and Type	Method and Description
CepModuleRepresentation	create(InputStream content) Deprecated.
CepModuleRepresentation	create(String content) Creates an cep module in the platform.
void	delete(CepModuleRepresentation module) Deletes the cep module from the platform.
void	delete(String id) Deletes the cep module from the platform.
CepModuleRepresentation	get(String id) Gets an cep module by id
CepCustomNotificationsSubscriber	getCustomNotificationsSubscriber() Gets the notifications subscriber, which allows to receive notifications sent from cep.
CepModuleCollection	getModules() Gets all cep modules from the platform
String	getText(String id) Gets a cep module text by id
<T> T	health(Class<T> clazz) Checks state of cep microservice.
CepModuleRepresentation	update(CepModuleRepresentation module)
CepModuleRepresentation	update(String id, InputStream content) Updates an cep module in the platform.
CepModuleRepresentation	update(String id, String content)

Method Detail

getCustomNotificationsSubscriber

CepCustomNotificationsSubscriber getCustomNotificationsSubscriber()

Gets the notifications subscriber, which allows to receive notifications sent from cep.

 
 Example:

  Subscriber<String, Object> subscriber = deviceControlApi.getNotificationsSubscriber();

  subscriber.subscribe( "channelId" , new SubscriptionListener<String, Object>() {

       @Override
      public void onNotification(Subscription<GId> subscription, Object operation) {
             //process notification from cep module
      }

       @Override
      public void onError(Subscription<GId> subscription, Throwable ex) {
          // handle subscribe error
      }
  });
  
  

Returns:

subscriber

Throws:

SDKException - when subscriber creation fail

get

CepModuleRepresentation get(String id)

Gets an cep module by id

Parameters:

id - of the cep module to search for

Returns:

the cep module with the given id

Throws:

SDKException - if the cep module is not found or if the query failed

getText

String getText(String id)

Gets a cep module text by id

Parameters:

id - of the cep module to search for

Returns:

the cep module text

Throws:

SDKException - if the cep module is not found or if the query failed

create

@Deprecated
CepModuleRepresentation create(InputStream content)

Deprecated.

Creates an cep module in the platform.

Parameters:

content - input stream to resource with cep module definition

Returns:

the created cep module with the generated id

Throws:

SDKException - if the cep module could not be created

create

CepModuleRepresentation create(String content)

Creates an cep module in the platform.

Parameters:

content - of cep module definition

Returns:

the created cep module with the generated id

Throws:

SDKException - if the cep module could not be created

update

CepModuleRepresentation update(String id,
                               InputStream content)

Updates an cep module in the platform. The cep module to be updated is identified by the id.

Parameters:

id - of cep module to update

content - input stream to resource with cep module definition

Returns:

the updated cep module

Throws:

SDKException - if the cep module could not be updated

update

CepModuleRepresentation update(String id,
                               String content)

update

CepModuleRepresentation update(CepModuleRepresentation module)

getModules

CepModuleCollection getModules()

Gets all cep modules from the platform

Returns:

collection of cep modules with paging functionality

Throws:

SDKException - if the query failed

delete

void delete(CepModuleRepresentation module)

Deletes the cep module from the platform.

Parameters:

module - cep module to delete

Throws:

SDKException - when delete of cep module fail

delete

void delete(String id)

Deletes the cep module from the platform.

Parameters:

id - identifier of cep module to delete

Throws:

SDKException - when delete of cep module fail

health

<T> T health(Class<T> clazz)

Checks state of cep microservice.

Type Parameters:

T - generic type of class result

Parameters:

clazz - expected class result

Returns:

the cep health status object