org.odpi.openmetadata.commonservices.gaf.metadatamanagement.client

Class GAFRESTClient

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.odf.metadatamanagement.client.ODFRESTClient

org.odpi.openmetadata.commonservices.gaf.metadatamanagement.client.GAFRESTClient

public class GAFRESTClient
extends ODFRESTClient

GAFRESTClient is responsible for issuing calls to the GAF Management REST APIs.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ZoneResponse	callZoneGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ZoneResponse object.
ZoneListResponse	callZoneListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a Zone List object.
ZoneResponse	callZonePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ZoneResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.odf.metadatamanagement.client.ODFRESTClient

callAnnotationGetRESTCall, callAnnotationListGetRESTCall, callAnnotationListPostRESTCall, callAnnotationPostRESTCall, callDiscoveryAnalysisReportGetRESTCall, callDiscoveryAnalysisReportListGetRESTCall, callDiscoveryAnalysisReportListPostRESTCall, callDiscoveryAnalysisReportPostRESTCall, callDiscoveryEngineListGetRESTCall, callDiscoveryEnginePropertiesGetRESTCall, callDiscoveryServiceListGetRESTCall, callDiscoveryServicePropertiesGetRESTCall, callRegisteredDiscoveryServiceGetRESTCall

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

callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callSchemaTypeGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

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

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

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

callDeleteRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

GAFRESTClient

protected GAFRESTClient(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 platform 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.

GAFRESTClient

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

Throws:

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

GAFRESTClient

protected GAFRESTClient(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 platform 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.

GAFRESTClient

protected GAFRESTClient(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 platform 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

callZoneListGetRESTCall

public ZoneListResponse callZoneListGetRESTCall(String methodName,
                                                String urlTemplate,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

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

ZoneListResponse

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.

callZoneGetRESTCall

public ZoneResponse callZoneGetRESTCall(String methodName,
                                        String urlTemplate,
                                        Object... params)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

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

ZoneResponse

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.

callZonePostRESTCall

public ZoneResponse callZonePostRESTCall(String methodName,
                                         String urlTemplate,
                                         Object requestBody,
                                         Object... params)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Issue a POST REST call that returns a ZoneResponse 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 - request body for the REST call - contains most of the parameters

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

Returns:

ZoneResponse

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.