etri.sdn.controller.module.storage

Class OFMStorageManager

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.storage.OFMStorageManager

All Implemented Interfaces:

IService, IStorageService

public class OFMStorageManager
extends OFModule
implements IStorageService

This class enables persistent storage for the controller. Concurrency note: attributes and parameters of a context are stored in concurrent collections that guarantee thread safe access and modification. If several threads concurrently access objects and modify these collections, they should synchronize on the lock of the Context instance. Since Aug 11, 2013 Last Modified Aug 12, 2013

Author:

SaeHyong Park (labry@etri.re.kr)

Field Summary

Fields

Modifier and Type	Field and Description
private com.mongodb.DB	db
private com.mongodb.MongoClient	mongoClient
private org.codehaus.jackson.map.ObjectMapper	om
private Storage	storage

Fields inherited from class etri.sdn.controller.OFModule

controller

Constructor Summary

Constructors

Constructor and Description
OFMStorageManager()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> query)
boolean	delete(java.lang.String dbName, java.lang.String collection, java.lang.String r)
void	dropDB(java.lang.String dbName)
void	dropIndex(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key)
void	ensureIndex(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getIndex(java.lang.String dbName, java.lang.String collection)
OFModel[]	getModels() returns the array of all OFModel objects associated with this module.
protected boolean	handleDisconnect(Connection conn) Process the disconnection event from a switch.
protected boolean	handleHandshakedEvent(Connection conn, MessageContext context) An abstract method that all subclasses should implement.
protected boolean	handleMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) Handle incoming messages that pass the test of filters.
protected void	initialize() method that initializes this module.
boolean	insert(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> query) inserts a Map object into a persistent storage return true when successful and false in other cases
boolean	insert(java.lang.String dbName, java.lang.String collection, java.lang.String r) inserts a JSON style String object into a persistent storage return true when successful and false in other cases
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	retrieve(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> query)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	retrieveAll(java.lang.String dbName, java.lang.String collection)
java.util.List<java.lang.String>	retrieveAsString(java.lang.String dbName, java.lang.String collection, java.lang.String query)
java.util.List<java.lang.String>	retrieveAsStringAll(java.lang.String dbName, java.lang.String collection)
java.util.List<java.lang.String>	retrieveDBs()
boolean	update(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key, java.util.Map<java.lang.String,java.lang.Object> query)
boolean	update(java.lang.String dbName, java.lang.String collection, java.lang.String key, java.lang.String query)
boolean	upsert(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key, java.util.Map<java.lang.String,java.lang.Object> query)
boolean	upsert(java.lang.String dbName, java.lang.String collection, java.lang.String key, java.lang.String query)

Methods inherited from class etri.sdn.controller.OFModule

getController, getModule, init, processDisconnect, processHandshakeFinished, processMessage, registerFilter, registerModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mongoClient

private com.mongodb.MongoClient mongoClient

db

private com.mongodb.DB db

om

private org.codehaus.jackson.map.ObjectMapper om

storage

private Storage storage

Constructor Detail

OFMStorageManager

public OFMStorageManager()

Method Detail

initialize

protected void initialize()

Description copied from class: OFModule

method that initializes this module. Subclass of OFModule must implement this method. You can find the example of this method in OFMLinkDiscovery.initialize().

Specified by:

initialize in class OFModule

insert

public boolean insert(java.lang.String dbName,
             java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> query)
               throws StorageException

inserts a Map object into a persistent storage return true when successful and false in other cases

Specified by:

insert in interface IStorageService

Parameters:

dbName - name of the database

collection - name of collection for the database

query - Map type data to be inserted

Returns:

returns true when inserted, false when fails to insert

Throws:

StorageException

insert

public boolean insert(java.lang.String dbName,
             java.lang.String collection,
             java.lang.String r)
               throws StorageException

inserts a JSON style String object into a persistent storage return true when successful and false in other cases

Specified by:

insert in interface IStorageService

Parameters:

dbName - name of the database

collection - name of collection for the database

query - JSON style String data to be inserted

Returns:

returns true when inserted, false when fails to insert

Throws:

StorageException

delete

public boolean delete(java.lang.String dbName,
             java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> query)
               throws StorageException

Specified by:

delete in interface IStorageService

Throws:

StorageException

delete

public boolean delete(java.lang.String dbName,
             java.lang.String collection,
             java.lang.String r)
               throws StorageException

Specified by:

delete in interface IStorageService

Throws:

StorageException

update

public boolean update(java.lang.String dbName,
             java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> key,
             java.util.Map<java.lang.String,java.lang.Object> query)
               throws StorageException

Specified by:

