Package org.odpi.openmetadata.accessservices.datamanager.client

Class EventBrokerClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.SchemaManagerClient

org.odpi.openmetadata.accessservices.datamanager.client.EventBrokerClient

All Implemented Interfaces:

EventBrokerInterface, SchemaManagerInterface

public class EventBrokerClient
extends SchemaManagerClient
implements EventBrokerInterface

EventBrokerClient is the client for managing topics from an Event Manager.

Constructor Summary

Constructors

Constructor	Description
EventBrokerClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
EventBrokerClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
EventBrokerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
EventBrokerClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
EventBrokerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

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 a event type.
String	createEventTypeFromTemplate(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.
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 type 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 type 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 the metadata element representing a 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 a 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.

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.SchemaManagerClient

clearCalculatedValue, clearQueryTargetRelationship, clearSchemaTypes, createEnumSchemaType, createLiteralSchemaType, createMapSchemaType, createPrimitiveSchemaType, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaTypeChoice, createSchemaTypeFromTemplate, createStructSchemaType, findSchemaAttributes, findSchemaType, findValidValueSet, getNestedAttributes, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, getValidValueSetByName, removeSchemaAttribute, removeSchemaType, setupCalculatedValue, setupQueryTargetRelationship, setupSchemaType, updateQueryTargetRelationship, updateSchemaAttribute, updateSchemaType

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBrokerClient

public EventBrokerClient(String serverName,
                         String serverPlatformURLRoot,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

EventBrokerClient

public EventBrokerClient(String serverName,
                         String serverPlatformURLRoot)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

EventBrokerClient

public EventBrokerClient(String serverName,
                         String serverPlatformURLRoot,
                         String userId,
                         String password,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

EventBrokerClient

public EventBrokerClient(String serverName,
                         String serverPlatformURLRoot,
                         DataManagerRESTClient restClient,
                         int maxPageSize,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

EventBrokerClient

public EventBrokerClient(String serverName,
                         String serverPlatformURLRoot,
                         String userId,
                         String password)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createTopic

public 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.

Specified by:

createTopic in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public 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.

Specified by:

createTopicFromTemplate in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public 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.

Specified by:

updateTopic in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public 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).

Specified by:

publishTopic in interface EventBrokerInterface

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

public 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).

Specified by:

withdrawTopic in interface EventBrokerInterface

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

public void removeTopic(String userId,
                        String eventBrokerGUID,
                        String eventBrokerName,
                        String topicGUID,
                        String qualifiedName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Remove the metadata element representing a topic.

Specified by:

removeTopic in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public 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.

Specified by:

findTopics in interface EventBrokerInterface

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

public 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.

Specified by:

getTopicsByName in interface EventBrokerInterface

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

public 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.

Specified by:

getTopicsForEventBroker in interface EventBrokerInterface

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

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

Retrieve the topic metadata element with the supplied unique identifier.

Specified by:

getTopicByGUID in interface EventBrokerInterface

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

public String createEventType(String userId,
                              String eventBrokerGUID,
                              String eventBrokerName,
                              String topicGUID,
                              EventTypeProperties properties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create a new metadata element to represent a event type.

Specified by:

createEventType in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

topicGUID - unique identifier of the topic where the event type is located

properties - properties about the event type

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)

createEventTypeFromTemplate

public 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 event type using an existing metadata element as a template.

Specified by:

createEventTypeFromTemplate in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public void updateEventType(String userId,
                            String eventBrokerGUID,
                            String eventBrokerName,
                            String eventTypeGUID,
                            boolean isMergeUpdate,
                            EventTypeProperties properties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update the metadata element representing a event type.

Specified by:

updateEventType in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

public void removeEventType(String userId,
                            String eventBrokerGUID,
                            String eventBrokerName,
                            String eventTypeGUID,
                            String qualifiedName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Remove the metadata element representing a event type.

Specified by:

removeEventType in interface EventBrokerInterface

Parameters:

userId - calling user

eventBrokerGUID - unique identifier of software server capability representing the event broker

eventBrokerName - unique name of software server capability representing the event broker

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

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

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

Specified by:

findEventTypes in interface EventBrokerInterface

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

public 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.

Specified by:

getEventTypesForEventSet in interface EventBrokerInterface

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

public 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.

Specified by:

getEventTypesForTopic in interface EventBrokerInterface

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

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

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

Specified by:

getEventTypesByName in interface EventBrokerInterface

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

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

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

Specified by:

getEventTypeByGUID in interface EventBrokerInterface

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)