Package org.yamcs.tse

Interface Interceptor

All Known Implementing Classes:
LoggingInterceptor, RequestTerminator

public interface Interceptor
  • Method Summary

    Modifier and Type
    Method
    Description
    default byte[]
    interceptCommand(TseCommand metadata, byte[] bytes, Charset encoding)
    Intercepts a raw command just before passing it to driver-specific write logic.
    default byte[]
    interceptResponse(TseCommand metadata, byte[] bytes, Charset encoding)
    Intercepts the response when it is provided by the driver-specific read logic.
  • Method Details

    • interceptCommand

      default byte[] interceptCommand(TseCommand metadata, byte[] bytes, Charset encoding)
      Intercepts a raw command just before passing it to driver-specific write logic.

      Usually this corresponds to an encoded string, for which the encoding is provided too.

      Parameters:
      metadata - Metadata about the command. Note that full information is only available if the command was issued through Yamcs. If instead an internal Telnet session was used, only the target instrument is known.
      bytes - The raw command (usually correspons to an encoded string)
      encoding - String encoding
    • interceptResponse

      default byte[] interceptResponse(TseCommand metadata, byte[] bytes, Charset encoding)
      Intercepts the response when it is provided by the driver-specific read logic.

      This cannot be used for modifying how responses are delimited, because that's a responsibility of the driver.

      Parameters:
      metadata - Metadata about the command. Note that full information is only available if the command was issued through Yamcs. If instead an internal Telnet session was used, only the target instrument is known.
      bytes - The raw command response (usually corresponds to an encoded string)
      encoding - Expected string encoding