Package io.camunda.security.reader

Record Class TenantAccess

java.lang.Object

java.lang.Record

io.camunda.security.reader.TenantAccess

public record TenantAccess(boolean allowed, boolean wildcard, List<String> tenantIds)
extends Record

Constructor Summary

Constructors

Constructor	Description
TenantAccess(boolean allowed, boolean wildcard, List<String> tenantIds)	Creates an instance of a TenantAccess record class.

Method Summary

Modifier and Type	Method	Description
boolean	allowed()	Returns the value of the allowed record component.
static TenantAccess	allowed(List<String> tenantIds)	Creates a TenantAccess allowing access the tenants passed with tenantIds.
boolean	denied()	Returns true if the access to all provided tenantIds is denied.
static TenantAccess	denied(List<String> tenantIds)	Creates a TenantAccess denying access to any tenant passed with tenantIds.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<String>	tenantIds()	Returns the value of the tenantIds record component.
final String	toString()	Returns a string representation of this record class.
boolean	wildcard()	Returns the value of the wildcard record component.
static TenantAccess	wildcard(List<String> tenantIds)	Creates a TenantAccess allowing wildcard access to any tenant.

Methods inherited from class java.lang.Object

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

Constructor Details

TenantAccess

public TenantAccess(boolean allowed,
 boolean wildcard,
 List<String> tenantIds)

Creates an instance of a TenantAccess record class.

Parameters:

allowed - the value for the allowed record component

wildcard - the value for the wildcard record component

tenantIds - the value for the tenantIds record component

Method Details

denied

public boolean denied()

Returns true if the access to all provided tenantIds is denied.

allowed

public static TenantAccess allowed(List<String> tenantIds)

Creates a TenantAccess allowing access the tenants passed with tenantIds.

denied

public static TenantAccess denied(List<String> tenantIds)

Creates a TenantAccess denying access to any tenant passed with tenantIds.

wildcard

public static TenantAccess wildcard(List<String> tenantIds)

Creates a TenantAccess allowing wildcard access to any tenant.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

allowed

public boolean allowed()

Returns the value of the allowed record component.

Returns:

the value of the allowed record component

wildcard

public boolean wildcard()

Returns the value of the wildcard record component.

Returns:

the value of the wildcard record component

tenantIds

public List<String> tenantIds()

Returns the value of the tenantIds record component.

Returns:

the value of the tenantIds record component