etri.sdn.controller.module.storagemanager

Class OFMStorageManager

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.storagemanager.OFMStorageManager

All Implemented Interfaces:

IService, IStorageService

public class OFMStorageManager
extends OFModule
implements IStorageService

This class enables a persistent storage for the controller. Since Aug 11, 2013 Last Modified Aug 20, 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) deletes data that matches the JSON style query from the persistent storage.
boolean	delete(java.lang.String dbName, java.lang.String collection, java.lang.String r) deletes data that matches the JSON style query from the persistent storage.
void	dropDB(java.lang.String dbName) drops DBs in the persistent storage.
void	dropIndex(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key) drops a key-value pair as an index to ensure the uniqueness in the persistent storage.
void	ensureIndex(java.lang.String dbName, java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> key) assigns a key-value pair to ensure the uniqueness of the key-value pair in the persistent storage.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getIndex(java.lang.String dbName, java.lang.String collection) retrieves all assigned key-value pairs in the persistent storage.
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, and returns true when insertion is successful and returns 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.
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) retrieves data that matches the JSON style query from the persistent storage, and returns data as List of Map type.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	retrieveAll(java.lang.String dbName, java.lang.String collection) retrieves all data from the persistent storage, and returns data as List of Map type.
java.util.List<java.lang.String>	retrieveAsString(java.lang.String dbName, java.lang.String collection, java.lang.String query) retrieves data that matches the JSON style query from the persistent storage.
java.util.List<java.lang.String>	retrieveAsStringAll(java.lang.String dbName, java.lang.String collection) retrieves all data from the persistent storage in the specific collection, and returns data as List of String.
java.util.List<java.lang.String>	retrieveDBs() retrieves names of DBs in the persistent storage.
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) updates data that matches the JSON style key from the persistent storage.
boolean	update(java.lang.String dbName, java.lang.String collection, java.lang.String key, java.lang.String query) updates data that matches the JSON style key from the persistent storage.
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) upserts data that matches the JSON style key from the persistent storage.
boolean	upsert(java.lang.String dbName, java.lang.String collection, java.lang.String key, java.lang.String query) upserts data that matches the JSON style key from the persistent storage.

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, and returns true when insertion is successful and returns 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. returns 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.

r - 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

deletes data that matches the JSON style query from the persistent storage. returns true when successful and false in other cases.

Specified by:

delete in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

query - Map type query to delete the matching data from the persistent storage.

Returns:

returns true when deleted, false when fails to delete.

Throws:

StorageException

delete

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

deletes data that matches the JSON style query from the persistent storage. returns true when successful and false in other cases.

Specified by:

delete in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

r - JSON style String query to delete the matching data from the persistent storage.

Returns:

returns true when deleted, false when fails to delete.

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

updates data that matches the JSON style key from the persistent storage. The method does not update data with query when there is no matching key in the storage. returns true when successful and false in other cases.

Specified by:

update in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - Map type key to update the matching data from the persistent storage.

query - Map type query to update the matching data from the persistent storage. In case of matching data, the matching data is replaced with the query and original key and value pairs are lost, and if you want to keep the original key-value pairs while updating the data, then you should use "$set" as key and the query as value.

Returns:

returns true when updated, false when fails to update.

Throws:

StorageException

update

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

updates data that matches the JSON style key from the persistent storage. The method does not update data with query when there is no matching key in the storage. returns true when successful and false in other cases

Specified by:

update in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - JSON style String key to update the matching data from the persistent storage.

query - JSON style String query to update the matching data from the persistent storage. In case of matching data, the matching data is replaced with the query and original key and value pairs are lost, and if you want to keep the original key-value pairs while updating the data, then you should use "$set" as key and the query as value.

Returns:

returns true when updated, false when fails to update.

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

upserts data that matches the JSON style key from the persistent storage. The method inserts the query when there is no matching key in the storage. In case there is a matching key, it performs update operation. returns true when successful and false in other cases.

Specified by:

upsert in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - Map type key to upsert the matching data from the persistent storage.

query - Map type query to upsert the matching data from the persistent storage. In case of matching data, the matching data is replaced with the query and some original key and value pairs can be lost, and if you want to keep all of the original key-value pairs while upserting the data, then you should use "$set" as key and the query as value.

Returns:

returns true when updated, false when fails to update.

Throws:

StorageException

upsert

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

upserts data that matches the JSON style key from the persistent storage. The method inserts the query when there is no matching key in the storage. In case there is a matching key, it performs update operation. returns true when successful and false in other cases.

Specified by:

upsert in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - JSON style String key to upsert the matching data from the persistent storage.

query - JSON style String query to upsert the matching data from the persistent storage. In case of matching data, the matching data is replaced with the query and some original key and value pairs can be lost, and if you want to keep all of the original key-value pairs while upserting the data, then you should use "$set" as key and the query as value.

Returns:

returns true when updated, false when fails to update.

Throws:

StorageException

retrieveAsStringAll

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

retrieves all data from the persistent storage in the specific collection, and returns data as List of String. The method removes "_id" key-value pair which MongoDB automatically attaches to data.

Specified by:

retrieveAsStringAll in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

Returns:

returns data as List of String.

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

retrieves data that matches the JSON style query from the persistent storage. and returns data as List of String. The method removes "_id" key-value pair which MongoDB automatically attaches to data.

Specified by:

retrieveAsString in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

query - JSON style String query to retrieve the matching data from the persistent storage.

Returns:

returns data as List of String.

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

retrieves data that matches the JSON style query from the persistent storage, and returns data as List of Map type. The method removes "_id" key-value pair which MongoDB automatically attaches to data.

Specified by:

retrieve in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

query - Map type query to retrieve the matching data from the persistent storage.

Returns:

returns data as List of Map data.

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

retrieves all data from the persistent storage, and returns data as List of Map type. The method removes "_id" key-value pair which MongoDB automatically attaches to data.

Specified by:

retrieveAll in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

Returns:

returns data as List of Map data.

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

assigns a key-value pair to ensure the uniqueness of the key-value pair in the persistent storage.

Specified by:

ensureIndex in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - key-value pair to be unique in the persistent storage. This key-value pair should have follow pattern {"key": 1} or {"key": -1} 1 means ascending order and -1 means descending order.

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

drops a key-value pair as an index to ensure the uniqueness in the persistent storage.

Specified by:

dropIndex in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

key - key-value pair to be dropped as an index in the persistent storage.

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

retrieves all assigned key-value pairs in the persistent storage.

Specified by:

getIndex in interface IStorageService

Parameters:

dbName - name of the persistent storage.

collection - name of collection for the persistent storage.

Throws:

StorageException

retrieveDBs

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

retrieves names of DBs in the persistent storage.

Specified by:

retrieveDBs in interface IStorageService

Returns:

List of String type names of DBs in the persistent storage

Throws:

StorageException

dropDB

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

drops DBs in the persistent storage.

Specified by:

dropDB in interface IStorageService

Parameters:

dbName - name of the persistent storage.

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