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

Class DigitalServiceRESTClient

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.accessservices.digitalservice.client.rest.DigitalServiceRESTClient
public class DigitalServiceRESTClient extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
DigitalServiceRESTClient 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
    DigitalServiceRESTClient(String serverName, String serverPlatformURLRoot)
    Constructor for no authentication.
    DigitalServiceRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Constructor for simple userId and password authentication.
    DigitalServiceRESTClient(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.
    DigitalServiceRESTClient(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.digitalservice.rest.DigitalServiceResponse
    callDigitalServiceGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a DigitalServiceElement in a response object.
    org.odpi.openmetadata.accessservices.digitalservice.rest.DigitalServiceListResponse
    callDigitalServiceListGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a list of DigitalServiceElements in a response object.
    org.odpi.openmetadata.accessservices.digitalservice.rest.DigitalServiceListResponse
    callDigitalServiceListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a GET REST call that returns a list of DigitalServiceElements in a response object.
    org.odpi.openmetadata.accessservices.digitalservice.rest.RelatedElementListResponse
    callRelatedElementListGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a RelatedElementListResponse 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 Details

    • DigitalServiceRESTClient

      public DigitalServiceRESTClient(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 manager 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.

    • DigitalServiceRESTClient

      public DigitalServiceRESTClient(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 manager 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.

    • DigitalServiceRESTClient

      public DigitalServiceRESTClient(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 manager where the OMAG Server is running.
      userId - user id for the HTTP request
      password - password for the HTTP request
      auditLog - destination for log messages.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • DigitalServiceRESTClient

      public DigitalServiceRESTClient(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 manager 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

    • callRelatedElementListGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalservice.rest.RelatedElementListResponse callRelatedElementListGetRESTCall(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 RelatedElementListResponse object.
      Parameters:
      methodName - name of the method being called.
      urlTemplate - REST API call URL template with place-holders for the parameters.
      params - a list of parameters that are slotted into the url template.
      Returns:
      response object
      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.

    • callDigitalServiceGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalservice.rest.DigitalServiceResponse callDigitalServiceGetRESTCall(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 DigitalServiceElement in a response object.
      Parameters:
      methodName - name of the method being called.
      urlTemplate - REST API call URL template with place-holders for the parameters.
      params - a list of parameters that are slotted into the url template.
      Returns:
      response object
      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.

    • callDigitalServiceListGetRESTCall

      public org.odpi.openmetadata.accessservices.digitalservice.rest.DigitalServiceListResponse callDigitalServiceListGetRESTCall(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 list of DigitalServiceElements in a response object.
      Parameters:
      methodName - name of the method being called
      urlTemplate - REST API call URL template with place-holders for the parameters
      params - a list of parameters that are slotted into the url template
      Returns:
      response object
      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.

    • callDigitalServiceListPostRESTCall

      public org.odpi.openmetadata.accessservices.digitalservice.rest.DigitalServiceListResponse callDigitalServiceListPostRESTCall(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 GET REST call that returns a list of DigitalServiceElements in a response object.
      Parameters:
      methodName - name of the method being called
      urlTemplate - REST API call URL template with place-holders for the parameters
      requestBody - request body for the request
      params - a list of parameters that are slotted into the url template
      Returns:
      response object
      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.