Package io.camunda.security.auth

Record Class SecurityContext

java.lang.Object
java.lang.Record
io.camunda.security.auth.SecurityContext
public record SecurityContext(CamundaAuthentication authentication, Authorization<?> authorization) extends Record
Represents the security context for the current operation, containing both authentication and authorization information. It encapsulates the user's identity, group and tenant affiliations, along with the permissions that need to be checked for the current operation.

Note: For now, we only support a single authorization check. This will be later extended to more than one authorization (for composite permissions checks).

  • Constructor Details

    • SecurityContext

      public SecurityContext(CamundaAuthentication authentication, Authorization<?> authorization)
      Creates an instance of a SecurityContext record class.
      Parameters:
      authentication - the value for the authentication record component
      authorization - the value for the authorization record component

  • Method Details

    • of

      public static SecurityContext of(Function<SecurityContext.Builder,SecurityContext.Builder> builderFunction)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • authentication

      public CamundaAuthentication authentication()
      Returns the value of the authentication record component.
      Returns:
      the value of the authentication record component

    • authorization

      public Authorization<?> authorization()
      Returns the value of the authorization record component.
      Returns:
      the value of the authorization record component