A C D E G H I P R S T V

A

addClusterCertificate(String, InputStream) - Method in class io.goshawkdb.client.Certs

Loads a single X.509 certificate from the provided InputStream into the current KeyStore.

addClusterCertificate(String, byte[]) - Method in class io.goshawkdb.client.Certs

Helper in case the cluster certificate is already loaded is a byte[]

apply(Transaction) - Method in interface io.goshawkdb.client.TransactionFunction

The callback invoked (potentially several times) to run your transaction.

asBytes() - Method in class io.goshawkdb.client.VarUUId

Returns the object identifier as a byte array.

awaitClose() - Method in class io.goshawkdb.client.Connection

Blocks until the connection has been closed.

C

canRead() - Method in enum io.goshawkdb.client.Capability

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

canWrite() - Method in enum io.goshawkdb.client.Capability

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

Capability - Enum in io.goshawkdb.client

GoshawkDB provides security through use of Object Capabilities.

cause - Variable in class io.goshawkdb.client.TransactionResult

Certs - Class in io.goshawkdb.client

Class for managing the cluster ECDSA certificate and public key, and the client ECDSA certificate and key pair.

Certs() - Constructor for class io.goshawkdb.client.Certs

Create a new Certs.

CIPHER - Static variable in class io.goshawkdb.client.Certs

close() - Method in class io.goshawkdb.client.Connection

Close the connection.

connect(Certs, String) - Method in class io.goshawkdb.client.ConnectionFactory

Create and start a connection to a GoshawkDB node using the default port (7894)

connect(Certs, String, int) - Method in class io.goshawkdb.client.ConnectionFactory

Create and start a connection to a GoshawkDB node using the specified port

Connection - Class in io.goshawkdb.client

Objects of this type represent connections to a GoshawkDB node and are created through use of the ConnectionFactory.

ConnectionFactory - Class in io.goshawkdb.client

This class is used to construct connections to a GoshawkDB node or cluster.

ConnectionFactory() - Constructor for class io.goshawkdb.client.ConnectionFactory

Create a new ConnectionFactory using a new NioEventLoopGroup

ConnectionFactory(EventLoopGroup) - Constructor for class io.goshawkdb.client.ConnectionFactory

Create a new ConnectionFactory

createObject(ByteBuffer, GoshawkObjRef...) - Method in interface io.goshawkdb.client.Transaction

Create a new object and set its value and references.

D

DEFAULT_PORT - Static variable in class io.goshawkdb.client.ConnectionFactory

E

e - Static variable in exception io.goshawkdb.client.TransactionAbortedException

equals(Object) - Method in class io.goshawkdb.client.TxnId

equals(Object) - Method in class io.goshawkdb.client.VarUUId

G

getObjCapability() - Method in class io.goshawkdb.client.GoshawkObjRef

Gets the Capability on the underlying Object.

getObject(GoshawkObjRef) - Method in interface io.goshawkdb.client.Transaction

Fetches the object specified by a reference.

getRefCapability() - Method in class io.goshawkdb.client.GoshawkObjRef

Gets the Capability from this reference.

getReferences() - Method in class io.goshawkdb.client.GoshawkObjRef

Get the objects pointed to from the current object.

getRoots() - Method in interface io.goshawkdb.client.Transaction

Get the roots of the object-graph.

getValue() - Method in class io.goshawkdb.client.GoshawkObjRef

Returns the current value of this object.

getVersion() - Method in class io.goshawkdb.client.GoshawkObjRef

Get the current version of the object.

GoshawkObjRef - Class in io.goshawkdb.client

This class represents references (or pointers) to Objects within GoshawkDB.

grantCapability(Capability) - Method in class io.goshawkdb.client.GoshawkObjRef

Create a new GoshawkObjRef to the same database object but with different capabilities.

group - Variable in class io.goshawkdb.client.ConnectionFactory

H

hashCode() - Method in class io.goshawkdb.client.TxnId

hashCode() - Method in class io.goshawkdb.client.VarUUId

I

id - Variable in class io.goshawkdb.client.GoshawkObjRef

The unique identifier of the object to which this reference refers.

io.goshawkdb.client - package io.goshawkdb.client

isAborted() - Method in class io.goshawkdb.client.TransactionResult

Returns true iff an exception was thrown during the execution of the transaction and that exception was a TransactionAbortedException

isConnected() - Method in class io.goshawkdb.client.Connection

Test to see if we're connected to the GoshawkDB node

isSuccessful() - Method in class io.goshawkdb.client.TransactionResult

Returns true iff the transaction committed.

P

parseClientPEM(Reader) - Method in class io.goshawkdb.client.Certs

Parse the contents of the provided Reader for an X.509 Certificate with public key, and a PEM Key Pair, and calls setClientCertificateHolder and setClientKeyPair as appropriate.

R

referencesSameAs(GoshawkObjRef) - Method in class io.goshawkdb.client.GoshawkObjRef

Test to see if two GoshawkObjRefs refer (point) to the same underlying Object.

result - Variable in class io.goshawkdb.client.TransactionResult

retry() - Method in interface io.goshawkdb.client.Transaction

Perform a retry operation.

runTransaction(TransactionFunction<R>) - Method in class io.goshawkdb.client.Connection

Run a transaction.

S

set(ByteBuffer, GoshawkObjRef...) - Method in class io.goshawkdb.client.GoshawkObjRef

Sets the value and references of the current object.

setClientCertificateHolder(X509CertificateHolder) - Method in class io.goshawkdb.client.Certs

Set the ClientCertificateHolder.

setClientKeyPair(PEMKeyPair) - Method in class io.goshawkdb.client.Certs

Set the ClientKeyPair.

setKeyStore(KeyStore) - Method in class io.goshawkdb.client.Certs

Provided in case you wish to provide your own keystore (for example one that is stored on disk rather than an ephemeral one).

T

toString() - Method in class io.goshawkdb.client.GoshawkObjRef

toString() - Method in class io.goshawkdb.client.TxnId

toString() - Method in class io.goshawkdb.client.VarUUId

Transaction - Interface in io.goshawkdb.client

An object of this type is supplied to TransactionFunctions to provide access to the object graph stored by GoshawkDB.

TransactionAbortedException - Exception in io.goshawkdb.client

Throw this exception to indicate the current transaction should be aborted.

TransactionAbortedException() - Constructor for exception io.goshawkdb.client.TransactionAbortedException

TransactionAbortedException(Exception) - Constructor for exception io.goshawkdb.client.TransactionAbortedException

TransactionFunction<R> - Interface in io.goshawkdb.client

Implement this interface to create transaction funs that can be passed to Connection's runTransaction.

TransactionResult<R> - Class in io.goshawkdb.client

Encloses the result of the transaction (assuming it committed) with the TxnId of the transaction.

txnid - Variable in class io.goshawkdb.client.TransactionResult

TxnId - Class in io.goshawkdb.client

Representation of GoshawkDB Transaction Ids.

V

valueOf(String) - Static method in enum io.goshawkdb.client.Capability

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.goshawkdb.client.Capability

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

VarUUId - Class in io.goshawkdb.client

Representation of GoshawkDB Object Ids.

A C D E G H I P R S T V