org.opendaylight.usc.manager.api

Interface UscShardService<D extends org.opendaylight.yangtools.yang.binding.DataObject,R>

Type Parameters:

D - the type of operating data

R - the call back future for write or merge operations

All Known Implementing Classes:

UscShardServiceImpl

public interface UscShardService<D extends org.opendaylight.yangtools.yang.binding.DataObject,R>

CLustering shard data access interface

Method Summary

Modifier and Type	Method and Description
void	delete(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id) delete the data object specified by the id
void	merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id, D data) merge the children data with previous exists same data which has same identifier
void	merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id, D data, com.google.common.util.concurrent.FutureCallback<R> callback) merge the children data with callback future
D	read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id) read the Shard data which specified by the InstanceIdentifier(id) with LogicalDatastoreType(type) Note: the return data is the same type(Type D) of InstanceIdentifier
void	write(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id, D data) write the Shard data(data) which specified by the InstanceIdentifier(id) with LogicalDatastoreType(type)
void	write(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id, D data, com.google.common.util.concurrent.FutureCallback<R> callback) write the Shard data(data) with callback future

Method Detail

read

D read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
       org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id)

read the Shard data which specified by the InstanceIdentifier(id) with LogicalDatastoreType(type) Note: the return data is the same type(Type D) of InstanceIdentifier

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - the data identifier

Returns:

the data of the identifier specified

write

void write(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
           org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id,
           D data)

write the Shard data(data) which specified by the InstanceIdentifier(id) with LogicalDatastoreType(type)

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - the data identifier

data - the current writing data

write

void write(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
           org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id,
           D data,
           com.google.common.util.concurrent.FutureCallback<R> callback)

write the Shard data(data) with callback future

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - the data identifier

data - the current writing data

callback - callback class which will be called after the merge operation for dealing with the operation result

merge

void merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
           org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id,
           D data)

merge the children data with previous exists same data which has same identifier

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - the data identifier

data - the current merging source data

merge

void merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
           org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id,
           D data,
           com.google.common.util.concurrent.FutureCallback<R> callback)

merge the children data with callback future

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - the data identifier

data - the current merging source data

callback - callback class which will be called after the merge operation for dealing with the operation result

delete

void delete(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType type,
            org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> id)

delete the data object specified by the id

Parameters:

type - LogicalDatastoreType.OPERATIONAL(the data is the state result), LogicalDatastoreType.CONFIGURATION(the data is the state target)

id - specified identifier of data object