org.onosproject.mapping

Interface MappingAdminService

All Superinterfaces:

org.onosproject.event.ListenerService<MappingEvent,MappingListener>, MappingService

public interface MappingAdminService
extends MappingService

Service for administering the mapping management.

Method Summary

Modifier and Type	Method and Description
void	purgeMappings(MappingStore.Type type, org.onosproject.net.DeviceId deviceId) Purges all mappings on the specified device and mapping store.
void	removeMappingEntries(MappingStore.Type type, MappingEntry... entries) Removes the specified mapping entries from their respective devices and mapping store.
void	removeMappingEntriesByAppId(MappingStore.Type type, org.onosproject.core.ApplicationId appId) Removes all mapping entries submitted by a particular application.
void	storeMappingEntry(MappingStore.Type type, MappingEntry entry) Stores a mapping entry.

Methods inherited from interface org.onosproject.mapping.MappingService

getAllMappingEntries, getMappingCount, getMappingEntries, getMappingEntriesByAppId

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

storeMappingEntry

void storeMappingEntry(MappingStore.Type type,
                       MappingEntry entry)

Stores a mapping entry.

Parameters:

type - mapping store type

entry - mapping entry to be stored

removeMappingEntries

void removeMappingEntries(MappingStore.Type type,
                          MappingEntry... entries)

Removes the specified mapping entries from their respective devices and mapping store.

Parameters:

type - mapping store type

entries - one or more mapping entries

removeMappingEntriesByAppId

void removeMappingEntriesByAppId(MappingStore.Type type,
                                 org.onosproject.core.ApplicationId appId)

Removes all mapping entries submitted by a particular application.

Parameters:

type - mapping store type

appId - identifier of application whose mapping entries will be removed

purgeMappings

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

Purges all mappings on the specified device and mapping store. Note that the mappings will only be removed from storage, the mappings are still remaining in the device.

Parameters:

type - mapping store type

deviceId - device identifier