Adding and fixing javados.
Change-Id: I38eddb0b11630cdd83c5d1e5d5dc393ee2555897
Showing
18 changed files
with
132 additions
and
8 deletions
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * CLI commands for managing distributed inventory of applications. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.cli.app; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -16,5 +16,11 @@ | ... | @@ -16,5 +16,11 @@ |
| 16 | 16 | ||
| 17 | /** | 17 | /** |
| 18 | * Flow rule model & related services API definitions. | 18 | * Flow rule model & related services API definitions. |
| 19 | + * | ||
| 20 | + * <p> | ||
| 21 | + * The figure below depicts the general interactions between different | ||
| 22 | + * components of the intent subsystem.<br> | ||
| 23 | + * <img src="doc-files/flowrule-design.png" alt="ONOS flow rule subsystem design"> | ||
| 24 | + * </p> | ||
| 19 | */ | 25 | */ |
| 20 | package org.onosproject.net.flow; | 26 | package org.onosproject.net.flow; | ... | ... |
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Abstractions for interacting with device port groups. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.net.group; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -75,7 +75,9 @@ | ... | @@ -75,7 +75,9 @@ |
| 75 | * performs global recomputation/optimization across all prior intents. | 75 | * performs global recomputation/optimization across all prior intents. |
| 76 | * </p> | 76 | * </p> |
| 77 | * <p> | 77 | * <p> |
| 78 | - * <img src="doc-files/intent-subsystem.png" alt="ONOS intent subsystem"> | 78 | + * The figure below depicts the general interactions between different |
| 79 | + * components of the intent subsystem.<br> | ||
| 80 | + * <img src="doc-files/intent-design.png" alt="ONOS intent subsystem design"> | ||
| 79 | * </p> | 81 | * </p> |
| 80 | */ | 82 | */ |
| 81 | package org.onosproject.net.intent; | 83 | package org.onosproject.net.intent; | ... | ... |
core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-subsystem.png
deleted
100644 → 0
69.5 KB
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Implementation of partitioned and distributed store facility capable of | ||
| 19 | + * providing consistent update semantics. | ||
| 20 | + */ | ||
| 21 | +package org.onosproject.store.consistent.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Utility services and backing mechanisms for implementations of distributed stores. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.store.service.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -49,7 +49,7 @@ | ... | @@ -49,7 +49,7 @@ |
| 49 | <version>2.10.1</version> | 49 | <version>2.10.1</version> |
| 50 | <configuration> | 50 | <configuration> |
| 51 | <show>package</show> | 51 | <show>package</show> |
| 52 | - <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.gui:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*</excludePackageNames> | 52 | + <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.gui:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*:org.onosproject.net.group.impl</excludePackageNames> |
| 53 | <docfilessubdirs>true</docfilessubdirs> | 53 | <docfilessubdirs>true</docfilessubdirs> |
| 54 | <doctitle>ONOS Java API</doctitle> | 54 | <doctitle>ONOS Java API</doctitle> |
| 55 | <groups> | 55 | <groups> | ... | ... |
| ... | @@ -61,7 +61,7 @@ | ... | @@ -61,7 +61,7 @@ |
| 61 | <group> | 61 | <group> |
| 62 | <title>Core Subsystems</title> | 62 | <title>Core Subsystems</title> |
| 63 | <packages> | 63 | <packages> |
| 64 | - org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.* | 64 | + org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.*:org.onosproject.net.group.impl |
| 65 | </packages> | 65 | </packages> |
| 66 | </group> | 66 | </group> |
| 67 | <group> | 67 | <group> |
| ... | @@ -78,6 +78,13 @@ | ... | @@ -78,6 +78,13 @@ |
| 78 | </packages> | 78 | </packages> |
| 79 | </group> | 79 | </group> |
| 80 | <group> | 80 | <group> |
| 81 | + <title>Null Providers | ||
| 82 | + </title> | ||
| 83 | + <packages> | ||
| 84 | + org.onosproject.provider.nil.* | ||
| 85 | + </packages> | ||
| 86 | + </group> | ||
| 87 | + <group> | ||
| 81 | <title>Utilities</title> | 88 | <title>Utilities</title> |
| 82 | <packages> | 89 | <packages> |
| 83 | org.onlab.* | 90 | org.onlab.* | ... | ... |
102 KB
| ... | @@ -39,7 +39,15 @@ | ... | @@ -39,7 +39,15 @@ |
| 39 | </p> | 39 | </p> |
| 40 | 40 | ||
| 41 | <p> | 41 | <p> |
| 42 | - The following diagram describes a general structure of each ONOS subsystem: | 42 | + The figure below provides a visual inventory of the various ONOS subsystems. |
| 43 | + The ones with the gray outline represent either work in progress features | ||
| 44 | + planned for release in 2015.<br> | ||
| 45 | + <img src="doc-files/onos-subsystems.png" alt="ONOS architecture tiers"> | ||
| 46 | + | ||
| 47 | +</p> | ||
| 48 | + | ||
| 49 | +<p> | ||
| 50 | + The following diagram describes the general structure of each ONOS subsystem: | ||
| 43 | <br> | 51 | <br> |
| 44 | <img src="doc-files/onos-subsystem.png" alt="ONOS subsystem structure"><br> | 52 | <img src="doc-files/onos-subsystem.png" alt="ONOS subsystem structure"><br> |
| 45 | For example, the device-subsystem comprises of a core | 53 | For example, the device-subsystem comprises of a core | ... | ... |
| ... | @@ -15,6 +15,6 @@ | ... | @@ -15,6 +15,6 @@ |
| 15 | */ | 15 | */ |
| 16 | 16 | ||
| 17 | /** | 17 | /** |
| 18 | - * Provider that takes and brings to/from oblivion. | 18 | + * Provider that sends and brings packets to & from oblivion. |
| 19 | */ | 19 | */ |
| 20 | package org.onosproject.provider.nil.packet.impl; | 20 | package org.onosproject.provider.nil.packet.impl; | ... | ... |
providers/openflow/group/src/main/java/org/onosproject/provider/of/group/impl/package-info.java
0 → 100644
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Provider that uses OpenFlow controller as a means of device port group management. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.provider.of.group.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
-
Please register or login to post a comment