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

Class EgeriaOpenGovernanceClient

java.lang.Object

org.odpi.openmetadata.frameworks.opengovernance.client.OpenGovernanceClient

org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase

org.odpi.openmetadata.frameworkservices.gaf.client.EgeriaOpenGovernanceClient

All Implemented Interfaces:

ActionControlInterface, GovernanceActionProcessInterface

public class EgeriaOpenGovernanceClient
extends OpenGovernanceClientBase

EgeriaOpenGovernanceClient provides an interface to the services that build, monitor and trigger governance actions. This is part of the Open Governance Framework (OGF).

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase

invalidParameterHandler, nullRequestBody, restClient

Fields inherited from class org.odpi.openmetadata.frameworks.opengovernance.client.OpenGovernanceClient

propertyHelper, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
EgeriaOpenGovernanceClient(String serverName, String serverPlatformURLRoot, String localServerSecretsStoreProvider, String localServerSecretsStoreLocation, String localServerSecretsStoreCollection, int maxPageSize, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase

cancelEngineAction, getActiveEngineActions, getEngineAction, getGovernanceActionProcessGraph, initiateEngineAction, initiateGovernanceActionProcess, initiateGovernanceActionType

Methods inherited from class org.odpi.openmetadata.frameworks.opengovernance.client.OpenGovernanceClient

toString

Methods inherited from class java.lang.Object

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

Constructor Details

EgeriaOpenGovernanceClient

public EgeriaOpenGovernanceClient(String serverName,
 String serverPlatformURLRoot,
 String localServerSecretsStoreProvider,
 String localServerSecretsStoreLocation,
 String localServerSecretsStoreCollection,
 int maxPageSize,
 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 services

localServerSecretsStoreProvider - secrets store connector for bearer token

localServerSecretsStoreLocation - secrets store location for bearer token

localServerSecretsStoreCollection - secrets store collection for bearer token

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

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