Interface EventBrokerInterface

  • All Known Implementing Classes:
    EventBrokerClient

    public interface EventBrokerInterface
    EventBrokerInterface defines the client side interface for the Data Manager OMAS that is relevant for topic assets that provide event-based services. It provides the ability to define and maintain the metadata about a topic and the schemas (event payloads) it contains.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createEventType​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String topicGUID, EventTypeProperties properties)
      Create a new metadata element to represent an event type.
      java.lang.String createEventTypeFromTemplate​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String templateGUID, java.lang.String topicGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a an event type using an existing event type as a template.
      java.lang.String createTopic​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, boolean eventBrokerIsHome, TopicProperties topicProperties)
      Create a new metadata element to represent a topic.
      java.lang.String createTopicFromTemplate​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, boolean eventBrokerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a topic using an existing metadata element as a template.
      java.util.List<EventTypeElement> findEventTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of event types metadata elements that contain the search string.
      java.util.List<TopicElement> findTopics​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of topic metadata elements that contain the search string.
      EventTypeElement getEventTypeByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the event type metadata element with the supplied unique identifier.
      java.util.List<EventTypeElement> getEventTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of event types metadata elements with a matching qualified or display name.
      java.util.List<EventTypeElement> getEventTypesForEventSet​(java.lang.String userId, java.lang.String eventSetGUID, int startFrom, int pageSize)
      Return the list of event types associated with an EventSet.
      java.util.List<EventTypeElement> getEventTypesForTopic​(java.lang.String userId, java.lang.String topicGUID, int startFrom, int pageSize)
      Return the list of event types associated with a topic.
      TopicElement getTopicByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the topic metadata element with the supplied unique identifier.
      java.util.List<TopicElement> getTopicsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of topic metadata elements with a matching qualified or display name.
      java.util.List<TopicElement> getTopicsForEventBroker​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, int startFrom, int pageSize)
      Retrieve the list of topics created by this caller.
      void publishTopic​(java.lang.String userId, java.lang.String topicGUID)
      Update the zones for the topic asset so that it becomes visible to consumers.
      void removeEventType​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String eventTypeGUID, java.lang.String qualifiedName)
      Remove an event type.
      void removeTopic​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String topicGUID, java.lang.String qualifiedName)
      Remove the metadata element representing a topic.
      void updateEventType​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String eventTypeGUID, boolean isMergeUpdate, EventTypeProperties properties)
      Update the metadata element representing an event type.
      void updateTopic​(java.lang.String userId, java.lang.String eventBrokerGUID, java.lang.String eventBrokerName, java.lang.String topicGUID, boolean isMergeUpdate, TopicProperties topicProperties)
      Update the metadata element representing a topic.
      void withdrawTopic​(java.lang.String userId, java.lang.String topicGUID)
      Update the zones for the topic asset so that it is no longer visible to consumers.
    • Method Detail

      • createTopic

        java.lang.String createTopic​(java.lang.String userId,
                                     java.lang.String eventBrokerGUID,
                                     java.lang.String eventBrokerName,
                                     boolean eventBrokerIsHome,
                                     TopicProperties topicProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Create a new metadata element to represent a topic.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        eventBrokerIsHome - should the topic be marked as owned by the event broker so others can not update?
        topicProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createTopicFromTemplate

        java.lang.String createTopicFromTemplate​(java.lang.String userId,
                                                 java.lang.String eventBrokerGUID,
                                                 java.lang.String eventBrokerName,
                                                 boolean eventBrokerIsHome,
                                                 java.lang.String templateGUID,
                                                 TemplateProperties templateProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create a new metadata element to represent a topic using an existing metadata element as a template.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        eventBrokerIsHome - should the topic be marked as owned by the event broker so others can not update?
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateTopic

        void updateTopic​(java.lang.String userId,
                         java.lang.String eventBrokerGUID,
                         java.lang.String eventBrokerName,
                         java.lang.String topicGUID,
                         boolean isMergeUpdate,
                         TopicProperties topicProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
        Update the metadata element representing a topic.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        topicGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        topicProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • withdrawTopic

        void withdrawTopic​(java.lang.String userId,
                           java.lang.String topicGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Update the zones for the topic asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the topic is first created).
        Parameters:
        userId - calling user
        topicGUID - unique identifier of the metadata element to withdraw
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeTopic

        void removeTopic​(java.lang.String userId,
                         java.lang.String eventBrokerGUID,
                         java.lang.String eventBrokerName,
                         java.lang.String topicGUID,
                         java.lang.String qualifiedName)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
        Remove the metadata element representing a topic.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        topicGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getTopicsForEventBroker

        java.util.List<TopicElement> getTopicsForEventBroker​(java.lang.String userId,
                                                             java.lang.String eventBrokerGUID,
                                                             java.lang.String eventBrokerName,
                                                             int startFrom,
                                                             int pageSize)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the list of topics created by this caller.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the topic manager (event broker)
        eventBrokerName - unique name of software server capability representing the topic manager (event broker)
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createEventType

        java.lang.String createEventType​(java.lang.String userId,
                                         java.lang.String eventBrokerGUID,
                                         java.lang.String eventBrokerName,
                                         java.lang.String topicGUID,
                                         EventTypeProperties properties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Create a new metadata element to represent an event type. This describes the structure of an event supported by the topic. The structure of this event type is added using SchemaAttributes. These SchemaAttributes can have a simple type or a nested structure.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        topicGUID - unique identifier of a topic
        properties - properties about the topic schema
        Returns:
        unique identifier of the new topic schema
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createEventTypeFromTemplate

        java.lang.String createEventTypeFromTemplate​(java.lang.String userId,
                                                     java.lang.String eventBrokerGUID,
                                                     java.lang.String eventBrokerName,
                                                     java.lang.String templateGUID,
                                                     java.lang.String topicGUID,
                                                     TemplateProperties templateProperties)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
        Create a new metadata element to represent a an event type using an existing event type as a template.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        topicGUID - unique identifier of the topic where the event type is located
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new event type
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateEventType

        void updateEventType​(java.lang.String userId,
                             java.lang.String eventBrokerGUID,
                             java.lang.String eventBrokerName,
                             java.lang.String eventTypeGUID,
                             boolean isMergeUpdate,
                             EventTypeProperties properties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Update the metadata element representing an event type.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        eventTypeGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        properties - new properties for the metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeEventType

        void removeEventType​(java.lang.String userId,
                             java.lang.String eventBrokerGUID,
                             java.lang.String eventBrokerName,
                             java.lang.String eventTypeGUID,
                             java.lang.String qualifiedName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Remove an event type.
        Parameters:
        userId - calling user
        eventBrokerGUID - unique identifier of software server capability representing the caller
        eventBrokerName - unique name of software server capability representing the caller
        eventTypeGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getEventTypesForEventSet

        java.util.List<EventTypeElement> getEventTypesForEventSet​(java.lang.String userId,
                                                                  java.lang.String eventSetGUID,
                                                                  int startFrom,
                                                                  int pageSize)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Return the list of event types associated with an EventSet. This is a collection of EventType definitions. These event types can be used as a template for adding the event types to a topic.
        Parameters:
        userId - calling user
        eventSetGUID - unique identifier of the topic to query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of metadata elements describing the event types associated with the requested EventSet
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)