Package org.apache.kafka.common.acl

Class AclBindingFilter

java.lang.Object

org.apache.kafka.common.acl.AclBindingFilter

@Evolving
public class AclBindingFilter
extends Object

A filter which can match AclBinding objects. The API for this class is still evolving and we may break compatibility in minor releases, if necessary.

Field Summary

Fields

Modifier and Type	Field	Description
static AclBindingFilter	ANY	A filter which matches any ACL binding.

Constructor Summary

Constructors

Constructor	Description
AclBindingFilter(ResourceFilter resourceFilter, AccessControlEntryFilter entryFilter)	Deprecated. Since 2.0.
AclBindingFilter(ResourcePatternFilter patternFilter, AccessControlEntryFilter entryFilter)	Create an instance of this filter with the provided parameters.

Method Summary

Modifier and Type	Method	Description
AccessControlEntryFilter	entryFilter()
boolean	equals(Object o)
String	findIndefiniteField()	Return a string describing an ANY or UNKNOWN field, or null if there is no such field.
int	hashCode()
boolean	isUnknown()
boolean	matches(AclBinding binding)	Return true if the resource filter matches the binding's resource and the entry filter matches binding's entry.
boolean	matchesAtMostOne()	Return true if the resource and entry filters can only match one ACE.
ResourcePatternFilter	patternFilter()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ANY

public static final AclBindingFilter ANY

A filter which matches any ACL binding.

Constructor Detail

AclBindingFilter

public AclBindingFilter(ResourcePatternFilter patternFilter,
                        AccessControlEntryFilter entryFilter)

Create an instance of this filter with the provided parameters.

Parameters:

patternFilter - non-null pattern filter

entryFilter - non-null access control entry filter

AclBindingFilter

@Deprecated
public AclBindingFilter(ResourceFilter resourceFilter,
                        AccessControlEntryFilter entryFilter)

Deprecated.

Since 2.0. Use AclBindingFilter(ResourcePatternFilter, AccessControlEntryFilter)

Create an instance of this filter with the provided parameters.

Parameters:

resourceFilter - non-null resource filter

entryFilter - non-null access control entry filter

Method Detail

isUnknown

public boolean isUnknown()

Returns:

true if this filter has any UNKNOWN components.

patternFilter

public ResourcePatternFilter patternFilter()

Returns:

the resource pattern filter.

entryFilter

public final AccessControlEntryFilter entryFilter()

Returns:

the access control entry filter.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

matchesAtMostOne

public boolean matchesAtMostOne()

Return true if the resource and entry filters can only match one ACE. In other words, if there are no ANY or UNKNOWN fields.

findIndefiniteField

public String findIndefiniteField()

Return a string describing an ANY or UNKNOWN field, or null if there is no such field.

matches

public boolean matches(AclBinding binding)

Return true if the resource filter matches the binding's resource and the entry filter matches binding's entry.

hashCode

public int hashCode()

Overrides:

hashCode in class Object