Package org.forgerock.http.header

Class TransactionIdHeader

java.lang.Object
org.forgerock.http.protocol.Header
org.forgerock.http.header.TransactionIdHeader
public final class TransactionIdHeader extends Header
Processes the transactionId header used mainly for audit purpose.

  • Field Details

  • Constructor Details

    • TransactionIdHeader

      public TransactionIdHeader(String value) throws MalformedHeaderException
      Constructs a new header with the provided value for the transaction id. The transactionId will be null if either the value is null or empty.
      Parameters:
      value - The value for the transaction id.
      Throws:
      MalformedHeaderException - if the value is not acceptable for a TransactionId

    • TransactionIdHeader

      public TransactionIdHeader(TransactionId transactionId)
      Constructs a new header with the provided transaction id object.
      Parameters:
      transactionId - The transaction id.

  • Method Details

    • valueOf

      public static TransactionIdHeader valueOf(Request request) throws MalformedHeaderException
      Constructs a new header, initialized from the specified request.
      Parameters:
      request - The request to initialize the header from.
      Returns:
      The parsed header
      Throws:
      MalformedHeaderException - if the value is not acceptable for a TransactionId

    • valueOf

      public static TransactionIdHeader valueOf(String value) throws MalformedHeaderException
      Constructs a new header, initialized from the specified string value.
      Parameters:
      value - The value to initialize the header from.
      Returns:
      The parsed header.
      Throws:
      MalformedHeaderException - if the value is not acceptable for a TransactionId

    • getTransactionId

      public TransactionId getTransactionId()
      Returns the transaction id.
      Returns:
      The transaction id

    • getName

      public String getName()
      Description copied from class: Header
      Returns the name of the header, as it would canonically appear within an HTTP message.
      Specified by:
      getName in class Header
      Returns:
      The name of the header, as it would canonically appear within an HTTP message.

    • getValues

      public List<String> getValues()
      Description copied from class: Header
      Returns the header as a list of strings. If the header has no values then it must return an empty list, never null. Each String should represent the value component of the key-value pair that makes up the HTTP header - as such, for some Header implementations each String in this List may contain multiple token-separated values.

      The List returned from this method should not be expected to be mutable. However, some subclasses of Header may choose to implement it as such.

      Specified by:
      getValues in class Header
      Returns:
      The header as a non-null list of string values. Can be an empty list.