Package org.odpi.openmetadata.governanceservers.enginehostservices.client.rest

Class EngineHostRESTClient

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.governanceservers.enginehostservices.client.rest.EngineHostRESTClient
public class EngineHostRESTClient extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
EngineHostRESTClient is responsible for issuing the REST API calls

  • Constructor Summary

    Constructors
    Constructor
    Description
    EngineHostRESTClient(String serverName, String serverPlatformURLRoot)
    Constructor for no authentication.
    EngineHostRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Constructor for simple userId and password authentication.
    EngineHostRESTClient(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.
    EngineHostRESTClient(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.governanceservers.enginehostservices.rest.GovernanceEngineSummariesResponse
    callGovernanceEngineSummariesGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a GovernanceEngineSummariesResponse object.
    org.odpi.openmetadata.governanceservers.enginehostservices.rest.GovernanceEngineSummaryResponse
    callGovernanceEngineSummaryGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a GovernanceEngineSummaryResponse object.

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

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

    • EngineHostRESTClient

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

    • EngineHostRESTClient

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

    • EngineHostRESTClient

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

    • EngineHostRESTClient

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

    • callGovernanceEngineSummariesGetRESTCall

      public org.odpi.openmetadata.governanceservers.enginehostservices.rest.GovernanceEngineSummariesResponse callGovernanceEngineSummariesGetRESTCall(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 GovernanceEngineSummariesResponse 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:
      GovernanceEngineSummariesResponse
      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.

    • callGovernanceEngineSummaryGetRESTCall

      public org.odpi.openmetadata.governanceservers.enginehostservices.rest.GovernanceEngineSummaryResponse callGovernanceEngineSummaryGetRESTCall(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 GovernanceEngineSummaryResponse 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:
      GovernanceEngineSummaryResponse
      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.