sdn-apidoc 2.0.0 API

This document is the API specification of Java code comprising the H3C VCF Controller.

See: Description

Common 
Package Description
com.h3c.api  
com.h3c.api.auth  
com.h3c.api.security  
com.h3c.dist.bus  
com.h3c.dist.groups  
com.h3c.dist.keystore  
com.h3c.dist.lock  
com.h3c.dist.sync  
com.h3c.sdn
Definitions of domain model and related general constructs which are applicable to multiple tiers and software layers of the SDN Controller.
com.h3c.sdn.alert
Definitions of the domain model pertaining to the Alerts.
com.h3c.sdn.app
Application management and tracking service interfaces.
com.h3c.sdn.application
...
com.h3c.sdn.artifact
Definitions of the domain model pertaining to the OSGi Artifacts.
com.h3c.sdn.auditlog
Definitions of the domain model pertaining to the Audit Logs.
com.h3c.sdn.auth
...
com.h3c.sdn.backup
...
com.h3c.sdn.common
Definitions of general services applicable to multiple tiers of the SDN Controller.
com.h3c.sdn.config
Definitions of the domain model pertaining to configuration.
com.h3c.sdn.ctlAddrManager  
com.h3c.sdn.diag
Definitions of the path diagnostic service.
com.h3c.sdn.ha
...
com.h3c.sdn.hostManager  
com.h3c.sdn.json
JSON codecs registry for SDN-related entities.
com.h3c.sdn.license
Definitions of the domain model pertaining to the Licenses.
com.h3c.sdn.log
Definitions of the domain model pertaining to log entries.
com.h3c.sdn.metric
Fundamental classes for the SDN core controller metering framework, including the classes for various metric types that may be obtained from the framework.
com.h3c.sdn.misc
Miscellaneous SDN-specific utilities and auxiliaries for use as part of implementations in either tier; entities provided within cannot not be used as part of the mutual interface between the tiers however.
com.h3c.sdn.misc.dsync  
com.h3c.sdn.misc.dsync.net  
com.h3c.sdn.misc.license  
com.h3c.sdn.misc.license.constant  
com.h3c.sdn.misc.license.eu  
com.h3c.sdn.misc.license.model  
com.h3c.sdn.misc.net  
com.h3c.sdn.region
...
com.h3c.sdn.support
Support services and concepts available to all modules.
com.h3c.sdn.system
Definitions of the domain model pertaining to the SDN Controller system.
com.h3c.sdn.team
Teaming services and concepts universally available to all modules.
com.h3c.sdn.teamconfig
Team configuration information.
com.h3c.sdn.teamcs
...
com.h3c.sdn.trace
Provide interface for accessing trace level data from the OpenFlow Controller
com.h3c.sdn.tvue
Topology viewer API & domain model definitions.
com.h3c.sdn.version
Controller software version information.
Administrator Tier 
Package Description
com.h3c.license  
com.h3c.sdn.adm
Definitions of the domain model and services specific to the Administrator tier of the VCF Controller.
com.h3c.sdn.adm.alert
Definitions of the services pertaining to the Alert system.
com.h3c.sdn.adm.auditlog
Definitions of the services pertaining to the Audit Log system.
com.h3c.sdn.adm.backup  
com.h3c.sdn.adm.common.converter
Utility classes to do conversions.
com.h3c.sdn.adm.config
Definitions of the services pertaining to the Config system.
com.h3c.sdn.adm.ctlAddrManager  
com.h3c.sdn.adm.dao
Definitions of data access services for persisting and retrieving information applicable at the Administrator tier of the SDN Controller.
com.h3c.sdn.adm.dao.model
Model POJOs implementations used to persist and retrieve information applicable at the Administrator tier of the SDN Controller.
com.h3c.sdn.adm.hostManager  
com.h3c.sdn.adm.json
Implementations of Core Services JSON factory and associated codecs.
com.h3c.sdn.adm.license
Definitions of the services pertaining to the License system.
com.h3c.sdn.adm.log
Definitions of the services pertaining to the Logging system.
com.h3c.sdn.adm.metric
Definitions of services pertaining to the SDN core controller metering framework.
com.h3c.sdn.adm.region
...
com.h3c.sdn.adm.role
...
com.h3c.sdn.adm.rsdoc
Services for registering and tracking various REST API documentation providers.
com.h3c.sdn.adm.system
Definitions of services pertaining to the SDN Controller system and its collaborators.
com.h3c.sdn.adm.web
Web resource catalogue service definitions.
com.h3c.sdn.api
Definitions of services for driving outbound external communications for interacting with peers and integrating with other external applications, e.g.
com.h3c.sdn.dao.model
Model POJOs implementations used to persist and retrieve information.
Controller Tier 
Package Description
com.h3c.of  
com.h3c.of.common
Code shared by the OpenFlow Controller and Mock OpenFlow Switch implementations.
com.h3c.of.ctl
Public API for the OpenFlow Controller.
com.h3c.of.ctl.flow
Public API for the OpenFlow Flow Manager.
com.h3c.of.ctl.pipeline
Definitions for conveying OpenFlow switch pipeline definitions and capabilities.
com.h3c.of.ctl.pkt
Public API for the OpenFlow Packet Sequencer and participating Packet Listeners.
com.h3c.of.json
JSON factory and codecs for Openflow structures.
com.h3c.of.lib
OpenFlow Protocol Library.
com.h3c.of.lib.dt
A set of classes representing data values used in the OpenFlow protocol.
com.h3c.of.lib.err
OpenFlow Error Type enumerations.
com.h3c.of.lib.instr
Representations of OpenFlow Protocol Instructions and Actions.
com.h3c.of.lib.match
Representations of OpenFlow Protocol Match Structures.
com.h3c.of.lib.mp
Representations of OpenFlow Protocol Multipart Message bodies.
com.h3c.of.lib.msg
Representations of OpenFlow Protocol Messages.
com.h3c.of.sw
Provides mock implementations of OpenFlow switches.
com.h3c.of.sw.misc  
com.h3c.sdn.ctl.diag
Model objects for path diagnostic application.
com.h3c.sdn.ctl.json
...
com.h3c.util.pkt  
Network Services 
Package Description
com.h3c.sdn.flowmgr
Definitions of the services provided by the Flow Manager Application.
com.h3c.sdn.linkdisco
Definitions of the services provided by the Link Discovery Application.
com.h3c.sdn.nodemgr
Definitions of the services provided by the Node Manager Application.
com.h3c.sdn.nodemgr.model
Common classes and utility functions for implementations of Node Manager.
com.h3c.sdn.topology
Definitions of the interfaces provided by the Topology Services Application.
com.h3c.sdn.topology.model
Common classes and utility functions for implementations of Topology Services.
Utilities 
Package Description
com.h3c.keystone  
com.h3c.nbio  
com.h3c.util  
com.h3c.util.bcrypt  
com.h3c.util.cache  
com.h3c.util.codec  
com.h3c.util.concurrent  
com.h3c.util.dao  
com.h3c.util.dao.query  
com.h3c.util.event  
com.h3c.util.filter  
com.h3c.util.health  
com.h3c.util.ip  
com.h3c.util.json  
com.h3c.util.net  
com.h3c.util.net.msg  
com.h3c.util.observer  
com.h3c.util.perf.api  
com.h3c.util.perf.controller  
com.h3c.util.perf.model  
com.h3c.util.persistence  
com.h3c.util.persistence.cassandra  
com.h3c.util.persistence.cassandra.entitymgr  
com.h3c.util.persistence.cassandra.entitymgr.column  
com.h3c.util.persistence.cassandra.entitymgr.wal  
com.h3c.util.persistence.cassandra.index  
com.h3c.util.persistence.cassandra.lockmgr  
com.h3c.util.persistence.cassandra.query  
com.h3c.util.persistence.cassandra.snapshotmgr  
com.h3c.util.persistence.exceptions  
com.h3c.util.proxy  
com.h3c.util.rs  
com.h3c.util.rs.auth  
com.h3c.util.rs.rate  
com.h3c.util.security  
com.h3c.util.snmp  
com.h3c.util.snmp.command  
com.h3c.util.snmp.constants  
com.h3c.util.test  
com.h3c.util.tuple  
com.h3c.util.type  
com.h3c.util.version  

Copyright © 2014. All Rights Reserved.