Package org.wso2.carbon.registry.admin.api.jmx

# Interface ISubscriptionsService

public interface ISubscriptionsService
API methods for performing subscription operations.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String[]`
  `getEventNames()`
  Retrieves list of event names.
  `String[]`
  `getList()`
  Retrieves list of subscriptions.
  `String`
  `subscribe(String endpoint, boolean isRestEndpoint, String path, String eventName)`
  Creates a new subscription.
  `void`
  `unsubscribe(String id)`
  Unsubscribes a user from the system.

- ## Method Details

  - ### subscribe

    String subscribe(String endpoint, boolean isRestEndpoint, String path, String eventName)
    Creates a new subscription.
    Parameters:
      `endpoint` - The endpoint to subscribe to.
      `isRestEndpoint` - Whether the endpoint is a REST endpoint.
      `path` - The resource path.
      `eventName` - The event name.
    Returns:
      the subscription identifier.

  - ### unsubscribe

    void unsubscribe(String id)
    Unsubscribes a user from the system.
    Parameters:
      `id` - the subscription identifier

  - ### getEventNames

    String[] getEventNames()
    Retrieves list of event names.
    Returns:
      list of event names.

  - ### getList

    String[] getList()
    Retrieves list of subscriptions.
    Returns:
      The list of subscriptions.