import java.util.Vector;
/**
- * @class ConsumerService
- * @brief This class provides a set of Java APIs for Notification Consumer.
- */
-public class ConsumerService
-{
+ *
+ * This class provides a set of Java APIs for Notification ConsumerService.
+ *
+ */
+public class ConsumerService {
+
private static final String LOG_TAG = "ConsumerService";
- static
- {
+ static {
System.loadLibrary("gnustl_shared");
System.loadLibrary("oc_logger");
System.loadLibrary("connectivity_abstraction");
System.loadLibrary("notification_consumer_jni");
}
- public enum Response
- {
- ALLOW(1),
- DENY(2),
- TOPIC(3);
- private int type;
-
- private Response(int type)
- {
- this.type = type;
- }
-
- public int getResponseType()
- {
- return this.type;
- }
- };
-
private static ConsumerService instance;
- static
- {
+ static {
instance = new ConsumerService();
}
- public static ConsumerService getInstance()
- {
+
+ /**
+ * API for getting instance of ConsumerService
+ *
+ * @return ConsumerService singleton instance created
+ */
+ public static ConsumerService getInstance() {
return instance;
}
- public void Start(
- OnProviderDiscoveredListner onProviderDiscoveredListner,
- OnProviderChangedListener onProviderChangedListener
- ) throws NSException
- {
- nativeStart(onProviderDiscoveredListner, onProviderChangedListener);
+ /**
+ * This API will Start ConsumerService
+ *
+ * @param onProviderDiscoveredListener
+ * OnProviderDiscoveredListener Callback Interface
+ *
+ * @throws NSException
+ * if the parameter passed is null
+ */
+ public void start(OnProviderDiscoveredListener onProviderDiscoveredListener)
+ throws NSException {
+ nativeStart(onProviderDiscoveredListener);
}
- public void Stop() throws NSException
- {
+ /**
+ * This API will Stop ConsumerService
+ */
+ public void stop() throws NSException {
nativeStop();
}
- public void EnableRemoteService(String serverAddress) throws NSException
- {
+ /**
+ * Request to publish resource to cloud server
+ *
+ * @param serverAddress
+ * serverAddress combined with IP address and port number using
+ * delimiter
+ */
+ public void enableRemoteService(String serverAddress) throws NSException {
nativeEnableRemoteService(serverAddress);
}
- public void RescanProvider() throws NSException
- {
- nativeRescanProvider();
- }
-
- public Provider GetProvider(String providerId) throws NSException
- {
- return nativeGetProvider(providerId);
+ /**
+ * Request to subscribe to MQ server
+ *
+ * @param servAdd
+ * servAdd combined with IP address and port number and MQ broker
+ * uri using delimiter
+ * @param topicName
+ * the interest Topic name for subscription
+ *
+ * @throws NSException failed to subscribe to MQ server
+ */
+ public void subscribeMQService(String servAdd, String topicName)
+ throws NSException {
+ nativeSubscribeMQService(servAdd, topicName);
}
- public Message GetMessage(long messageId) throws NSException
- {
- return nativeGetMessage(messageId);
+ /**
+ * This API is called to request discovery manually
+ */
+ public void rescanProvider() throws NSException {
+ nativeRescanProvider();
}
- public interface OnProviderDiscoveredListner
- {
+ /**
+ * Interface to implement callback function to receive provider on discovery
+ */
+ public interface OnProviderDiscoveredListener {
+
+ /**
+ * Callback function to receive provider on discovery
+ *
+ * @param provider
+ * Provider object
+ */
public void onProviderDiscovered(Provider provider);
}
- public interface OnProviderChangedListener
- {
- public void onProviderChanged(Provider provider , Response response);
- }
-
- private native void nativeStart (
- OnProviderDiscoveredListner onProviderDiscoveredListner,
- OnProviderChangedListener onProviderChangedListener
- ) throws NSException;
+ private native void nativeStart(
+ OnProviderDiscoveredListener onProviderDiscoveredListener)
+ throws NSException;
private native void nativeStop() throws NSException;
- private native void nativeEnableRemoteService(String serverAddress) throws NSException;
+
+ private native void nativeEnableRemoteService(String serverAddress)
+ throws NSException;
+
+ private native void nativeSubscribeMQService(String servAdd,
+ String topicName) throws NSException;
+
private native void nativeRescanProvider() throws NSException;
- private native Provider nativeGetProvider(String providerId) throws NSException;
- private native Message nativeGetMessage(long messageId) throws NSException;
}