Package org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceEngineEventClient

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineEventClient

public class GovernanceEngineEventClient
extends Object

GovernanceEngineConfigurationClient supports the configuration of governance engine and governance services.

Constructor Summary

Constructors

Constructor	Description
GovernanceEngineEventClient(String serverName, String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String callerId)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	registerListener(String userId, org.odpi.openmetadata.accessservices.governanceengine.api.GovernanceEngineEventListener listener)	Register a listener object that will be passed each of the events published by the Governance Engine OMAS.

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceEngineEventClient

public GovernanceEngineEventClient(String serverName,
 String serverPlatformURLRoot,
 GovernanceEngineRESTClient restClient,
 int maxPageSize,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog,
 String callerId)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.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 services

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

callerId - unique identifier for caller's listener

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

registerListener

public void registerListener(String userId,
 org.odpi.openmetadata.accessservices.governanceengine.api.GovernanceEngineEventListener listener)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Governance Engine OMAS.

Parameters:

userId - calling user

listener - listener object

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.