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

Class StewardshipActionRESTClient

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.accessservices.stewardshipaction.client.rest.StewardshipActionRESTClient
public class StewardshipActionRESTClient extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
AssetOwnerRESTClient is responsible for issuing calls to the OMAS REST APIs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StewardshipActionRESTClient(String serverName, String serverPlatformURLRoot)
    Constructor for no authentication.
    StewardshipActionRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Constructor for simple userId and password authentication.
    StewardshipActionRESTClient(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.
    StewardshipActionRESTClient(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.stewardshipaction.rest.DuplicatesResponse
    callDuplicatesGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a DuplicatesResponse object.
    org.odpi.openmetadata.accessservices.stewardshipaction.rest.DuplicatesResponse
    callDuplicatesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a DuplicatesResponse object.
    org.odpi.openmetadata.accessservices.stewardshipaction.rest.ElementStubResponse
    callElementStubGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ElementStubResponse object.
    org.odpi.openmetadata.accessservices.stewardshipaction.rest.ElementStubsResponse
    callElementStubsGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ElementStubsResponse 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

    • StewardshipActionRESTClient

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

    • StewardshipActionRESTClient

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

    • StewardshipActionRESTClient

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

    • StewardshipActionRESTClient

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

    • callDuplicatesGetRESTCall

      public org.odpi.openmetadata.accessservices.stewardshipaction.rest.DuplicatesResponse callDuplicatesGetRESTCall(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 DuplicatesResponse 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:
      DuplicatesResponse
      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.

    • callDuplicatesPostRESTCall

      public org.odpi.openmetadata.accessservices.stewardshipaction.rest.DuplicatesResponse callDuplicatesPostRESTCall(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 DuplicatesResponse object.
      Parameters:
      methodName - name of the method being called.
      requestBody - request body for the REST call - contains most of the parameters
      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:
      DuplicatesResponse
      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.

    • callElementStubGetRESTCall

      public org.odpi.openmetadata.accessservices.stewardshipaction.rest.ElementStubResponse callElementStubGetRESTCall(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 ElementStubResponse 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:
      ElementStubResponse
      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.

    • callElementStubsGetRESTCall

      public org.odpi.openmetadata.accessservices.stewardshipaction.rest.ElementStubsResponse callElementStubsGetRESTCall(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 ElementStubsResponse 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:
      ElementStubsResponse
      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.