Trait

kafka.security.auth

Authorizer

Related Doc: package auth

Permalink

trait Authorizer extends Configurable

Top level interface that all plugable authorizer must implement. Kafka server will read "authorizer.class" config value at startup time, create an instance of the specified class and call initialize method. authorizer.class must be a class that implements this interface. If authorizer.class has no value specified no authorization will be performed.

From that point onwards, every client request will first be routed to authorize method and the request will only be authorized if the method returns true.

Linear Supertypes
Configurable, AnyRef, Any
Known Subclasses
SimpleAclAuthorizer
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Authorizer
  2. Configurable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addAcls(acls: Set[Acl], resource: Resource): Unit

    Permalink

    add the acls to resource, this is an additive operation so existing acls will not be overwritten, instead these new acls will be added to existing acls.

    add the acls to resource, this is an additive operation so existing acls will not be overwritten, instead these new acls will be added to existing acls.

    acls

    set of acls to add to existing acls

    resource

    the resource to which these acls should be attached.

  2. abstract def authorize(session: Session, operation: Operation, resource: Resource): Boolean

    Permalink

    session

    The session being authenticated.

    operation

    Type of operation client is trying to perform on resource.

    resource

    Resource the client is trying to access.

  3. abstract def close(): Unit

    Permalink

    Closes this instance.

  4. abstract def configure(arg0: Map[String, _]): Unit

    Permalink
    Definition Classes
    Configurable

  5. abstract def getAcls(): Map[Resource, Set[Acl]]

    Permalink

    gets the map of resource to acls for all resources.

  6. abstract def getAcls(principal: KafkaPrincipal): Map[Resource, Set[Acl]]

    Permalink

    get the acls for this principal.

    get the acls for this principal.

    returns

    empty Map if no acls exist for this principal, otherwise a map of resource -> acls for the principal.

  7. abstract def getAcls(resource: Resource): Set[Acl]

    Permalink

    get set of acls for this resource

    get set of acls for this resource

    returns

    empty set if no acls are found, otherwise the acls for the resource.

  8. abstract def removeAcls(resource: Resource): Boolean

    Permalink

    remove a resource along with all of its acls from acl store.

  9. abstract def removeAcls(acls: Set[Acl], resource: Resource): Boolean

    Permalink

    remove these acls from the resource.

    remove these acls from the resource.

    acls

    set of acls to be removed.

    resource

    resource from which the acls should be removed.

    returns

    true if some acl got removed, false if no acl was removed.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Configurable

Inherited from AnyRef

Inherited from Any

Ungrouped