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

Class OCFRESTClient

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

Direct Known Subclasses:

GAFRESTClient, SurveyActionRESTClient, WatchdogActionRESTClient

public class OCFRESTClient
extends FFDCRESTClient

OCFRESTClient is responsible for issuing calls to the OCF Management REST APIs.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
OCFRESTClient(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
OCFConnectionResponse	callOCFConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a Connection object.

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

callBooleanGetRESTCall, 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

OCFRESTClient

public OCFRESTClient(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 platform where the OMAG Server is running.

localServerSecretsStoreProvider - secrets store connector for bearer token

localServerSecretsStoreLocation - secrets store location for bearer token

localServerSecretsStoreCollection - secrets store collection for bearer token

auditLog - destination for log messages.

Throws:

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

Method Details

callOCFConnectionGetRESTCall

public OCFConnectionResponse callOCFConnectionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a Connection 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:

OCFConnectionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.