org.apache.kafka.common.acl

Class AccessControlEntry

java.lang.Object

org.apache.kafka.common.acl.AccessControlEntry

@InterfaceStability.Evolving
public class AccessControlEntry
extends Object

Represents an access control entry. ACEs are a tuple of principal, host, operation, and permissionType. The API for this class is still evolving and we may break compatibility in minor releases, if necessary.

Constructor Summary

Constructors

Constructor and Description
AccessControlEntry(String principal, String host, AclOperation operation, AclPermissionType permissionType) Create an instance of an access control entry with the provided parameters.
AccessControlEntry(String principal, String host, AclOperation operation, AclPermissionType permissionType, Collection<Uuid> clusterLinkIds) Create an instance of an access control entry with the provided parameters.

Method Summary

Modifier and Type	Method and Description
Collection<Uuid>	clusterLinkIds()
boolean	equals(Object o)
int	hashCode()
String	host() Return the host or `*` for all hosts.
boolean	isUnknown() Return true if this AclResource has any UNKNOWN components.
AclOperation	operation() Return the AclOperation.
AclPermissionType	permissionType() Return the AclPermissionType.
String	principal() Return the principal for this entry.
AccessControlEntryFilter	toFilter() Create a filter which matches only this AccessControlEntry.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessControlEntry

public AccessControlEntry(String principal,
                          String host,
                          AclOperation operation,
                          AclPermissionType permissionType)

Create an instance of an access control entry with the provided parameters.

Parameters:

principal - non-null principal

host - non-null host

operation - non-null operation, ANY is not an allowed operation

permissionType - non-null permission type, ANY is not an allowed type

AccessControlEntry

public AccessControlEntry(String principal,
                          String host,
                          AclOperation operation,
                          AclPermissionType permissionType,
                          Collection<Uuid> clusterLinkIds)

Create an instance of an access control entry with the provided parameters.

Parameters:

principal - non-null principal

host - non-null host

operation - non-null operation, ANY is not an allowed operation

permissionType - non-null permission type, ANY is not an allowed type

clusterLinkIds - Cluster link ids associated with this ACL or empty collection if not migrated by a link

Method Detail

principal

public String principal()

Return the principal for this entry.

host

public String host()

Return the host or `*` for all hosts.

operation

public AclOperation operation()

Return the AclOperation. This method will never return AclOperation.ANY.

permissionType

public AclPermissionType permissionType()

Return the AclPermissionType. This method will never return AclPermissionType.ANY.

clusterLinkIds

@Confluent
public Collection<Uuid> clusterLinkIds()

toFilter

public AccessControlEntryFilter toFilter()

Create a filter which matches only this AccessControlEntry.

toString

public String toString()

Overrides:

toString in class Object

isUnknown

public boolean isUnknown()

Return true if this AclResource has any UNKNOWN components.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object