Package io.getlime.security.powerauth.lib.cmd.logging

Interface StepLogger

All Known Implementing Classes:
DisabledStepLogger, JsonStepLogger, ObjectStepLogger
public interface StepLogger
Author:
Petr Dvorak, petr@wultra.com

  • Method Details

    • start

      void start()
      Start the object streaming, outputs start of the result object:

    • writeItem

      void writeItem​(String id, String name, String description, String status, Object object)
      Writes an object representing the step of the execution.
      Parameters:
      id - Step ID.
      name - Step name.
      description - Step detailed description.
      status - Step status result.
      object - Custom object associated with the step.

    • writeServerCall

      void writeServerCall​(String id, String uri, String method, Object requestObject, byte[] requestBytes, Map<String,​?> headers)
      Write the information about the server call. Uses "writeItem" method under the hood.
      Parameters:
      id - Step ID.
      uri - URI that will be called.
      method - HTTP method of the call.
      requestBytes - Request bytes, in case of the POST, PUT, DELETE method.
      requestObject - Request object, in case of the POST, PUT, DELETE method.
      headers - HTTP request headers.

    • writeServerCallOK

      void writeServerCallOK​(String id, Object responseObject, Map<String,​?> headers)
      Write information about the successful server request. Uses "writeItem" method under the hood.
      Parameters:
      id - Step ID.
      responseObject - HTTP response object.
      headers - HTTP response headers.

    • writeServerCallError

      void writeServerCallError​(String id, int statusCode, Object responseObject, Map<String,​?> headers)
      Write information about the failed server request. Uses "writeItem" method under the hood.
      Parameters:
      id - Step ID.
      statusCode - HTTP response status code.
      responseObject - HTTP response object.
      headers - HTTP response headers.

    • close

      void close()
      Closes the logger output, writes code to close the array and opened object

    • writeServerCallConnectionError

      void writeServerCallConnectionError​(String id, Exception e)
      Write error in case of a network issues.
      Parameters:
      id - Step ID.
      e - Network exception.

    • writeError

      void writeError​(String id, String errorMessage)
      Write error with given error message. Error message is mapped as a step description.
      Parameters:
      id - Step ID.
      errorMessage - Error message.

    • writeError

      void writeError​(String id, Exception exception)
      Write error with given exception information. Exception description is mapped as a step description, exception is passed as a custom object.
      Parameters:
      id - Step ID.
      exception - Exception that should be logged.

    • writeError

      void writeError​(String id, String name, String errorMessage)
      Write error with given error name and error message, that is used as a description.
      Parameters:
      id - Step ID.
      name - Error name.
      errorMessage - Error message.

    • writeError

      void writeError​(String id, String name, String errorMessage, Exception exception)
      Write error with given error name and error message, that is used as a description.
      Parameters:
      id - Step ID.
      name - Error name.
      errorMessage - Error message.
      exception - Exception that caused the error.

    • writeDoneOK

      void writeDoneOK​(String id)
      Write information about successfully finished execution.
      Parameters:
      id - Step ID.

    • writeDoneFailed

      void writeDoneFailed​(String id)
      Write information about incorrectly finished execution.
      Parameters:
      id - Step ID.