org.odpi.openmetadata.accessservices.datamanager.server

Class EventBrokerRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.server.EventBrokerRESTServices

public class EventBrokerRESTServices
extends Object

EventBrokerRESTServices is the server-side implementation of the Data Manager OMAS's support for relational topics. It matches the EventBrokerClient.

Constructor Summary

Constructors

Constructor and Description
EventBrokerRESTServices() Default constructor

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventBrokerRESTServices

public EventBrokerRESTServices()

Default constructor

Method Detail

createTopic

public GUIDResponse createTopic(String serverName,
                                String userId,
                                String eventBrokerGUID,
                                String eventBrokerName,
                                TopicProperties topicProperties)

Create a new metadata element to represent a topic.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

topicProperties - properties to store

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createTopicFromTemplate

public GUIDResponse createTopicFromTemplate(String serverName,
                                            String userId,
                                            String eventBrokerGUID,
                                            String eventBrokerName,
                                            String templateGUID,
                                            TemplateProperties templateProperties)

Create a new metadata element to represent a topic using an existing metadata element as a template.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

updateTopic

public VoidResponse updateTopic(String serverName,
                                String userId,
                                String eventBrokerGUID,
                                String eventBrokerName,
                                String topicGUID,
                                boolean isMergeUpdate,
                                TopicProperties topicProperties)

Update the metadata element representing a topic.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

topicGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with the existing properties of overlay them?

topicProperties - new properties for this element

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

publishTopic

public VoidResponse publishTopic(String serverName,
                                 String userId,
                                 String topicGUID,
                                 NullRequestBody nullRequestBody)

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:

serverName - name of the service to route the request to.

userId - calling user

topicGUID - unique identifier of the metadata element to publish

nullRequestBody - empty request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

withdrawTopic

public VoidResponse withdrawTopic(String serverName,
                                  String userId,
                                  String topicGUID,
                                  NullRequestBody nullRequestBody)

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:

serverName - name of the service to route the request to.

userId - calling user

topicGUID - unique identifier of the metadata element to withdraw

nullRequestBody - empty request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

removeTopic

public VoidResponse removeTopic(String serverName,
                                String userId,
                                String eventBrokerGUID,
                                String eventBrokerName,
                                String topicGUID,
                                String qualifiedName,
                                NullRequestBody nullRequestBody)

Remove the metadata element representing a topic.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

topicGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

nullRequestBody - empty request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

findTopics

public TopicsResponse findTopics(String serverName,
                                 String userId,
                                 String searchString,
                                 int startFrom,
                                 int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

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 or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getTopicsByName

public TopicsResponse getTopicsByName(String serverName,
                                      String userId,
                                      String name,
                                      int startFrom,
                                      int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

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 or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getTopicsForEventBroker

public TopicsResponse getTopicsForEventBroker(String serverName,
                                              String userId,
                                              String eventBrokerGUID,
                                              String eventBrokerName,
                                              int startFrom,
                                              int pageSize)

Retrieve the list of topics created by this caller.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getTopicByGUID

public TopicResponse getTopicByGUID(String serverName,
                                    String userId,
                                    String guid)

Retrieve the topic metadata element with the supplied unique identifier.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createEventType

public GUIDResponse createEventType(String serverName,
                                    String userId,
                                    String eventBrokerGUID,
                                    String eventBrokerName,
                                    String topicGUID,
                                    EventTypeProperties eventTypeProperties)

Create a new metadata element to represent a event type.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

topicGUID - unique identifier of the topic where the schema is located

eventTypeProperties - properties about the event type

Returns:

unique identifier of the new event type or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createEventTypeFromTemplate

public GUIDResponse createEventTypeFromTemplate(String serverName,
                                                String userId,
                                                String eventBrokerGUID,
                                                String eventBrokerName,
                                                String templateGUID,
                                                String topicGUID,
                                                TemplateProperties templateProperties)

Create a new metadata element to represent a event type using an existing metadata element as a template.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

templateGUID - unique identifier of the metadata element to copy

topicGUID - unique identifier of the topic where the schema is located

templateProperties - properties that override the template

Returns:

unique identifier of the new event type or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

updateEventType

public VoidResponse updateEventType(String serverName,
                                    String userId,
                                    String eventBrokerGUID,
                                    String eventBrokerName,
                                    String eventTypeGUID,
                                    boolean isMergeUpdate,
                                    EventTypeProperties eventTypeProperties)

Update the metadata element representing a event type.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

eventTypeGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

eventTypeProperties - new properties for the metadata element

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

removeEventType

public VoidResponse removeEventType(String serverName,
                                    String userId,
                                    String eventBrokerGUID,
                                    String eventBrokerName,
                                    String eventTypeGUID,
                                    String qualifiedName,
                                    NullRequestBody nullRequestBody)

Remove the metadata element representing a event type.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the DBMS

eventBrokerName - unique name of software server capability representing the DBMS

eventTypeGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

nullRequestBody - empty request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

findEventTypes

public EventTypesResponse findEventTypes(String serverName,
                                         String userId,
                                         String searchString,
                                         int startFrom,
                                         int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

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 or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEventTypesForEventSet

public EventTypesResponse getEventTypesForEventSet(String serverName,
                                                   String userId,
                                                   String topicGUID,
                                                   int startFrom,
                                                   int pageSize)

Return the list of event types associated with a EventType Set.

Parameters:

serverName - name of the service to route the request to.

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 schemas associated with the requested topic or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEventTypesForTopic

public EventTypesResponse getEventTypesForTopic(String serverName,
                                                String userId,
                                                String topicGUID,
                                                int startFrom,
                                                int pageSize)

Return the list of schemas associated with a topic.

Parameters:

serverName - name of the service to route the request to.

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 schemas associated with the requested topic or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEventTypesByName

public EventTypesResponse getEventTypesByName(String serverName,
                                              String userId,
                                              String name,
                                              int startFrom,
                                              int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

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 or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEventTypeByGUID

public EventTypeResponse getEventTypeByGUID(String serverName,
                                            String userId,
                                            String guid)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)