Module io.inverno.mod.security.jose
Package io.inverno.mod.security.jose

Interface JOSEObject<A,B extends JOSEHeader>

Type Parameters:
A - the payload type
B - the JOSE header type
All Known Subinterfaces:
JWE<A>, JWS<A>
public interface JOSEObject<A,B extends JOSEHeader>

A JOSE object composed of a JOSE header and a payload and secured through cryptographic operations.

A JOSE object is serialized to a compact representation as defined by RFC7515 Section 7.1 and RFC7516 Section 7.1.

Since:
1.5
Author:
Jeremy Kuhn
See Also:

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    B
    getHeader()
    Returns the JOSE header describing the cryptographic operations and parameters employed to secure the JOSE object.
    A
    getPayload()
    Returns the JOSE object payload.
    int
    hashCode()
     
    String
    toCompact()
    Serializes the JOSE object to a compact representation.

  • Method Details Link icon

    • getHeader Link icon

      B getHeader()

      Returns the JOSE header describing the cryptographic operations and parameters employed to secure the JOSE object.

      Returns:
      the JOSE header

    • getPayload Link icon

      A getPayload()

      Returns the JOSE object payload.

      Returns:
      the payload

    • toCompact Link icon

      String toCompact()

      Serializes the JOSE object to a compact representation.

      Returns:
      the compact representation of the JOSE object

    • hashCode Link icon

      int hashCode()
      Overrides:
      hashCode in class Object

    • equals Link icon

      boolean equals(Object obj)
      Overrides:
      equals in class Object