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

Direct Known Subclasses:

GovernanceEngineRESTClient

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)	Constructor for no authentication.
GAFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
GAFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
GAFRESTClient(String serverName, String serverPlatformURLRoot, 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.
ElementHeaderResponse	callElementHeaderPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ElementHeaderResponse object.
ElementHeadersResponse	callElementHeadersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ElementHeadersResponse object.
OpenMetadataElementResponse	callOpenMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a OpenMetadataElementResponse object.
OpenMetadataElementResponse	callOpenMetadataElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a OpenMetadataElementResponse object.
OpenMetadataElementsResponse	callOpenMetadataElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a OpenMetadataElementsResponse object.
RelatedMetadataElementsResponse	callRelatedMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RelatedMetadataElementsResponse object.
RelatedMetadataElementListResponse	callRelatedMetadataElementListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RelatedMetadataElementListResponse object.
RelatedMetadataElementListResponse	callRelatedMetadataElementListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a RelatedMetadataElementListResponse object.
RelatedMetadataElementsListResponse	callRelatedMetadataElementsListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a RelatedMetadataElementsListResponse object.
RelatedMetadataElementsResponse	callRelatedMetadataElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a RelatedMetadataElementsResponse object.
TranslationDetailResponse	callTranslationDetailGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a TranslationDetailResponse object.
TranslationListResponse	callTranslationListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a TranslationListResponse object.
ValidMetadataValueResponse	callValidMetadataValueGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidMetadataValueResponse object.
ValidMetadataValueListResponse	callValidMetadataValueListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidMetadataValueListResponse object.

Methods inherited from class org.odpi.openmetadata.frameworkservices.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 Details

GAFRESTClient

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

GAFRESTClient

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

Throws:

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

GAFRESTClient

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

GAFRESTClient

public 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 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 Details

callElementHeaderPostRESTCall

public ElementHeaderResponse callElementHeaderPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ElementHeaderResponse 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.

callElementHeadersPostRESTCall

public ElementHeadersResponse callElementHeadersPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ElementHeadersResponse 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.

callOpenMetadataElementsPostRESTCall

public OpenMetadataElementsResponse callOpenMetadataElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a OpenMetadataElementsResponse 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.

callOpenMetadataElementPostRESTCall

public OpenMetadataElementResponse callOpenMetadataElementPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a OpenMetadataElementResponse 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.

callOpenMetadataElementGetRESTCall

public OpenMetadataElementResponse callOpenMetadataElementGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callRelatedMetadataElementsListPostRESTCall

public RelatedMetadataElementsListResponse callRelatedMetadataElementsListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a RelatedMetadataElementsListResponse 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.

callRelatedMetadataElementsPostRESTCall

public RelatedMetadataElementsResponse callRelatedMetadataElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a RelatedMetadataElementsResponse 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.

callRelatedMetadataElementGetRESTCall

public RelatedMetadataElementsResponse callRelatedMetadataElementGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callRelatedMetadataElementListPostRESTCall

public RelatedMetadataElementListResponse callRelatedMetadataElementListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a RelatedMetadataElementListResponse 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.

callRelatedMetadataElementListGetRESTCall

public RelatedMetadataElementListResponse callRelatedMetadataElementListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callTranslationDetailGetRESTCall

public TranslationDetailResponse callTranslationDetailGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callTranslationListGetRESTCall

public TranslationListResponse callTranslationListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callValidMetadataValueListGetRESTCall

public ValidMetadataValueListResponse callValidMetadataValueListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callValidMetadataValueGetRESTCall

public ValidMetadataValueResponse callValidMetadataValueGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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.