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

Class DisabledStepLogger

java.lang.Object
io.getlime.security.powerauth.lib.cmd.logging.DisabledStepLogger
All Implemented Interfaces:
StepLogger
public class DisabledStepLogger
extends java.lang.Object
implements StepLogger
Disabled step logger for silent logging
Author:
Lukas Lukovsky, lukas.lukovsky@wultra.com

  • Field Summary

    Fields
    Modifier and Type Field Description
    static StepLogger INSTANCE
    Singleton instance of a disabled step logger

  • Method Summary

    Modifier and Type Method Description
    void close()
    Closes the logger output, writes code to close the array and opened object
    void start()
    Start the object streaming, outputs start of the result object:
    void writeDoneFailed​(java.lang.String id)
    Write information about incorrectly finished execution.
    void writeDoneOK​(java.lang.String id)
    Write information about successfully finished execution.
    void writeError​(java.lang.String id, java.lang.Exception exception)
    Write error with given exception information.
    void writeError​(java.lang.String id, java.lang.String errorMessage)
    Write error with given error message.
    void writeError​(java.lang.String id, java.lang.String name, java.lang.String errorMessage)
    Write error with given error name and error message, that is used as a description.
    void writeError​(java.lang.String id, java.lang.String name, java.lang.String errorMessage, java.lang.Exception exception)
    Write error with given error name and error message, that is used as a description.
    void writeItem​(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String status, java.lang.Object object)
    Writes an object representing the step of the execution.
    void writeServerCall​(java.lang.String id, java.lang.String uri, java.lang.String method, java.lang.Object requestObject, byte[] requestBytes, java.util.Map<java.lang.String,​?> headers)
    Write the information about the server call.
    void writeServerCallConnectionError​(java.lang.String id, java.lang.Exception e)
    Write error in case of a network issues.
    void writeServerCallError​(java.lang.String id, int statusCode, java.lang.Object responseObject, java.util.Map<java.lang.String,​?> headers)
    Write information about the failed server request.
    void writeServerCallOK​(java.lang.String id, java.lang.Object responseObject, java.util.Map<java.lang.String,​?> headers)
    Write information about the successful server request.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • INSTANCE

      public static final StepLogger INSTANCE
      Singleton instance of a disabled step logger

  • Method Details

    • start

      public void start()
      Description copied from interface: StepLogger
      Start the object streaming, outputs start of the result object:
      Specified by:
      start in interface StepLogger

    • writeItem

      public void writeItem​(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String status, java.lang.Object object)
      Description copied from interface: StepLogger
      Writes an object representing the step of the execution.
      Specified by:
      writeItem in interface StepLogger
      Parameters:
      id - Step ID.
      name - Step name.
      description - Step detailed description.
      status - Step status result.
      object - Custom object associated with the step.

    • writeServerCall

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

    • writeServerCallOK

      public void writeServerCallOK​(java.lang.String id, java.lang.Object responseObject, java.util.Map<java.lang.String,​?> headers)
      Description copied from interface: StepLogger
      Write information about the successful server request. Uses "writeItem" method under the hood.
      Specified by:
      writeServerCallOK in interface StepLogger
      Parameters:
      id - Step ID.
      responseObject - HTTP response object.
      headers - HTTP response headers.

    • writeServerCallError

      public void writeServerCallError​(java.lang.String id, int statusCode, java.lang.Object responseObject, java.util.Map<java.lang.String,​?> headers)
      Description copied from interface: StepLogger
      Write information about the failed server request. Uses "writeItem" method under the hood.
      Specified by:
      writeServerCallError in interface StepLogger
      Parameters:
      id - Step ID.
      statusCode - HTTP response status code.
      responseObject - HTTP response object.
      headers - HTTP response headers.

    • close

      public void close()
      Description copied from interface: StepLogger
      Closes the logger output, writes code to close the array and opened object
      Specified by:
      close in interface StepLogger

    • writeServerCallConnectionError

      public void writeServerCallConnectionError​(java.lang.String id, java.lang.Exception e)
      Description copied from interface: StepLogger
      Write error in case of a network issues.
      Specified by:
      writeServerCallConnectionError in interface StepLogger
      Parameters:
      id - Step ID.
      e - Network exception.

    • writeError

      public void writeError​(java.lang.String id, java.lang.String errorMessage)
      Description copied from interface: StepLogger
      Write error with given error message. Error message is mapped as a step description.
      Specified by:
      writeError in interface StepLogger
      Parameters:
      id - Step ID.
      errorMessage - Error message.

    • writeError

      public void writeError​(java.lang.String id, java.lang.Exception exception)
      Description copied from interface: StepLogger
      Write error with given exception information. Exception description is mapped as a step description, exception is passed as a custom object.
      Specified by:
      writeError in interface StepLogger
      Parameters:
      id - Step ID.
      exception - Exception that should be logged.

    • writeError

      public void writeError​(java.lang.String id, java.lang.String name, java.lang.String errorMessage)
      Description copied from interface: StepLogger
      Write error with given error name and error message, that is used as a description.
      Specified by:
      writeError in interface StepLogger
      Parameters:
      id - Step ID.
      name - Error name.
      errorMessage - Error message.

    • writeError

      public void writeError​(java.lang.String id, java.lang.String name, java.lang.String errorMessage, java.lang.Exception exception)
      Description copied from interface: StepLogger
      Write error with given error name and error message, that is used as a description.
      Specified by:
      writeError in interface StepLogger
      Parameters:
      id - Step ID.
      name - Error name.
      errorMessage - Error message.
      exception - Exception that caused the error.

    • writeDoneOK

      public void writeDoneOK​(java.lang.String id)
      Description copied from interface: StepLogger
      Write information about successfully finished execution.
      Specified by:
      writeDoneOK in interface StepLogger
      Parameters:
      id - Step ID.

    • writeDoneFailed

      public void writeDoneFailed​(java.lang.String id)
      Description copied from interface: StepLogger
      Write information about incorrectly finished execution.
      Specified by:
      writeDoneFailed in interface StepLogger
      Parameters:
      id - Step ID.