org.onosproject.mapping

Interface MappingService

All Superinterfaces:

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

All Known Subinterfaces:

MappingAdminService

public interface MappingService
extends org.onosproject.event.ListenerService<MappingEvent,MappingListener>

Interface of mapping management service.

Method Summary

Modifier and Type	Method and Description
Iterable<MappingEntry>	getAllMappingEntries(MappingStore.Type type) Obtains the collection of mapping entries of all devices.
int	getMappingCount(MappingStore.Type type) Obtains the number of mappings in the system.
Iterable<MappingEntry>	getMappingEntries(MappingStore.Type type, org.onosproject.net.DeviceId deviceId) Obtains the collection of mapping entries applied on the specific device.
Iterable<MappingEntry>	getMappingEntriesByAppId(MappingStore.Type type, org.onosproject.core.ApplicationId appId) Obtains the collection of mapping entries with a given application ID.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

getMappingCount

int getMappingCount(MappingStore.Type type)

Obtains the number of mappings in the system.

Parameters:

type - mapping store type

Returns:

mapping count

getAllMappingEntries

Iterable<MappingEntry> getAllMappingEntries(MappingStore.Type type)

Obtains the collection of mapping entries of all devices. This will include mapping which may not yet have been applied to device.

Parameters:

type - mapping store type

Returns:

collection of mapping entries

getMappingEntries

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

Obtains the collection of mapping entries applied on the specific device. The will include mapping which may not yet have been applied to device.

Parameters:

type - mapping store type

deviceId - device identifier

Returns:

collection of mapping entries

getMappingEntriesByAppId

Iterable<MappingEntry> getMappingEntriesByAppId(MappingStore.Type type,
                                                org.onosproject.core.ApplicationId appId)

Obtains the collection of mapping entries with a given application ID.

Parameters:

type - mapping store type

appId - application identifier

Returns:

collection of mapping entries