ttp-cli-tools-developer-guide
uni-manager-plug-in-developer-guide
unified-secure-channel
+ usecplugin-aaa-developer-guide
+ usecplugin-openflow-developer-guide
virtual-tenant-network-(vtn)
yang-tools
yang-push-developer-guide
--- /dev/null
+Usecplugin-AAA Developer Guide
+==============================
+
+Overview
+--------
+
+Usecplugin-AAA provides security related information for the AAA
+northbound interface.
+
+Usecplugin-AAA Architecture
+---------------------------
+
+AAA plugin creates log messages about successful and failed login
+attempts to OpenDaylight. Usecplugin-AAA continuously reads this log
+file and checks for either successful and failed attempt information.
+Whenever Usecpluin-AAA identifies a new attempt entry in the log file it
+is stored in YANG Data Store and its own log file.
+
+Usecplugin-AAA is implemented with the help of a few java classes.
+
+UsecpluginAAAProvider
+ Provider class for Usecplugin-AAA feature implementation.
+
+UsecpluginAAANotifImpl
+ Logs notification information which can be seen by log:display at
+ the Karaf terminal
+
+UsecpluginAAARPCImpl
+ Implements Usecplugin RPCs
+
+UsecpluginAAAParsingLog
+ Parses OpenDaylight log information for identifying login attempts.
+
+UsecpluginAAAPublishNotif
+ Publishes failed login attempt notification.
+
+UsecpluginAAAStore
+ Creates login information at the YANG Data Store.
+
+Key APIs and Interfaces
+-----------------------
+
+- RPC APIs
+
+ Login Attempt from IP
+ Returns Time and Type of Attempts (Success or Failure)
+
+ Login Attempt at Time
+ Returns Attempter IP Address and Type of Attempts (Success or
+ Failure)
+
+- Notification APIs
+
+ On Invalid Login Attempt
+ Notification generated on Invalid Login Attempt
+
+- YANG Data Store APIs
+
+ Get Login Attempts
+ Returns Source IP address of Attempter with Time of Attempts and
+ Type of Attempts (Success or Failure)
+
--- /dev/null
+Usecplugin-OpenFlow Developer Guide
+===================================
+
+Overview
+--------
+
+Usecplugin-OpenFlow provides security related information for the
+OpenFlow southbound interface.
+
+Usecplugin-OpenFlow Architecture
+--------------------------------
+
+Usecplugin-OpenFlow listens on OpenFlow southbound interface for
+Packet\_In messages. The application parses the message for header
+information. Usecplugin-OpenFlow has PacketHandler class that implements
+the PacketProcessing interface to override the OnPacketReceived
+notification by which the application is notified of Packet\_In
+messages.
+
+Usecplugin-OpenFlow is implemented with the help of a few java classes.
+
+UsecpluginProvider
+ Provider class for Usecplugin-OpenFlow feature implementation.
+
+PacketHandler
+ Receives Packet\_In messages coming to the controller and process
+ them appropriately
+
+PacketParsing
+ Decodes Packet\_In messages for packet header information (L2, L3 &
+ L4 information)
+
+InventoryUtility
+ Decodes Packet\_In messages for OpenFlow Switch and Port information
+
+UsecpluginNotifImpl
+ Logs notification information which can be seen by log:display at
+ the Karaf terminal
+
+UsecpluginRPCImpl
+ Implements Usecplugin RPCs
+
+UsecpluginStore
+ Stores attack information into YANG Data Store and log file.
+
+Key APIs and Interfaces
+-----------------------
+
+- RPC APIs
+
+ Attacks from DPID
+ Number of OpenFlow Packet\_In Attacks from Switch with DeviceID
+
+ Attacks from Host
+ Number of OpenFlow Packet\_In Attacks from SrcIP Address
+
+ Attacks to Server
+ Number of OpenFlow Packet\_In Attacks to DstIP Address
+
+ Attacks at Time of Day
+ Number of OpenFlow Packet\_In Attacks at a Particular Time with a
+ variable Window Time
+
+- Notification APIs
+
+ On Low Water Mark Breached
+ Notification generated on breaching Low Water Mark
+
== Usecplugin-AAA Developer Guide
-=== Overview
-Usecplugin-AAA provides security related information for the AAA northbound interface.
-
-=== Usecplugin-AAA Architecture
-AAA plugin creates log messages about successful and failed login attempts to OpenDaylight.
-Usecplugin-AAA continuously reads this log file and checks for either successful and failed attempt information.
-Whenever Usecpluin-AAA identifies a new attempt entry in the log file it is stored
-in YANG Data Store and its own log file.
-
-Usecplugin-AAA is implemented with the help of a few java classes.
-
-UsecpluginAAAProvider :: Provider class for Usecplugin-AAA feature implementation.
-UsecpluginAAANotifImpl :: Logs notification information which can be seen by log:display at the Karaf terminal
-UsecpluginAAARPCImpl :: Implements Usecplugin RPCs
-UsecpluginAAAParsingLog :: Parses OpenDaylight log information for identifying login attempts.
-UsecpluginAAAPublishNotif :: Publishes failed login attempt notification.
-UsecpluginAAAStore :: Creates login information at the YANG Data Store.
-
-=== Key APIs and Interfaces
-* RPC APIs
-+
-Login Attempt from IP :: Returns Time and Type of Attempts (Success or Failure)
-Login Attempt at Time :: Returns Attempter IP Address and Type of Attempts (Success or Failure)
-+
-* Notification APIs
-+
-On Invalid Login Attempt :: Notification generated on Invalid Login Attempt
-+
-* YANG Data Store APIs
-+
-Get Login Attempts :: Returns Source IP address of Attempter with Time of Attempts and Type of Attempts (Success or Failure)
-
-// === API Reference Documentation
-// Links to JavaDoc and REST API documentation will be provided later.
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/developer-guide/usecplugin-aaa-developer-guide.html
== Usecplugin-OpenFlow Developer Guide
-=== Overview
-Usecplugin-OpenFlow provides security related information for the OpenFlow southbound interface.
-
-=== Usecplugin-OpenFlow Architecture
-Usecplugin-OpenFlow listens on OpenFlow southbound interface for Packet_In messages. The application parses
-the message for header information. Usecplugin-OpenFlow has PacketHandler class that implements the PacketProcessing interface to override the
-OnPacketReceived notification by which the application is notified of Packet_In messages.
-
-Usecplugin-OpenFlow is implemented with the help of a few java classes.
-
-UsecpluginProvider :: Provider class for Usecplugin-OpenFlow feature implementation.
-PacketHandler :: Receives Packet_In messages coming to the controller and process them appropriately
-PacketParsing :: Decodes Packet_In messages for packet header information (L2, L3 & L4 information)
-InventoryUtility :: Decodes Packet_In messages for OpenFlow Switch and Port information
-UsecpluginNotifImpl :: Logs notification information which can be seen by log:display at the Karaf terminal
-UsecpluginRPCImpl :: Implements Usecplugin RPCs
-UsecpluginStore :: Stores attack information into YANG Data Store and log file.
-
-=== Key APIs and Interfaces
-* RPC APIs
-+
-Attacks from DPID :: Number of OpenFlow Packet_In Attacks from Switch with DeviceID
-Attacks from Host :: Number of OpenFlow Packet_In Attacks from SrcIP Address
-Attacks to Server :: Number of OpenFlow Packet_In Attacks to DstIP Address
-Attacks at Time of Day :: Number of OpenFlow Packet_In Attacks at a Particular Time with a variable Window Time
-+
-* Notification APIs
-+
-On Low Water Mark Breached :: Notification generated on breaching Low Water Mark
-
-// === API Reference Documentation
-// Links to JavaDoc and REST API documentation will be provided later.
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/developer-guide/usecplugin-openflow-developer-guide.html
Code Review / docs.git / commitdiff