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

Class GovernanceEngineRESTClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

org.odpi.openmetadata.commonservices.gaf.client.rest.OpenMetadataStoreRESTClient

org.odpi.openmetadata.accessservices.governanceengine.client.rest.GovernanceEngineRESTClient

public class GovernanceEngineRESTClient
extends OpenMetadataStoreRESTClient

GovernanceEngineRESTClient is responsible for issuing calls to the OMAS REST APIs.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
GovernanceEngineRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
GovernanceEngineRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
GovernanceEngineRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
GovernanceEngineRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
GovernanceActionElementResponse	callGovernanceActionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionElementResponse object.
GovernanceActionProcessElementsResponse	callGovernanceActionProcessElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceActionProcessElementsResponse object.
GovernanceActionProcessElementsResponse	callGovernanceActionProcessesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionProcessElementsResponse object.
GovernanceActionProcessElementResponse	callGovernanceActionProcessGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionProcessElementResponse object.
GovernanceActionElementsResponse	callGovernanceActionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionElementsResponse object.
GovernanceActionTypeElementsResponse	callGovernanceActionTypeElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceActionTypeElementsResponse object.
GovernanceActionTypeElementResponse	callGovernanceActionTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionTypeElementResponse object.
GovernanceActionTypeElementsResponse	callGovernanceActionTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionTypeElementsResponse object.
GovernanceEngineElementResponse	callGovernanceEngineGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineElementResponse object.
GovernanceEngineElementResponse	callGovernanceEnginePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceEngineElementResponse object.
GovernanceEngineElementsResponse	callGovernanceEnginesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineElementsResponse object.
GovernanceServiceElementResponse	callGovernanceServiceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceServiceElementResponse object.
GovernanceServiceElementsResponse	callGovernanceServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceServiceElementsResponse object.
NextGovernanceActionTypeElementsResponse	callNextGovernanceActionTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a NextGovernanceActionTypeElementsResponse object.
RegisteredGovernanceServiceResponse	callRegisteredGovernanceServiceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredGovernanceServiceResponse object.
RegisteredGovernanceServicesResponse	callRegisteredGovernanceServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredGovernanceServicesResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.gaf.client.rest.OpenMetadataStoreRESTClient

callBooleanGetRESTCall, callElementHeaderPostRESTCall, callElementHeadersPostRESTCall, callOpenMetadataElementGetRESTCall, callOpenMetadataElementPostRESTCall, callOpenMetadataElementsPostRESTCall, callRelatedMetadataElementListGetRESTCall, callRelatedMetadataElementListPostRESTCall, callRelatedMetadataElementsListGetRESTCall, callRelatedMetadataElementsListPostRESTCall, callTranslationDetailGetRESTCall, callTranslationListGetRESTCall, callValidMetadataValueGetRESTCall, callValidMetadataValueListGetRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngineRESTClient

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

Constructor for no authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.

auditLog - destination for log messages.

Throws:

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

GovernanceEngineRESTClient

public GovernanceEngineRESTClient(String serverName,
                                  String serverPlatformURLRoot)
                           throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.

Throws:

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

GovernanceEngineRESTClient

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

Constructor for simple userId and password authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

auditLog - destination for log messages.

Throws:

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

GovernanceEngineRESTClient

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

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

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

Method Detail

callGovernanceEngineGetRESTCall

public GovernanceEngineElementResponse callGovernanceEngineGetRESTCall(String methodName,
                                                                       String urlTemplate,
                                                                       Object... params)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException

Issue a GET REST call that returns a GovernanceEngineElementResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL for the REST API call with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceEnginePostRESTCall

