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 org.odpi.openmetadata.commonservices.ffdc.rest.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.
  • 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, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for simple userId and password authentication with audit log.
    DigitalArchitectureRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for no authentication with audit log.
  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionResponse
    callConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ConnectionResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionsResponse
    callConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a POST REST call that returns a ConnectionsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionsResponse
    callConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a ConnectionsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectorTypesResponse
    callConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a ConnectorTypesResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.EndpointResponse
    callEndpointGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a EndpointResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.EndpointsResponse
    callEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a EndpointsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.LocationResponse
    callLocationGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a LocationResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.LocationsResponse
    callLocationsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a LocationsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectorTypeResponse
    callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ConnectorReportResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ReferenceValueAssignmentDefinitionsResponse
    Issue a GET REST call that returns a ReferenceValueAssignmentDefinitionsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ReferenceValueAssignmentItemsResponse
    callReferenceValueAssignmentItemsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ReferenceValueAssignmentItemsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueAssignmentConsumersResponse
    callValidValueAssignmentConsumersGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValueAssignmentConsumersResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueAssignmentDefinitionsResponse
    Issue a GET REST call that returns a ValidValueAssignmentDefinitionsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueResponse
    callValidValueGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValuesResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueMappingsResponse
    callValidValueMappingsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValueMappingsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesResponse
    callValidValuesGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValuesResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesImplAssetsResponse
    callValidValuesImplAssetsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValuesImplAssetsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesImplDefinitionsResponse
    callValidValuesImplDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValuesImplDefinitionsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesMappingsResponse
    callValidValuesMappingsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ValidValueMappingsResponse object.
    org.odpi.openmetadata.accessservices.digitalarchitecture.rest.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

    callPostRESTCallNoParams

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • DigitalArchitectureRESTClient

      public DigitalArchitectureRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • DigitalArchitectureRESTClient

      public DigitalArchitectureRESTClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
  • Method Details

    • callLocationGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.LocationResponse callLocationGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callLocationsPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.LocationsResponse callLocationsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callConnectionGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionResponse callConnectionGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callConnectionsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionsResponse callConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callConnectionsPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectionsResponse callConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callMyConnectorTypeGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectorTypeResponse callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callConnectorTypesPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ConnectorTypesResponse callConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callEndpointGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.EndpointResponse callEndpointGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callEndpointsPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.EndpointsResponse callEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValueGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueResponse callValidValueGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValuesGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesResponse callValidValuesGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValuesPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesResponse callValidValuesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValueAssignmentConsumersGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueAssignmentConsumersResponse callValidValueAssignmentConsumersGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValueAssignmentDefinitionsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueAssignmentDefinitionsResponse callValidValueAssignmentDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.
    • callValidValuesImplAssetsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesImplAssetsResponse callValidValuesImplAssetsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
    • callValidValuesImplDefinitionsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesImplDefinitionsResponse callValidValuesImplDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
    • callReferenceValueAssignmentDefinitionsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ReferenceValueAssignmentDefinitionsResponse callReferenceValueAssignmentDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
    • callReferenceValueAssignmentItemsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ReferenceValueAssignmentItemsResponse callReferenceValueAssignmentItemsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
    • callValidValueMappingsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValueMappingsResponse callValidValueMappingsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
    • callValidValuesMappingsGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalarchitecture.rest.ValidValuesMappingsResponse callValidValuesMappingsGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.