Class Action

java.lang.Object
io.confluent.security.authorizer.Action
public class Action extends Object
Represents an authorizable action, which is an operation performed on a resource.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Action(io.confluent.security.authorizer.Scope scope, ResourcePattern resourcePattern, io.confluent.security.roledefinitions.Operation operation)
    Constructs an authorizable action
    Action(io.confluent.security.authorizer.Scope scope, ResourcePattern resourcePattern, io.confluent.security.roledefinitions.Operation operation, int resourceReferenceCount, boolean logIfAllowed, boolean logIfDenied)
    Constructs an authorizable action
    Action(io.confluent.security.authorizer.Scope scope, io.confluent.security.roledefinitions.ResourceType resourceType, String resourceName, io.confluent.security.roledefinitions.Operation operation)
    Constructs a cross-component authorizable action for a literal resource.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    boolean
    logIfAllowed()
     
    boolean
    logIfDenied()
     
    io.confluent.security.roledefinitions.Operation
    operation()
     
    String
    resourceName()
     
    ResourcePattern
    resourcePattern()
     
    int
    resourceReferenceCount()
     
    io.confluent.security.roledefinitions.ResourceType
    resourceType()
     
    io.confluent.security.authorizer.Scope
    scope()
     
    org.apache.kafka.server.authorizer.Action
    toKafkaAction()
     
    String
    toString()
     
    Action
    withScope(io.confluent.security.authorizer.Scope newScope)
    Returns a copy of this action rebound to newScope; all other fields (resource, operation, audit flags) are unchanged.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Action

      public Action(io.confluent.security.authorizer.Scope scope, io.confluent.security.roledefinitions.ResourceType resourceType, String resourceName, io.confluent.security.roledefinitions.Operation operation)
      Constructs a cross-component authorizable action for a literal resource.
      Parameters:
      scope - Scope of resource
      resourceType - Resource type
      resourceName - Non-null name of resource
      operation - Operation being performed on resource

    • Action

      public Action(io.confluent.security.authorizer.Scope scope, ResourcePattern resourcePattern, io.confluent.security.roledefinitions.Operation operation)
      Constructs an authorizable action
      Parameters:
      scope - Scope of resource
      resourcePattern - Resource pattern must be literal for Kafka and other components using Metadata Service for authorization. Metadata Service may authorize actions with any pattern type including ANY and MATCH.
      operation - Operation being performed on resource

    • Action

      public Action(io.confluent.security.authorizer.Scope scope, ResourcePattern resourcePattern, io.confluent.security.roledefinitions.Operation operation, int resourceReferenceCount, boolean logIfAllowed, boolean logIfDenied)
      Constructs an authorizable action
      Parameters:
      scope - Scope of resource
      resourcePattern - Resource pattern must be literal for Kafka and other components using Metadata Service for authorization. Metadata Service may authorize actions with any pattern type including ANY and MATCH.
      operation - Operation being performed on resource
      resourceReferenceCount - Number of times the resource is referenced in the request
      logIfAllowed - Enable audit logging if permission is granted
      logIfDenied - Enable audit logging if permission is denied

  • Method Details

    • scope

      public io.confluent.security.authorizer.Scope scope()

    • withScope

      public Action withScope(io.confluent.security.authorizer.Scope newScope)
      Returns a copy of this action rebound to newScope; all other fields (resource, operation, audit flags) are unchanged. Used by the authorizer to re-check a denied action at an alternate scope (see
      invalid reference 
      ScopeFallback#recheckOnDeny
      ).

    • resourceType

      public io.confluent.security.roledefinitions.ResourceType resourceType()

    • resourceName

      public String resourceName()

    • operation

      public io.confluent.security.roledefinitions.Operation operation()

    • resourcePattern

      public ResourcePattern resourcePattern()

    • resourceReferenceCount

      public int resourceReferenceCount()

    • logIfAllowed

      public boolean logIfAllowed()

    • logIfDenied

      public boolean logIfDenied()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toKafkaAction

      public org.apache.kafka.server.authorizer.Action toKafkaAction()