public GovernanceEngineElementResponse callGovernanceEnginePostRESTCall(String methodName,
                                                                        String urlTemplate,
                                                                        Object requestBody,
                                                                        Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

Issue a POST REST call that returns a GovernanceEngineElementResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL for the REST API call with place-holders for the parameters

requestBody - object that passes additional parameters

params - a list of parameters that are slotted into the url template

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceEnginesGetRESTCall

public GovernanceEngineElementsResponse callGovernanceEnginesGetRESTCall(String methodName,
                                                                         String urlTemplate,
                                                                         Object... params)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException

Issue a GET REST call that returns a GovernanceEngineElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceServiceGetRESTCall

public GovernanceServiceElementResponse callGovernanceServiceGetRESTCall(String methodName,
                                                                         String urlTemplate,
                                                                         Object... params)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException

Issue a GET REST call that returns a GovernanceServiceElementResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceServicesGetRESTCall

public GovernanceServiceElementsResponse callGovernanceServicesGetRESTCall(String methodName,
                                                                           String urlTemplate,
                                                                           Object... params)
                                                                    throws InvalidParameterException,
                                                                           UserNotAuthorizedException,
                                                                           PropertyServerException

Issue a GET REST call that returns a GovernanceServiceElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRegisteredGovernanceServiceGetRESTCall

public RegisteredGovernanceServiceResponse callRegisteredGovernanceServiceGetRESTCall(String methodName,
                                                                                      String urlTemplate,
                                                                                      Object... params)
                                                                               throws InvalidParameterException,
                                                                                      UserNotAuthorizedException,
                                                                                      PropertyServerException

Issue a GET REST call that returns a RegisteredGovernanceServiceResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRegisteredGovernanceServicesGetRESTCall

public RegisteredGovernanceServicesResponse callRegisteredGovernanceServicesGetRESTCall(String methodName,
                                                                                        String urlTemplate,
                                                                                        Object... params)
                                                                                 throws InvalidParameterException,
                                                                                        UserNotAuthorizedException,
                                                                                        PropertyServerException

Issue a GET REST call that returns a RegisteredGovernanceServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionGetRESTCall

public GovernanceActionElementResponse callGovernanceActionGetRESTCall(String methodName,
                                                                       String urlTemplate,
                                                                       Object... params)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException

Issue a GET REST call that returns a GovernanceActionElementResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionsGetRESTCall

public GovernanceActionElementsResponse callGovernanceActionsGetRESTCall(String methodName,
                                                                         String urlTemplate,
                                                                         Object... params)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException

Issue a GET REST call that returns a GovernanceActionElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionTypeGetRESTCall

public GovernanceActionTypeElementResponse callGovernanceActionTypeGetRESTCall(String methodName,
                                                                               String urlTemplate,
                                                                               Object... params)
                                                                        throws InvalidParameterException,
                                                                               UserNotAuthorizedException,
                                                                               PropertyServerException

Issue a GET REST call that returns a GovernanceActionTypeElementResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionTypesGetRESTCall

public GovernanceActionTypeElementsResponse callGovernanceActionTypesGetRESTCall(String methodName,
                                                                                 String urlTemplate,
                                                                                 Object... params)
                                                                          throws InvalidParameterException,
                                                                                 UserNotAuthorizedException,
                                                                                 PropertyServerException

Issue a GET REST call that returns a GovernanceActionTypeElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionTypeElementsPostRESTCall

public GovernanceActionTypeElementsResponse callGovernanceActionTypeElementsPostRESTCall(String methodName,
                                                                                         String urlTemplate,
                                                                                         Object requestBody,
                                                                                         Object... params)
                                                                                  throws InvalidParameterException,
                                                                                         UserNotAuthorizedException,
                                                                                         PropertyServerException

Issue a POST REST call that returns a GovernanceActionTypeElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

requestBody - object that passes additional parameters

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callNextGovernanceActionTypesGetRESTCall

public NextGovernanceActionTypeElementsResponse callNextGovernanceActionTypesGetRESTCall(String methodName,
                                                                                         String urlTemplate,
                                                                                         Object... params)
                                                                                  throws InvalidParameterException,
                                                                                         UserNotAuthorizedException,
                                                                                         PropertyServerException

Issue a GET REST call that returns a NextGovernanceActionTypeElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionProcessGetRESTCall

public GovernanceActionProcessElementResponse callGovernanceActionProcessGetRESTCall(String methodName,
                                                                                     String urlTemplate,
                                                                                     Object... params)
                                                                              throws InvalidParameterException,
                                                                                     UserNotAuthorizedException,
                                                                                     PropertyServerException

Issue a GET REST call that returns a GovernanceActionProcessElementResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionProcessesGetRESTCall

public GovernanceActionProcessElementsResponse callGovernanceActionProcessesGetRESTCall(String methodName,
                                                                                        String urlTemplate,
                                                                                        Object... params)
                                                                                 throws InvalidParameterException,
                                                                                        UserNotAuthorizedException,
                                                                                        PropertyServerException

Issue a GET REST call that returns a GovernanceActionProcessElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceActionProcessElementsPostRESTCall

public GovernanceActionProcessElementsResponse callGovernanceActionProcessElementsPostRESTCall(String methodName,
                                                                                               String urlTemplate,
                                                                                               Object requestBody,
                                                                                               Object... params)
                                                                                        throws InvalidParameterException,
                                                                                               UserNotAuthorizedException,
                                                                                               PropertyServerException

Issue a POST REST call that returns a GovernanceActionProcessElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

requestBody - object that passes additional parameters

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.