net.floodlightcontroller.core.module
Interface IFloodlightModuleContext

All Known Implementing Classes:

FloodlightModuleContext

public interface IFloodlightModuleContext

Method Summary

java.util.Collection<IFloodlightModule>	getAllModules() Returns all loaded modules
java.util.Collection<java.lang.Class<? extends IFloodlightService>>	getAllServices() Returns all loaded services
java.util.Map<java.lang.String,java.lang.String>	getConfigParams(java.lang.Class<? extends IFloodlightModule> clazz) Gets module specific configuration parameters.
java.util.Map<java.lang.String,java.lang.String>	getConfigParams(IFloodlightModule module) Gets module specific configuration parameters.
<T extends IFloodlightService> T	getServiceImpl(java.lang.Class<T> service) Retrieves a casted version of a module from the registry.

Method Detail

getServiceImpl

<T extends IFloodlightService> T getServiceImpl(java.lang.Class<T> service)

Retrieves a casted version of a module from the registry.

Parameters:

name - The IFloodlightService object type

Returns:

The IFloodlightService

Throws:

FloodlightModuleException - If the module was not found or a ClassCastException was encountered.

getAllServices

java.util.Collection<java.lang.Class<? extends IFloodlightService>> getAllServices()

Returns all loaded services

Returns:

A collection of service classes that have been loaded

getAllModules

java.util.Collection<IFloodlightModule> getAllModules()

Returns all loaded modules

Returns:

All Floodlight modules that are going to be loaded

getConfigParams

java.util.Map<java.lang.String,java.lang.String> getConfigParams(IFloodlightModule module)

Gets module specific configuration parameters.

Parameters:

module - The module to get the configuration parameters for

Returns:

A key, value map of the configuration options

getConfigParams

java.util.Map<java.lang.String,java.lang.String> getConfigParams(java.lang.Class<? extends IFloodlightModule> clazz)

Gets module specific configuration parameters.

Parameters:

clazz - The class of the module to get configuration parameters for

Returns:

A key, value map of the configuration options