io.goshawkdb.client

Enum Capability

java.lang.Object

java.lang.Enum<Capability>

io.goshawkdb.client.Capability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Capability>

public enum Capability
extends java.lang.Enum<Capability>

GoshawkDB provides security through use of Object Capabilities. A reference / pointer to an Object within GoshawkDB contains a capability. These capabilities grant the ability for a client to read, write, both or neither, an object. The GoshawkDB server enforces that all actions within a transaction are legal based on the capabilities the client has received.

Enum Constant Summary

Enum Constants

Enum Constant and Description
None An ObjectRef with the None capability grants you no actions on the object.
Read An ObjectRef with the Read capability grants you the ability to read the object value, its version and its references.
ReadWrite An ObjectRef with the ReadWrite capability grants you both the Read and Write capabilities.
Write An ObjectRef with the Write capability grants you the ability to set (write) the object value and references.

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Tests to see if the capability is either Read or ReadWrite.
boolean	canWrite() Tests to see if the capability is either Write or ReadWrite.
static Capability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Capability[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final Capability None

An ObjectRef with the None capability grants you no actions on the object.

Read

public static final Capability Read

An ObjectRef with the Read capability grants you the ability to read the object value, its version and its references.

Write

public static final Capability Write

An ObjectRef with the Write capability grants you the ability to set (write) the object value and references.

ReadWrite

public static final Capability ReadWrite

An ObjectRef with the ReadWrite capability grants you both the Read and Write capabilities.

Method Detail

values

public static Capability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Capability c : Capability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Capability valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

canRead

public boolean canRead()

Tests to see if the capability is either Read or ReadWrite.

Returns:

true iff this == Read || this == ReadWrite;

canWrite

public boolean canWrite()

Tests to see if the capability is either Write or ReadWrite.

Returns:

true iff this == Write || this == ReadWrite;