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

Class ODFRESTClient

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.accessservices.discoveryengine.client.rest.ODFRESTClient

public class ODFRESTClient
extends OCFRESTClient

ODFRESTClient 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
ODFRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
ODFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
ODFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
ODFRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
AnnotationResponse	callAnnotationGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns an AnnotationResponse object.
AnnotationListResponse	callAnnotationListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns an AnnotationListResponse object.
AnnotationListResponse	callAnnotationListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns an AnnotationListResponse object.
AnnotationResponse	callAnnotationPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns an AnnotationResponse object.
DataFieldResponse	callDataFieldGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFieldResponse object.
DataFieldListResponse	callDataFieldListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFieldListResponse object.
DataFieldResponse	callDataFieldPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns an DataFieldResponse object.
DiscoveryAnalysisReportResponse	callDiscoveryAnalysisReportGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryAnalysisReportResponse object.
DiscoveryAnalysisReportListResponse	callDiscoveryAnalysisReportListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryAnalysisReportListResponse object.
DiscoveryAnalysisReportListResponse	callDiscoveryAnalysisReportListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DiscoveryAnalysisReportListResponse object.
DiscoveryAnalysisReportResponse	callDiscoveryAnalysisReportPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DiscoveryAnalysisReportResponse object.
DiscoveryEngineListResponse	callDiscoveryEngineListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryEngineListResponse object.
DiscoveryEnginePropertiesResponse	callDiscoveryEnginePropertiesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryEnginePropertiesResponse object.
DiscoveryServiceListResponse	callDiscoveryServiceListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryEngineListResponse object.
DiscoveryServicePropertiesResponse	callDiscoveryServicePropertiesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DiscoveryServicePropertiesResponse object.
RegisteredDiscoveryServiceResponse	callRegisteredDiscoveryServiceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredDiscoveryServiceResponse object.

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

ODFRESTClient

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

ODFRESTClient

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

ODFRESTClient

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

ODFRESTClient

public ODFRESTClient(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

callDiscoveryEnginePropertiesGetRESTCall

public DiscoveryEnginePropertiesResponse callDiscoveryEnginePropertiesGetRESTCall(String methodName,
                                                                                  String urlTemplate,
                                                                                  Object... params)
                                                                           throws InvalidParameterException,
                                                                                  UserNotAuthorizedException,
                                                                                  PropertyServerException

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

DiscoveryEnginePropertiesResponse

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.

callDiscoveryEngineListGetRESTCall

public DiscoveryEngineListResponse callDiscoveryEngineListGetRESTCall(String methodName,
                                                                      String urlTemplate,
                                                                      Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

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

DiscoveryEngineListResponse

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.

callDiscoveryServicePropertiesGetRESTCall

public DiscoveryServicePropertiesResponse callDiscoveryServicePropertiesGetRESTCall(String methodName,
                                                                                    String urlTemplate,
                                                                                    Object... params)
                                                                             throws InvalidParameterException,
                                                                                    UserNotAuthorizedException,
                                                                                    PropertyServerException

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

DiscoveryServicePropertiesResponse

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.

callDiscoveryServiceListGetRESTCall

public DiscoveryServiceListResponse callDiscoveryServiceListGetRESTCall(String methodName,
                                                                        String urlTemplate,
                                                                        Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

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

DiscoveryEngineListResponse

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.

callRegisteredDiscoveryServiceGetRESTCall

public RegisteredDiscoveryServiceResponse callRegisteredDiscoveryServiceGetRESTCall(String methodName,
                                                                                    String urlTemplate,
                                                                                    Object... params)
                                                                             throws InvalidParameterException,
                                                                                    UserNotAuthorizedException,
                                                                                    PropertyServerException

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

RegisteredDiscoveryServiceResponse

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.

callDiscoveryAnalysisReportGetRESTCall

public DiscoveryAnalysisReportResponse callDiscoveryAnalysisReportGetRESTCall(String methodName,
                                                                              String urlTemplate,
                                                                              Object... params)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException

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

DiscoveryAnalysisReportResponse

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.

callDiscoveryAnalysisReportPostRESTCall

public DiscoveryAnalysisReportResponse callDiscoveryAnalysisReportPostRESTCall(String methodName,
                                                                               String urlTemplate,
                                                                               Object requestBody,
                                                                               Object... params)
                                                                        throws InvalidParameterException,
                                                                               UserNotAuthorizedException,
                                                                               PropertyServerException

Issue a POST REST call that returns a DiscoveryAnalysisReportResponse 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:

DiscoveryAnalysisReportResponse

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.

callDiscoveryAnalysisReportListGetRESTCall

public DiscoveryAnalysisReportListResponse callDiscoveryAnalysisReportListGetRESTCall(String methodName,
                                                                                      String urlTemplate,
                                                                                      Object... params)
                                                                               throws InvalidParameterException,
                                                                                      UserNotAuthorizedException,
                                                                                      PropertyServerException

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

DiscoveryAnalysisReportResponse

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.

callDiscoveryAnalysisReportListPostRESTCall

public DiscoveryAnalysisReportListResponse callDiscoveryAnalysisReportListPostRESTCall(String methodName,
                                                                                       String urlTemplate,
                                                                                       Object requestBody,
                                                                                       Object... params)
                                                                                throws InvalidParameterException,
                                                                                       UserNotAuthorizedException,
                                                                                       PropertyServerException

Issue a POST REST call that returns a DiscoveryAnalysisReportListResponse 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:

DiscoveryAnalysisReportResponse

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.

callAnnotationListGetRESTCall

public AnnotationListResponse callAnnotationListGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

AnnotationListResponse

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.

callAnnotationListPostRESTCall

public AnnotationListResponse callAnnotationListPostRESTCall(String methodName,
                                                             String urlTemplate,
                                                             Object requestBody,
                                                             Object... params)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Issue a POST REST call that returns an AnnotationListResponse 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:

AnnotationResponse

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.

callAnnotationGetRESTCall

public AnnotationResponse callAnnotationGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

AnnotationResponse

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.

callAnnotationPostRESTCall

public AnnotationResponse callAnnotationPostRESTCall(String methodName,
                                                     String urlTemplate,
                                                     Object requestBody,
                                                     Object... params)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Issue a POST REST call that returns an AnnotationResponse 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:

AnnotationResponse

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.

callDataFieldListGetRESTCall

public DataFieldListResponse callDataFieldListGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

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

DataFieldListResponse

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.

callDataFieldGetRESTCall

public DataFieldResponse callDataFieldGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

DataFieldResponse

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.

callDataFieldPostRESTCall

public DataFieldResponse callDataFieldPostRESTCall(String methodName,
                                                   String urlTemplate,
                                                   Object requestBody,
                                                   Object... params)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Issue a POST REST call that returns an DataFieldResponse 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:

DataFieldResponse

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.