etri.sdn.controller.module.firewall

Class FirewallStorage

java.lang.Object

etri.sdn.controller.OFModel

etri.sdn.controller.module.firewall.FirewallStorage

public class FirewallStorage
extends OFModel

This class is a storage to manage firewall rules. FirewallStorage has FirewallEntryTable class which supports basic storage operations against a memory storage and a persistent database.

Author:

jshin

Nested Class Summary

Nested classes/interfaces inherited from class etri.sdn.controller.OFModel

OFModel.RESTApi, OFModel.RESTWebUI

Field Summary

Fields

Modifier and Type	Field and Description
private OFModel.RESTApi[]	apis Array of RESTApi objects.
private FirewallEntryTable	firewallEntryTable
OFMFirewall	manager
private java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
FirewallStorage(OFMFirewall manager, java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteDBEntry(IStorageService firewallDB, java.lang.String dbName, java.lang.String collectionName, int ruleid) Removes the firewall rule from database using key field of ruleid.
java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>>	getAllDBEntries(IStorageService firewallDB, java.lang.String dbName, java.lang.String collectionName) Returns all firewall rules from the database.
OFModel.RESTApi[]	getAllRestApi() Returns the list of RESTApi objects
java.util.Map<java.lang.String,java.lang.Object>	getDBEntry(IStorageService firewallDB, java.lang.String dbName, java.lang.String collectionName, int ruleid) Returns the firewall rule associated with the input ruleid from the database.
FirewallEntryTable	getFirewallEntryTable()
OFMFirewall	getManager()
java.lang.String	getName()
boolean	insertDBEntry(IStorageService firewallDB, java.lang.String dbName, java.lang.String collectionName, java.util.Map<java.lang.String,java.lang.Object> rule) Stores a new firewall rule into the persistent database.
void	printStorage() Compares entries of the memory storage and the persistent database.
void	setTableName(java.lang.String name)
void	synchronizeStorage(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> entrySet) Copies all entry of the persistent database into the memory storage at initial booting stage.

Methods inherited from class java.lang.Object

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

Field Detail

manager

public OFMFirewall manager

name

private java.lang.String name

firewallEntryTable

private FirewallEntryTable firewallEntryTable

apis

private OFModel.RESTApi[] apis

Array of RESTApi objects. Each objects represent a REST call handler routine bound to a specific URI.

Constructor Detail

FirewallStorage

FirewallStorage(OFMFirewall manager,
               java.lang.String name)

Method Detail

getManager

public OFMFirewall getManager()

setTableName

public void setTableName(java.lang.String name)

getName

public java.lang.String getName()

getFirewallEntryTable

public FirewallEntryTable getFirewallEntryTable()

synchronizeStorage

public void synchronizeStorage(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> entrySet)

Copies all entry of the persistent database into the memory storage at initial booting stage. When the controller is rebooted, all firewall rules need to be loaded into memory storage for consistency.

Parameters:

entrySet - all firewall rules of the persistent database

printStorage

public void printStorage()

Compares entries of the memory storage and the persistent database. This method is only used for debug.

insertDBEntry

public boolean insertDBEntry(IStorageService firewallDB,
                    java.lang.String dbName,
                    java.lang.String collectionName,
                    java.util.Map<java.lang.String,java.lang.Object> rule)

Stores a new firewall rule into the persistent database.

Parameters:

firewallDB - a persistent database name

dbName - the name of the persistent database

collectionName - the name of the collection for the database

rule - a firewall rule to insert

Returns:

true when inserted

deleteDBEntry

public boolean deleteDBEntry(IStorageService firewallDB,
                    java.lang.String dbName,
                    java.lang.String collectionName,
                    int ruleid)

Removes the firewall rule from database using key field of ruleid. This method searches for the target entry from the database first and deletes the target entry if the rule associated with the given ruleid exists.

Parameters:

firewallDB - a persistent database name

dbName - the name of the persistent database

collectionName - the name of the collection for the database

ruleid - the ruleid of firewall rule to delete

Returns:

true when deleted, false when fails to search

getDBEntry

public java.util.Map<java.lang.String,java.lang.Object> getDBEntry(IStorageService firewallDB,
                                                          java.lang.String dbName,
                                                          java.lang.String collectionName,
                                                          int ruleid)

Returns the firewall rule associated with the input ruleid from the database.

Parameters:

firewallDB - a persistent database name

dbName - the name of the persistent database

collectionName - the name of the collection for the database

ruleid - the ruleid of firewall rule to be searched

Returns:

the firewall rule associated with the given ruleid, null when fails to search

getAllDBEntries

public java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> getAllDBEntries(IStorageService firewallDB,
                                                                                     java.lang.String dbName,
                                                                                     java.lang.String collectionName)

Returns all firewall rules from the database.

Parameters:

firewallDB - a persistent database name

dbName - the name of the persistent database

collectionName - the name of the collection for the database

Returns:

all firewall rules, null when the database is empty

getAllRestApi

public OFModel.RESTApi[] getAllRestApi()

Returns the list of RESTApi objects

Specified by:

getAllRestApi in class OFModel

Returns:

array of all RESTApi objects