Interface ContextPathEncoder

All Known Implementing Classes:
ContextPathEncoderImpl

public interface ContextPathEncoder
A service to provide utilities needed for event context encoding and decoding to and from (partial) URL paths. This is used for both component event contexts and page activation contexts.
  • Method Details

    • encodeValue

      Encodes a single value via the ContextValueEncoder service, returning the resulting string. Even null is encoded, as per URLEncoder.encode(String).
      Since:
      5.2.2
    • encodeIntoPath

      Encodes the context values into a path string. Each context value (if non-null) is first value encoded into a string via the ContextValueEncoder service. Those values are then encoded, via URLEncoder.encode(String) into URL-safe strings. The URL-safe strings are then concatenated together, separated with "/" characters.
      Parameters:
      context - an array of objects to encode as the context (may be null)
      Returns:
      the path-encoded context, or the blank string if the context is empty
    • encodeIntoPath

      Encodes the context into a string. Returns the empty string if the context is empty.
      Parameters:
      context - to encode
      Returns:
      encoded values separated by "/" characters, or the empty string
      Since:
      5.1.0.2
    • decodePath

      Inverse of encodeIntoPath(Object[]); the path is split into strings, and the string are decoded and constructed into an EventContext.
      Parameters:
      path - to decode, possibly empty or null
      Returns:
      corresponding event context