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, DuplicateManagementInterface, GovernanceActionProcessInterface, GovernanceActionTypeInterface

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 Survey Framework (OGF).

Field Summary

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

invalidParameterHandler, nullRequestBody

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

propertyHelper, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
EgeriaOpenGovernanceClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
EgeriaOpenGovernanceClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize)	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, createGovernanceActionProcess, createGovernanceActionProcessStep, createGovernanceActionType, findEngineActions, findGovernanceActionProcesses, findGovernanceActionProcessSteps, findGovernanceActionTypes, getActiveEngineActions, getEngineAction, getEngineActions, getEngineActionsByName, getFirstActionProcessStep, getGovernanceActionProcessByGUID, getGovernanceActionProcessesByName, getGovernanceActionProcessGraph, getGovernanceActionProcessStepByGUID, getGovernanceActionProcessStepsByName, getGovernanceActionTypeByGUID, getGovernanceActionTypesByName, getNextGovernanceActionProcessSteps, initiateEngineAction, initiateGovernanceActionProcess, initiateGovernanceActionType, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, publishGovernanceActionProcess, removeFirstActionProcessStep, removeGovernanceActionProcess, removeGovernanceActionProcessStep, removeGovernanceActionType, removeNextActionProcessStep, setupFirstActionProcessStep, setupNextActionProcessStep, updateGovernanceActionProcess, updateGovernanceActionProcessStep, updateGovernanceActionType, updateNextActionProcessStep, withdrawGovernanceActionProcess

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,
 int maxPageSize)
                           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 services

maxPageSize - pre-initialized parameter limit

Throws:

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

EgeriaOpenGovernanceClient

public EgeriaOpenGovernanceClient(String serverName,
 String serverPlatformURLRoot,
 String serverUserId,
 String serverPassword,
 int maxPageSize)
                           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

serverUserId - caller's userId embedded in all HTTP requests

serverPassword - caller's password embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

Throws:

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