org.onosproject.store.primitives.resources.impl

Class AtomixDocumentTree

java.lang.Object

io.atomix.resource.AbstractResource<AtomixDocumentTree>

org.onosproject.store.primitives.resources.impl.AtomixDocumentTree

All Implemented Interfaces:

io.atomix.catalyst.util.Managed<AtomixDocumentTree>, io.atomix.resource.Resource<AtomixDocumentTree>, org.onosproject.store.service.AsyncDocumentTree<byte[]>, org.onosproject.store.service.DistributedPrimitive

public class AtomixDocumentTree
extends io.atomix.resource.AbstractResource<AtomixDocumentTree>
implements org.onosproject.store.service.AsyncDocumentTree<byte[]>

Distributed resource providing the AsyncDocumentTree primitive.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

org.onosproject.store.service.DistributedPrimitive.Status, org.onosproject.store.service.DistributedPrimitive.Type

Nested classes/interfaces inherited from interface io.atomix.resource.Resource

io.atomix.resource.Resource.Config, io.atomix.resource.Resource.Options, io.atomix.resource.Resource.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_SUBJECT

Fields inherited from class io.atomix.resource.AbstractResource

client, config, options

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AtomixDocumentTree(io.atomix.copycat.client.CopycatClient client, Properties options)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addListener(org.onosproject.store.service.DocumentPath path, org.onosproject.store.service.DocumentTreeListener<byte[]> listener)
CompletableFuture<Boolean>	create(org.onosproject.store.service.DocumentPath path, byte[] value)
CompletableFuture<Boolean>	createRecursive(org.onosproject.store.service.DocumentPath path, byte[] value)
CompletableFuture<Void>	destroy()
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	get(org.onosproject.store.service.DocumentPath path)
CompletableFuture<Map<String,org.onosproject.store.service.Versioned<byte[]>>>	getChildren(org.onosproject.store.service.DocumentPath path)
String	name()
CompletableFuture<AtomixDocumentTree>	open()
org.onosproject.store.service.DistributedPrimitive.Type	primitiveType()
CompletableFuture<Void>	removeListener(org.onosproject.store.service.DocumentTreeListener<byte[]> listener)
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	removeNode(org.onosproject.store.service.DocumentPath path)
CompletableFuture<Boolean>	replace(org.onosproject.store.service.DocumentPath path, byte[] newValue, byte[] currentValue)
CompletableFuture<Boolean>	replace(org.onosproject.store.service.DocumentPath path, byte[] newValue, long version)
org.onosproject.store.service.DocumentPath	root()
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	set(org.onosproject.store.service.DocumentPath path, byte[] value)

Methods inherited from class io.atomix.resource.AbstractResource

close, config, context, delete, equals, hashCode, isClosed, isOpen, onStateChange, options, serializer, state, toString, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.service.AsyncDocumentTree

addListener

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

addStatusChangeListener, applicationId, removeStatusChangeListener, statusChangeListeners

Field Detail

CHANGE_SUBJECT

public static final String CHANGE_SUBJECT

See Also:

Constant Field Values

Constructor Detail

AtomixDocumentTree

protected AtomixDocumentTree(io.atomix.copycat.client.CopycatClient client,
                             Properties options)

Method Detail

open

public CompletableFuture<AtomixDocumentTree> open()

Specified by:

open in interface io.atomix.catalyst.util.Managed<AtomixDocumentTree>

Specified by:

open in interface io.atomix.resource.Resource<AtomixDocumentTree>

Overrides:

open in class io.atomix.resource.AbstractResource<AtomixDocumentTree>

name

public String name()

Specified by:

name in interface org.onosproject.store.service.DistributedPrimitive

primitiveType

public org.onosproject.store.service.DistributedPrimitive.Type primitiveType()

Specified by:

primitiveType in interface org.onosproject.store.service.DistributedPrimitive

destroy

public CompletableFuture<Void> destroy()

Specified by:

destroy in interface org.onosproject.store.service.DistributedPrimitive

root

public org.onosproject.store.service.DocumentPath root()

Specified by:

root in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

getChildren

public CompletableFuture<Map<String,org.onosproject.store.service.Versioned<byte[]>>> getChildren(org.onosproject.store.service.DocumentPath path)

Specified by:

getChildren in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

get

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> get(org.onosproject.store.service.DocumentPath path)

Specified by:

get in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

set

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> set(org.onosproject.store.service.DocumentPath path,
                                                                              byte[] value)

Specified by:

set in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

create

public CompletableFuture<Boolean> create(org.onosproject.store.service.DocumentPath path,
                                         byte[] value)

Specified by:

create in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

createRecursive

public CompletableFuture<Boolean> createRecursive(org.onosproject.store.service.DocumentPath path,
                                                  byte[] value)

Specified by:

createRecursive in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

replace

public CompletableFuture<Boolean> replace(org.onosproject.store.service.DocumentPath path,
                                          byte[] newValue,
                                          long version)

Specified by:

replace in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

replace

public CompletableFuture<Boolean> replace(org.onosproject.store.service.DocumentPath path,
                                          byte[] newValue,
                                          byte[] currentValue)

Specified by:

replace in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

removeNode

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> removeNode(org.onosproject.store.service.DocumentPath path)

Specified by:

removeNode in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

addListener

public CompletableFuture<Void> addListener(org.onosproject.store.service.DocumentPath path,
                                           org.onosproject.store.service.DocumentTreeListener<byte[]> listener)

Specified by:

addListener in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>

removeListener

public CompletableFuture<Void> removeListener(org.onosproject.store.service.DocumentTreeListener<byte[]> listener)

Specified by:

removeListener in interface org.onosproject.store.service.AsyncDocumentTree<byte[]>