Package org.odpi.openmetadata.accessservices.datamanager.api

Interface EventBrokerInterface

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

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

Method Detail

createTopic

String createTopic(String userId,
                   String eventBrokerGUID,
                   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

String createTopicFromTemplate(String userId,
                               String eventBrokerGUID,
                               String eventBrokerName,
                               boolean eventBrokerIsHome,
                               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(String userId,
                 String eventBrokerGUID,
                 String eventBrokerName,
                 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)

publishTopic

void publishTopic(String userId,
                  String topicGUID)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Update the zones for the topic asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

userId - calling user

topicGUID - unique identifier of the metadata element to publish

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(String userId,
                   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(String userId,
                 String eventBrokerGUID,
                 String eventBrokerName,
                 String topicGUID,
                 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)

findTopics

List<TopicElement> findTopics(String userId,
                              String searchString,
                              int startFrom,
                              int pageSize)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Retrieve the list of topic metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

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)

getTopicsByName

List<TopicElement> getTopicsByName(String userId,
                                   String name,
                                   int startFrom,
                                   int pageSize)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve the list of topic metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

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)

getTopicsForEventBroker

List<TopicElement> getTopicsForEventBroker(String userId,
                                           String eventBrokerGUID,
                                           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)

getTopicByGUID

TopicElement getTopicByGUID(String userId,
                            String guid)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Retrieve the topic metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching 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)

createEventType

String createEventType(String userId,
                       String eventBrokerGUID,
                       String eventBrokerName,
                       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

String createEventTypeFromTemplate(String userId,
                                   String eventBrokerGUID,
                                   String eventBrokerName,
                                   String templateGUID,
                                   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(String userId,
                     String eventBrokerGUID,
                     String eventBrokerName,
                     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(String userId,
                     String eventBrokerGUID,
                     String eventBrokerName,
                     String eventTypeGUID,
                     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)

findEventTypes

List<EventTypeElement> findEventTypes(String userId,
                                      String searchString,
                                      int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the list of event types metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

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)

getEventTypesForEventSet

List<EventTypeElement> getEventTypesForEventSet(String userId,
                                                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)

getEventTypesForTopic

List<EventTypeElement> getEventTypesForTopic(String userId,
                                             String topicGUID,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Return the list of event types associated with a topic.

Parameters:

userId - calling user

topicGUID - 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 topic

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)

getEventTypesByName

List<EventTypeElement> getEventTypesByName(String userId,
                                           String name,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Retrieve the list of event types metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

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)

getEventTypeByGUID

EventTypeElement getEventTypeByGUID(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the event type metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested 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)