org.onosproject.mapping

Interface MappingStore

All Superinterfaces:

org.onosproject.store.Store<MappingEvent,MappingStoreDelegate>

public interface MappingStore
extends org.onosproject.store.Store<MappingEvent,MappingStoreDelegate>

Interface of a distributed store for managing mapping information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MappingStore.Type Represents the type of mapping store.

Method Summary

Modifier and Type	Method and Description
MappingEvent	addOrUpdateMappingEntry(MappingStore.Type type, MappingEntry entry) Stores a new mapping or updates an existing entry from/to the specified store.
Iterable<MappingEntry>	getAllMappingEntries(MappingStore.Type type) Obtains all mapping entries from the specified store.
int	getMappingCount(MappingStore.Type type) Obtains the number of mapping in the specified store.
Iterable<MappingEntry>	getMappingEntries(MappingStore.Type type, org.onosproject.net.DeviceId deviceId) Obtains the mapping entries associated with a device from the specified store.
MappingEntry	getMappingEntry(MappingStore.Type type, Mapping mapping) Obtains the stored mapping from the specified store.
void	pendingDeleteMapping(MappingStore.Type type, Mapping mapping) Marks a mapping for deletion.
MappingEvent	pendingMappingEntry(MappingStore.Type type, MappingEntry entry) Marks a mapping as PENDING_ADD during retry.
void	purgeMappingEntries(MappingStore.Type type) Removes all mapping entries from the specified store.
default void	purgeMappingEntry(MappingStore.Type type, org.onosproject.net.DeviceId deviceId) Removes all mapping entries of given device from the specified store.
MappingEvent	removeMapping(MappingStore.Type type, Mapping mapping) Removes an existing mapping from the specified store.
void	storeMapping(MappingStore.Type type, MappingEntry mapping) Stores a new mapping.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

getMappingCount

int getMappingCount(MappingStore.Type type)

Obtains the number of mapping in the specified store.

Parameters:

type - store type

Returns:

number of mapping

getAllMappingEntries

Iterable<MappingEntry> getAllMappingEntries(MappingStore.Type type)

Obtains all mapping entries from the specified store.

Parameters:

type - store type

Returns:

the mapping entries

getMappingEntry

MappingEntry getMappingEntry(MappingStore.Type type,
                             Mapping mapping)

Obtains the stored mapping from the specified store.

Parameters:

type - store type

mapping - the mapping to look for

Returns:

a mapping

getMappingEntries

Iterable<MappingEntry> getMappingEntries(MappingStore.Type type,
                                         org.onosproject.net.DeviceId deviceId)

Obtains the mapping entries associated with a device from the specified store.

Parameters:

type - store type

deviceId - device identifier

Returns:

the mapping entries

storeMapping

void storeMapping(MappingStore.Type type,
                  MappingEntry mapping)

Stores a new mapping.

Parameters:

type - store type

mapping - the mapping to add

pendingDeleteMapping

void pendingDeleteMapping(MappingStore.Type type,
                          Mapping mapping)

Marks a mapping for deletion. Actual deletion will occur when the provider indicates that the mapping has been removed.

Parameters:

type - store type

mapping - the mapping to be marked as delete

removeMapping

MappingEvent removeMapping(MappingStore.Type type,
                           Mapping mapping)

Removes an existing mapping from the specified store.

Parameters:

type - store type

mapping - the mapping to remove

Returns:

mapping_removed event, or null if nothing removed

addOrUpdateMappingEntry

MappingEvent addOrUpdateMappingEntry(MappingStore.Type type,
                                     MappingEntry entry)

Stores a new mapping or updates an existing entry from/to the specified store.

Parameters:

type - store type

entry - the mapping to add or update

Returns:

mapping_added event, or null if just an update

pendingMappingEntry

MappingEvent pendingMappingEntry(MappingStore.Type type,
                                 MappingEntry entry)

Marks a mapping as PENDING_ADD during retry.

Emits mapping_update event if the state is changed

Parameters:

type - store type

entry - the mapping that is retrying

Returns:

mapping_updated event, or null if nothing updated

purgeMappingEntry

default void purgeMappingEntry(MappingStore.Type type,
                               org.onosproject.net.DeviceId deviceId)

Removes all mapping entries of given device from the specified store.

Parameters:

type - store type

deviceId - device identifier

purgeMappingEntries

void purgeMappingEntries(MappingStore.Type type)

Removes all mapping entries from the specified store.

Parameters:

type - store type