Package org.odpi.openmetadata.serveroperations.client.rest

Class ServerOperationsRESTClient

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServerOperationsRESTClient(String platformName, String platformURLRoot)
    Constructor for no authentication.
    ServerOperationsRESTClient(String platformName, String platformURLRoot, String userId, String password)
    Constructor for simple userId and password authentication.
    ServerOperationsRESTClient(String platformName, String platformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for simple userId and password authentication with audit log.
    ServerOperationsRESTClient(String platformName, String platformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for no authentication with audit log.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse
    callOMAGServerConfigGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a OMAGServerConfigResponse object.
    org.odpi.openmetadata.serveroperations.rest.OMAGServerStatusResponse
    callOMAGServerStatusGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a OMAGServerStatusResponse object.
    org.odpi.openmetadata.serveroperations.rest.ServerStatusResponse
    callServerStatusGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ServerStatusResponse object.
    org.odpi.openmetadata.serveroperations.rest.ServerServicesListResponse
    callServiceListGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns a ServerServicesListResponse 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

    • ServerOperationsRESTClient

      public ServerOperationsRESTClient(String platformName, String platformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Constructor for no authentication with audit log.
      Parameters:
      platformName - name of the OMAG Server to call
      platformURLRoot - 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.

    • ServerOperationsRESTClient

      public ServerOperationsRESTClient(String platformName, String platformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Constructor for no authentication.
      Parameters:
      platformName - name of the OMAG Server to call
      platformURLRoot - 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.

    • ServerOperationsRESTClient

      public ServerOperationsRESTClient(String platformName, String platformURLRoot, 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:
      platformName - name of the OMAG Server to call
      platformURLRoot - 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.

    • ServerOperationsRESTClient

      public ServerOperationsRESTClient(String platformName, String platformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Constructor for simple userId and password authentication.
      Parameters:
      platformName - name of the OMAG Server to call
      platformURLRoot - 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

    • callServerStatusGetRESTCall

      public org.odpi.openmetadata.serveroperations.rest.ServerStatusResponse callServerStatusGetRESTCall(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 ServerStatusResponse object.
      Parameters:
      methodName - name of the method being called.
      urlTemplate - template of the URL for the REST API 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.

    • callServiceListGetRESTCall

      public org.odpi.openmetadata.serveroperations.rest.ServerServicesListResponse callServiceListGetRESTCall(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 ServerServicesListResponse object.
      Parameters:
      methodName - name of the method being called.
      urlTemplate - template of the URL for the REST API 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.

    • callOMAGServerStatusGetRESTCall

      public org.odpi.openmetadata.serveroperations.rest.OMAGServerStatusResponse callOMAGServerStatusGetRESTCall(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 OMAGServerStatusResponse 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:
      OMAGServerStatusResponse
      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.

    • callOMAGServerConfigGetRESTCall

      public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse callOMAGServerConfigGetRESTCall(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 OMAGServerConfigResponse 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:
      OMAGServerConfigResponse
      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.