mirror of
https://github.com/opennetworkinglab/onos.git
synced 2025-12-16 14:52:15 +01:00
Fixed javadocs and descriptions.
Change-Id: I92147b858d8012c957cc03fab2d306740161e2f3
This commit is contained in:
parent
f0e1faeabd
commit
266b4433a5
@ -74,6 +74,8 @@ public class RoutingRulePopulator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the number of rules populated.
|
* Returns the number of rules populated.
|
||||||
|
*
|
||||||
|
* @return number of rules
|
||||||
*/
|
*/
|
||||||
public long getCounter() {
|
public long getCounter() {
|
||||||
return rulePopulationCounter.get();
|
return rulePopulationCounter.get();
|
||||||
|
|||||||
@ -88,6 +88,12 @@
|
|||||||
org.onosproject.provider.of.*:org.onosproject.openflow.*
|
org.onosproject.provider.of.*:org.onosproject.openflow.*
|
||||||
</packages>
|
</packages>
|
||||||
</group>
|
</group>
|
||||||
|
<group>
|
||||||
|
<title>NetConf Providers</title>
|
||||||
|
<packages>
|
||||||
|
org.onosproject.provider.netconf:org.onosproject.provider.netconf*
|
||||||
|
</packages>
|
||||||
|
</group>
|
||||||
<group>
|
<group>
|
||||||
<title>Null Providers</title>
|
<title>Null Providers</title>
|
||||||
<packages>
|
<packages>
|
||||||
|
|||||||
@ -48,6 +48,7 @@ public abstract class Config<S> {
|
|||||||
* @param subject configuration subject
|
* @param subject configuration subject
|
||||||
* @param node JSON object node where configuration data is stored
|
* @param node JSON object node where configuration data is stored
|
||||||
* @param mapper JSON object mapper
|
* @param mapper JSON object mapper
|
||||||
|
* @param delegate delegate context
|
||||||
*/
|
*/
|
||||||
public void init(S subject, ObjectNode node, ObjectMapper mapper,
|
public void init(S subject, ObjectNode node, ObjectMapper mapper,
|
||||||
ConfigApplyDelegate<S> delegate) {
|
ConfigApplyDelegate<S> delegate) {
|
||||||
|
|||||||
@ -41,6 +41,8 @@ public interface NetworkConfigRegistry {
|
|||||||
* class of subject.
|
* class of subject.
|
||||||
*
|
*
|
||||||
* @param subjectClass subject class
|
* @param subjectClass subject class
|
||||||
|
* @param <T> type of subject
|
||||||
|
* @return set of config factories
|
||||||
*/
|
*/
|
||||||
<T> Set<ConfigFactory<T>> getConfigFactories(Class<T> subjectClass);
|
<T> Set<ConfigFactory<T>> getConfigFactories(Class<T> subjectClass);
|
||||||
|
|
||||||
@ -49,6 +51,9 @@ public interface NetworkConfigRegistry {
|
|||||||
* subject type and key.
|
* subject type and key.
|
||||||
*
|
*
|
||||||
* @param subjectClass subject class
|
* @param subjectClass subject class
|
||||||
|
* @param configKey configuration key
|
||||||
|
* @param <T> type of subject
|
||||||
|
* @return config factory
|
||||||
*/
|
*/
|
||||||
<T> ConfigFactory<T> getConfigFactory(Class<T> subjectClass, String configKey);
|
<T> ConfigFactory<T> getConfigFactory(Class<T> subjectClass, String configKey);
|
||||||
|
|
||||||
@ -57,6 +62,8 @@ public interface NetworkConfigRegistry {
|
|||||||
* configuration class.
|
* configuration class.
|
||||||
*
|
*
|
||||||
* @param configClass configuration class
|
* @param configClass configuration class
|
||||||
|
* @param <T> type of subject
|
||||||
|
* @return config factory
|
||||||
*/
|
*/
|
||||||
<T> ConfigFactory<T> getConfigFactory(Class<Config<T>> configClass);
|
<T> ConfigFactory<T> getConfigFactory(Class<Config<T>> configClass);
|
||||||
|
|
||||||
|
|||||||
@ -28,6 +28,7 @@ public interface NetworkConfigService {
|
|||||||
* Returns the set of subjects for which some configuration is available.
|
* Returns the set of subjects for which some configuration is available.
|
||||||
*
|
*
|
||||||
* @param subjectClass subject class
|
* @param subjectClass subject class
|
||||||
|
* @param <T> type of subject
|
||||||
* @return set of configured subjects
|
* @return set of configured subjects
|
||||||
*/
|
*/
|
||||||
<T> Set<T> getSubjects(Class<T> subjectClass);
|
<T> Set<T> getSubjects(Class<T> subjectClass);
|
||||||
@ -38,6 +39,7 @@ public interface NetworkConfigService {
|
|||||||
*
|
*
|
||||||
* @param subjectClass subject class
|
* @param subjectClass subject class
|
||||||
* @param configClass configuration class
|
* @param configClass configuration class
|
||||||
|
* @param <T> type of subject
|
||||||
* @return set of configured subjects
|
* @return set of configured subjects
|
||||||
*/
|
*/
|
||||||
<T> Set<T> getSubjects(Class<T> subjectClass, Class<Config<T>> configClass);
|
<T> Set<T> getSubjects(Class<T> subjectClass, Class<Config<T>> configClass);
|
||||||
@ -47,6 +49,7 @@ public interface NetworkConfigService {
|
|||||||
* Returns all configurations for the specified subject.
|
* Returns all configurations for the specified subject.
|
||||||
*
|
*
|
||||||
* @param subject configuration subject
|
* @param subject configuration subject
|
||||||
|
* @param <T> type of subject
|
||||||
* @return set of configurations
|
* @return set of configurations
|
||||||
*/
|
*/
|
||||||
<T> Set<Config<T>> getConfigs(T subject);
|
<T> Set<Config<T>> getConfigs(T subject);
|
||||||
@ -57,6 +60,7 @@ public interface NetworkConfigService {
|
|||||||
*
|
*
|
||||||
* @param subject configuration subject
|
* @param subject configuration subject
|
||||||
* @param configClass configuration class
|
* @param configClass configuration class
|
||||||
|
* @param <T> type of subject
|
||||||
* @return configuration or null if one is not available
|
* @return configuration or null if one is not available
|
||||||
*/
|
*/
|
||||||
<T> Config<T> getConfig(T subject, Class<Config<T>> configClass);
|
<T> Config<T> getConfig(T subject, Class<Config<T>> configClass);
|
||||||
|
|||||||
@ -90,7 +90,10 @@ public class NetconfDevice {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This will try to connect to NETCONF device and find all the capabilities.
|
* This will try to connect to NETCONF device and find all the capabilities.
|
||||||
|
*
|
||||||
|
* @throws Exception if unable to connect to the device
|
||||||
*/
|
*/
|
||||||
|
// FIXME: this should not be a generic Exception; perhaps wrap in some RuntimeException
|
||||||
public void init() throws Exception {
|
public void init() throws Exception {
|
||||||
try {
|
try {
|
||||||
if (sshConnection == null) {
|
if (sshConnection == null) {
|
||||||
|
|||||||
@ -29,7 +29,7 @@
|
|||||||
<artifactId>onos-null-provider</artifactId>
|
<artifactId>onos-null-provider</artifactId>
|
||||||
<packaging>bundle</packaging>
|
<packaging>bundle</packaging>
|
||||||
|
|
||||||
<description>Null southbound providers application</description>
|
<description>Null southbound providers</description>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<onos.app.name>org.onosproject.null</onos.app.name>
|
<onos.app.name>org.onosproject.null</onos.app.name>
|
||||||
|
|||||||
@ -41,6 +41,7 @@ public class Catalog {
|
|||||||
* Loads the catalog from the specified catalog file.
|
* Loads the catalog from the specified catalog file.
|
||||||
*
|
*
|
||||||
* @param catalogPath catalog file path
|
* @param catalogPath catalog file path
|
||||||
|
* @throws IOException if unable to read the catalog file
|
||||||
*/
|
*/
|
||||||
public void load(String catalogPath) throws IOException {
|
public void load(String catalogPath) throws IOException {
|
||||||
InputStream is = new FileInputStream(catalogPath);
|
InputStream is = new FileInputStream(catalogPath);
|
||||||
|
|||||||
@ -22,6 +22,7 @@ public class JavaSource extends JavaEntity {
|
|||||||
* Creates a new Java source entity.
|
* Creates a new Java source entity.
|
||||||
*
|
*
|
||||||
* @param name java source file name
|
* @param name java source file name
|
||||||
|
* @param path source file path
|
||||||
*/
|
*/
|
||||||
JavaSource(String name, String path) {
|
JavaSource(String name, String path) {
|
||||||
super(name);
|
super(name);
|
||||||
@ -50,6 +51,7 @@ public class JavaSource extends JavaEntity {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the set of resolved imports for this Java source
|
* Returns the set of resolved imports for this Java source
|
||||||
|
*
|
||||||
* @return set of imports
|
* @return set of imports
|
||||||
*/
|
*/
|
||||||
public Set<JavaEntity> getImports() {
|
public Set<JavaEntity> getImports() {
|
||||||
@ -78,6 +80,7 @@ public class JavaSource extends JavaEntity {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the set of imported, but unresolved, Java entity names.
|
* Returns the set of imported, but unresolved, Java entity names.
|
||||||
|
*
|
||||||
* @return set of imported Java entity names
|
* @return set of imported Java entity names
|
||||||
*/
|
*/
|
||||||
Set<String> getImportNames() {
|
Set<String> getImportNames() {
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user