Package org.odpi.openmetadata.frameworkservices.gaf.client

Class EgeriaOpenGovernanceEventClient

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.events.OpenMetadataEventClient

org.odpi.openmetadata.frameworkservices.gaf.client.EgeriaOpenGovernanceEventClient

All Implemented Interfaces:

OpenMetadataEventInterface

public class EgeriaOpenGovernanceEventClient
extends OpenMetadataEventClient

EgeriaOpenMetadataEventClient provides the implementation to manage the interaction with the server to set up a listener to support the receipt of inbound events from the Open Metadata Store Out Topic.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.events.OpenMetadataEventClient

auditLog, callerId, localServerSecretStoreCollection, localServerSecretStoreLocation, localServerSecretStoreProvider, maxPageSize, serverName, serverPlatformURLRoot, userId

Constructor Summary

Constructors

Constructor	Description
EgeriaOpenGovernanceEventClient(String serverName, String serverPlatformURLRoot, String serverUserId, String secretsStoreProvider, String secretsStoreLocation, String secretsStoreCollection, int maxPageSize, AuditLog auditLog, String callerId)	Create a new client that is to be used within an OMAG Server.

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Shutdown the event listener.
void	registerListener(String userId, OpenMetadataEventListener listener)	Register a listener object that will be passed the events published by the Open Metadata Store.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.events.OpenMetadataEventClient

getConfigurationServerName

Methods inherited from class java.lang.Object

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

Constructor Details

EgeriaOpenGovernanceEventClient

public EgeriaOpenGovernanceEventClient(String serverName,
 String serverPlatformURLRoot,
 String serverUserId,
 String secretsStoreProvider,
 String secretsStoreLocation,
 String secretsStoreCollection,
 int maxPageSize,
 AuditLog auditLog,
 String callerId)
                                throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

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

serverUserId - this server's userId

secretsStoreProvider - secrets store connector for bearer token

secretsStoreLocation - secrets store location for bearer token

secretsStoreCollection - secrets store collection for bearer token

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

callerId - unique identifier of the caller

Throws:

InvalidParameterException - a problem with the information about the remote OMAS

Method Details

registerListener

public void registerListener(String userId,
 OpenMetadataEventListener listener)
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Register a listener object that will be passed the events published by the Open Metadata Store.

Specified by:

registerListener in interface OpenMetadataEventInterface

Specified by:

registerListener in class OpenMetadataEventClient

Parameters:

userId - calling user

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

disconnect

public void disconnect()

Shutdown the event listener.

Specified by:

disconnect in class OpenMetadataEventClient