com.mware.ge.security

Class SecurityAuthorizations

java.lang.Object

com.mware.ge.security.SecurityAuthorizations

All Implemented Interfaces:

Serializable, Iterable<byte[]>

public class SecurityAuthorizations
extends Object
implements Iterable<byte[]>, Serializable

A collection of authorization strings.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SecurityAuthorizations	EMPTY An empty set of authorizations.

Constructor Summary

Constructors

Constructor and Description
SecurityAuthorizations() Constructs an empty set of authorizations.
SecurityAuthorizations(Collection<byte[]> authorizations) Constructs an authorization object from a collection of string authorizations that have each already been encoded as UTF-8 bytes.
SecurityAuthorizations(List<ByteBuffer> authorizations) Constructs an authorization object from a list of string authorizations that have each already been encoded as UTF-8 bytes.
SecurityAuthorizations(String... authorizations) Constructs an authorizations object from a set of human-readable authorizations.

Method Summary

Modifier and Type	Method and Description
boolean	contains(byte[] auth) Checks whether this object contains the given authorization.
boolean	contains(ByteSequence auth) Checks whether this object contains the given authorization.
boolean	contains(String auth) Checks whether this object contains the given authorization.
boolean	equals(Object o)
List<byte[]>	getAuthorizations() Gets the authorizations in sorted order.
List<ByteBuffer>	getAuthorizationsBB() Gets the authorizations in sorted order.
int	hashCode()
boolean	isEmpty() Checks if this collection of authorizations is empty.
Iterator<byte[]>	iterator()
int	size() Gets the size of this collection of authorizations.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static final SecurityAuthorizations EMPTY

An empty set of authorizations.

Constructor Detail

SecurityAuthorizations

public SecurityAuthorizations(Collection<byte[]> authorizations)

Constructs an authorization object from a collection of string authorizations that have each already been encoded as UTF-8 bytes. Warning: This method does not verify that each encoded string is valid UTF-8.

Parameters:

authorizations - collection of authorizations, as strings encoded in UTF-8

Throws:

IllegalArgumentException - if authorizations is null

See Also:

SecurityAuthorizations(String...)

SecurityAuthorizations

public SecurityAuthorizations(List<ByteBuffer> authorizations)

Constructs an authorization object from a list of string authorizations that have each already been encoded as UTF-8 bytes. Warning: This method does not verify that each encoded string is valid UTF-8.

Parameters:

authorizations - list of authorizations, as strings encoded in UTF-8 and placed in buffers

Throws:

IllegalArgumentException - if authorizations is null

See Also:

SecurityAuthorizations(String...)

SecurityAuthorizations

public SecurityAuthorizations()

Constructs an empty set of authorizations.

See Also:

SecurityAuthorizations(String...)

SecurityAuthorizations

public SecurityAuthorizations(String... authorizations)

Constructs an authorizations object from a set of human-readable authorizations.

Parameters:

authorizations - array of authorizations

Throws:

IllegalArgumentException - if authorizations is null

Method Detail

getAuthorizations

public List<byte[]> getAuthorizations()

Gets the authorizations in sorted order. The returned list is not modifiable.

Returns:

authorizations, each as a string encoded in UTF-8

See Also:

SecurityAuthorizations(Collection)

getAuthorizationsBB

public List<ByteBuffer> getAuthorizationsBB()

Gets the authorizations in sorted order. The returned list is not modifiable.

Returns:

authorizations, each as a string encoded in UTF-8 and within a buffer

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(byte[] auth)

Checks whether this object contains the given authorization.

Parameters:

auth - authorization, as a string encoded in UTF-8

Returns:

true if authorization is in this collection

contains

public boolean contains(ByteSequence auth)

Checks whether this object contains the given authorization. Warning: This method does not verify that the encoded string is valid UTF-8.

Parameters:

auth - authorization, as a string encoded in UTF-8

Returns:

true if authorization is in this collection

contains

public boolean contains(String auth)

Checks whether this object contains the given authorization.

Parameters:

auth - authorization

Returns:

true if authorization is in this collection

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

size

public int size()

Gets the size of this collection of authorizations.

Returns:

collection size

isEmpty

public boolean isEmpty()

Checks if this collection of authorizations is empty.

Returns:

true if this collection contains no authorizations

iterator

public Iterator<byte[]> iterator()

Specified by:

iterator in interface Iterable<byte[]>