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

Class DigitalArchitectureRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient

public class DigitalArchitectureRESTClient
extends FFDCRESTClient

DigitalArchitectureRESTClient is responsible for issuing calls to the OMAS REST APIs and managing exceptions returned in the responses. It is built on the First Failure Data Capture (FFDC) client that handles the standard exceptions.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ConnectionResponse	callConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectionResponse object.
ConnectionsResponse	callConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectionsResponse	callConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectorTypesResponse	callConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectorTypesResponse object.
EndpointResponse	callEndpointGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EndpointResponse object.
EndpointsResponse	callEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EndpointsResponse object.
LocationResponse	callLocationGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a LocationResponse object.
LocationsResponse	callLocationsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a LocationsResponse object.
ConnectorTypeResponse	callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectorReportResponse object.
ReferenceValueAssignmentDefinitionsResponse	callReferenceValueAssignmentDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ReferenceValueAssignmentDefinitionsResponse object.
ReferenceValueAssignmentItemsResponse	callReferenceValueAssignmentItemsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ReferenceValueAssignmentItemsResponse object.
ValidValueAssignmentConsumersResponse	callValidValueAssignmentConsumersGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValueAssignmentConsumersResponse object.
ValidValueAssignmentDefinitionsResponse	callValidValueAssignmentDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValueAssignmentDefinitionsResponse object.
ValidValueResponse	callValidValueGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValuesResponse object.
ValidValueMappingsResponse	callValidValueMappingsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValueMappingsResponse object.
ValidValuesResponse	callValidValuesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValuesResponse object.
ValidValuesImplAssetsResponse	callValidValuesImplAssetsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValuesImplAssetsResponse object.
ValidValuesImplDefinitionsResponse	callValidValuesImplDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValuesImplDefinitionsResponse object.
ValidValuesMappingsResponse	callValidValuesMappingsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValueMappingsResponse object.
ValidValuesResponse	callValidValuesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ValidValuesResponse object.

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 Detail

DigitalArchitectureRESTClient

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

DigitalArchitectureRESTClient

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

DigitalArchitectureRESTClient

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

DigitalArchitectureRESTClient

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

callLocationGetRESTCall

public LocationResponse callLocationGetRESTCall(String methodName,
                                                String urlTemplate,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

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

LocationResponse

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.

callLocationsPostRESTCall

public LocationsResponse callLocationsPostRESTCall(String methodName,
                                                   String urlTemplate,
                                                   Object requestBody,
                                                   Object... params)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Issue a POST REST call that returns a LocationsResponse 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 - properties describing the valid value definition/set

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

Returns:

LocationsResponse

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.

callConnectionGetRESTCall

public ConnectionResponse callConnectionGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

ConnectionResponse

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.

callConnectionsGetRESTCall

public ConnectionsResponse callConnectionsGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

ConnectionsResponse

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.

callConnectionsPostRESTCall

public ConnectionsResponse callConnectionsPostRESTCall(String methodName,
                                                       String urlTemplate,
                                                       Object requestBody,
                                                       Object... params)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Issue a POST REST call that returns a ConnectionsResponse 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 - properties describing the valid value definition/set

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

Returns:

ConnectionsResponse

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.

callMyConnectorTypeGetRESTCall

public ConnectorTypeResponse callMyConnectorTypeGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

ConnectorReportResponse

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.

callConnectorTypesPostRESTCall

public ConnectorTypesResponse callConnectorTypesPostRESTCall(String methodName,
                                                             String urlTemplate,
                                                             Object requestBody,
                                                             Object... params)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Issue a POST REST call that returns a ConnectorTypesResponse 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 - properties describing the valid value definition/set

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

Returns:

ConnectorTypesResponse

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.

callEndpointGetRESTCall

public EndpointResponse callEndpointGetRESTCall(String methodName,
                                                String urlTemplate,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

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

EndpointResponse

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.

callEndpointsPostRESTCall

public EndpointsResponse callEndpointsPostRESTCall(String methodName,
                                                   String urlTemplate,
                                                   Object requestBody,
                                                   Object... params)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Issue a POST REST call that returns a EndpointsResponse 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 - properties describing the valid value definition/set

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

Returns:

EndpointsResponse

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.

callValidValueGetRESTCall

public ValidValueResponse callValidValueGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

ValidValueResponse

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.

callValidValuesGetRESTCall

public ValidValuesResponse callValidValuesGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

ValidValuesResponse

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.

callValidValuesPostRESTCall

public ValidValuesResponse callValidValuesPostRESTCall(String methodName,
                                                       String urlTemplate,
                                                       Object requestBody,
                                                       Object... params)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Issue a POST REST call that returns a ValidValuesResponse 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 - properties describing the valid value definition/set

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

Returns:

ValidValuesResponse

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.

callValidValueAssignmentConsumersGetRESTCall

public ValidValueAssignmentConsumersResponse callValidValueAssignmentConsumersGetRESTCall(String methodName,
                                                                                          String urlTemplate,
                                                                                          Object... params)
                                                                                   throws InvalidParameterException,
                                                                                          UserNotAuthorizedException,
                                                                                          PropertyServerException

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

ValidValueAssignmentConsumersResponse

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.

callValidValueAssignmentDefinitionsGetRESTCall

public ValidValueAssignmentDefinitionsResponse callValidValueAssignmentDefinitionsGetRESTCall(String methodName,
                                                                                              String urlTemplate,
                                                                                              Object... params)
                                                                                       throws InvalidParameterException,
                                                                                              UserNotAuthorizedException,
                                                                                              PropertyServerException

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

ValidValueAssignmentConsumersResponse

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.

callValidValuesImplAssetsGetRESTCall

public ValidValuesImplAssetsResponse callValidValuesImplAssetsGetRESTCall(String methodName,
                                                                          String urlTemplate,
                                                                          Object... params)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException

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

ValidValuesImplAssetsResponse

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.

callValidValuesImplDefinitionsGetRESTCall

public ValidValuesImplDefinitionsResponse callValidValuesImplDefinitionsGetRESTCall(String methodName,
                                                                                    String urlTemplate,
                                                                                    Object... params)
                                                                             throws InvalidParameterException,
                                                                                    UserNotAuthorizedException,
                                                                                    PropertyServerException

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

ValidValuesImplAssetsResponse

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.

callReferenceValueAssignmentDefinitionsGetRESTCall

public ReferenceValueAssignmentDefinitionsResponse callReferenceValueAssignmentDefinitionsGetRESTCall(String methodName,
                                                                                                      String urlTemplate,
                                                                                                      Object... params)
                                                                                               throws InvalidParameterException,
                                                                                                      UserNotAuthorizedException,
                                                                                                      PropertyServerException

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

ValidValuesImplAssetsResponse

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.

callReferenceValueAssignmentItemsGetRESTCall

public ReferenceValueAssignmentItemsResponse callReferenceValueAssignmentItemsGetRESTCall(String methodName,
                                                                                          String urlTemplate,
                                                                                          Object... params)
                                                                                   throws InvalidParameterException,
                                                                                          UserNotAuthorizedException,
                                                                                          PropertyServerException

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

ValidValuesImplAssetsResponse

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.

callValidValueMappingsGetRESTCall

public ValidValueMappingsResponse callValidValueMappingsGetRESTCall(String methodName,
                                                                    String urlTemplate,
                                                                    Object... params)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException

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

ValidValuesImplAssetsResponse

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.

callValidValuesMappingsGetRESTCall

public ValidValuesMappingsResponse callValidValuesMappingsGetRESTCall(String methodName,
                                                                      String urlTemplate,
                                                                      Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

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

ValidValuesImplAssetsResponse

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.