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

Class GAFRESTClient

java.lang.Object

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

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

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

org.odpi.openmetadata.frameworkservices.gaf.client.rest.GAFRESTClient

public class GAFRESTClient
extends OCFRESTClient

GAFRESTClient 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
GAFRESTClient(String serverName, String serverPlatformURLRoot, String localServerSecretsStoreProvider, String localServerSecretsStoreLocation, String localServerSecretsStoreCollection, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
BooleanResponse	callBooleanGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a BooleanResponse object.
EngineActionElementResponse	callEngineActionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineActionElementResponse object.
EngineActionElementsResponse	callEngineActionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineActionElementsResponse object.
EngineActionElementsResponse	callEngineActionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EngineActionElementsResponse object.
GovernanceActionProcessGraphResponse	callGovernanceActionProcessGraphPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a GovernanceActionProcessGraphResponse object.
GovernanceEngineElementResponse	callGovernanceEnginePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceEngineElementResponse object.
IntegrationGroupElementResponse	callIntegrationGroupGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationGroupElementResponse 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.
RegisteredIntegrationConnectorResponse	callRegisteredIntegrationConnectorGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredIntegrationConnectorResponse object.
RegisteredIntegrationConnectorsResponse	callRegisteredIntegrationConnectorsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredIntegrationConnectorsResponse object.

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

callOCFConnectionGetRESTCall

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

callElementHeadersPostRESTCall, callGUIDListGetRESTCall, callGUIDPostRESTCall, callOCFConnectorReportGetRESTCall, 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 Details

GAFRESTClient

public GAFRESTClient(String serverName,
 String serverPlatformURLRoot,
 String localServerSecretsStoreProvider,
 String localServerSecretsStoreLocation,
 String localServerSecretsStoreCollection,
 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.

Method Details

callBooleanGetRESTCall

public BooleanResponse callBooleanGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a BooleanResponse object.

Overrides:

callBooleanGetRESTCall in class FFDCRESTClient

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.

callEngineActionGetRESTCall

public EngineActionElementResponse callEngineActionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EngineActionElementResponse 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.

callEngineActionsGetRESTCall

public EngineActionElementsResponse callEngineActionsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EngineActionElementsResponse 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.

callEngineActionsPostRESTCall

public EngineActionElementsResponse callEngineActionsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a EngineActionElementsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callGovernanceActionProcessGraphPostRESTCall

public GovernanceActionProcessGraphResponse callGovernanceActionProcessGraphPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceActionProcessGraphResponse 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.

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 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.

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 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.

callIntegrationGroupGetRESTCall

public IntegrationGroupElementResponse callIntegrationGroupGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationGroupElementResponse 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.

callRegisteredIntegrationConnectorGetRESTCall

public RegisteredIntegrationConnectorResponse callRegisteredIntegrationConnectorGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredIntegrationConnectorResponse 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.

callRegisteredIntegrationConnectorsGetRESTCall

public RegisteredIntegrationConnectorsResponse callRegisteredIntegrationConnectorsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredIntegrationConnectorsResponse 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.