update in interface IStorageService

Throws:

StorageException

update

public boolean update(java.lang.String dbName,
             java.lang.String collection,
             java.lang.String key,
             java.lang.String query)
               throws StorageException

Specified by:

update in interface IStorageService

Throws:

StorageException

upsert

public boolean upsert(java.lang.String dbName,
             java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> key,
             java.util.Map<java.lang.String,java.lang.Object> query)
               throws StorageException

Specified by:

upsert in interface IStorageService

Throws:

StorageException

upsert

public boolean upsert(java.lang.String dbName,
             java.lang.String collection,
             java.lang.String key,
             java.lang.String query)
               throws StorageException

Specified by:

upsert in interface IStorageService

Throws:

StorageException

retrieveAsStringAll

public java.util.List<java.lang.String> retrieveAsStringAll(java.lang.String dbName,
                                                   java.lang.String collection)
                                                     throws StorageException

Specified by:

retrieveAsStringAll in interface IStorageService

Throws:

StorageException

retrieveAsString

public java.util.List<java.lang.String> retrieveAsString(java.lang.String dbName,
                                                java.lang.String collection,
                                                java.lang.String query)
                                                  throws StorageException

Specified by:

retrieveAsString in interface IStorageService

Throws:

StorageException

retrieve

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> retrieve(java.lang.String dbName,
                                                                        java.lang.String collection,
                                                                        java.util.Map<java.lang.String,java.lang.Object> query)
                                                                          throws StorageException

Specified by:

retrieve in interface IStorageService

Throws:

StorageException

retrieveAll

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> retrieveAll(java.lang.String dbName,
                                                                           java.lang.String collection)
                                                                             throws StorageException

Specified by:

retrieveAll in interface IStorageService

Throws:

StorageException

ensureIndex

public void ensureIndex(java.lang.String dbName,
               java.lang.String collection,
               java.util.Map<java.lang.String,java.lang.Object> key)
                 throws StorageException

Specified by:

ensureIndex in interface IStorageService

Throws:

StorageException

dropIndex

public void dropIndex(java.lang.String dbName,
             java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> key)
               throws StorageException

Specified by:

dropIndex in interface IStorageService

Throws:

StorageException

getIndex

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getIndex(java.lang.String dbName,
                                                                        java.lang.String collection)
                                                                          throws StorageException

Specified by:

getIndex in interface IStorageService

Throws:

StorageException

retrieveDBs

public java.util.List<java.lang.String> retrieveDBs()
                                             throws StorageException

Specified by:

retrieveDBs in interface IStorageService

Throws:

StorageException

dropDB

public void dropDB(java.lang.String dbName)
            throws StorageException

Specified by:

dropDB in interface IStorageService

Throws:

StorageException

handleHandshakedEvent

protected boolean handleHandshakedEvent(Connection conn,
                            MessageContext context)

Description copied from class: OFModule

An abstract method that all subclasses should implement. This method is called after FEATURE-REQUEST and FEATURE-REPLY is correct exchanged, by OFModule.processHandshakeFinished(Connection, MessageContext). Normally, most of modules have very simple implementation for this method, only returning true.

Specified by:

handleHandshakedEvent in class OFModule

Parameters:

conn - connection that the event has occurred

context - message context for the handshaking messages

Returns:

true is returned when the event has been correctly processed. false otherwise.

handleMessage

protected boolean handleMessage(Connection conn,
                    MessageContext context,
                    org.openflow.protocol.OFMessage msg,
                    java.util.List<org.openflow.protocol.OFMessage> outgoing)

Description copied from class: OFModule

Handle incoming messages that pass the test of filters. All subclasses of OFModule must implement this method. This method is called by OFModule.processMessage(Connection, MessageContext, OFMessage, List).

Specified by:

handleMessage in class OFModule

Parameters:

conn - connection that the message has arrived

context - message context for the message

msg - the actual message object

outgoing - responses for the message arrived, which is filled by the handleMessage implementation

Returns:

true if the message has been correctly processed. false otherwise.

handleDisconnect

protected boolean handleDisconnect(Connection conn)

Description copied from class: OFModule

Process the disconnection event from a switch. This callback method is called by OFModule.processDisconnect(Connection). All subclasses of OFModule should implement this method.

Specified by:

handleDisconnect in class OFModule

Parameters:

conn - connection that the event has occurred

Returns:

true if the event has been correctly processed. false otherwise.

getModels

public OFModel[] getModels()

Description copied from class: OFModule

returns the array of all OFModel objects associated with this module. Normally the size of the array is one, but not limited to.

Specified by:

getModels in class OFModule

Returns:

the array of OFModel objects