홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Phanendra Manda
Committed by Phaneendra Manda
51fb9c2d 1 parent 1d0019ca

Warnings in onos-build-docs corrected 

Change-Id: Ib93062abd1977c801d3f38cff26d1ee6bfde58d4
Inline Side-by-side
Showing 67 changed files with 423 additions and 140 deletions
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
29 <artifactId>onos-pcep-controller-api</artifactId> 29 <artifactId>onos-pcep-controller-api</artifactId>
30 <packaging>bundle</packaging> 30 <packaging>bundle</packaging>
31 31
32 - <description>ONOS Pcep controller subsystem API</description> 32 + <description>ONOS Pcep client controller subsystem API</description>
33 33
34 <dependencies> 34 <dependencies>
35 <dependency> 35 <dependency>
......
...@@ -20,7 +20,7 @@ import java.util.Collection; ...@@ -20,7 +20,7 @@ import java.util.Collection;
20 import org.onosproject.pcepio.protocol.PcepMessage; 20 import org.onosproject.pcepio.protocol.PcepMessage;
21 21
22 /** 22 /**
23 - * Abstraction of an Pcep controller. Serves as a one stop 23 + * Abstraction of an Pcep client controller. Serves as a one stop
24 * shop for obtaining Pcep devices and (un)register listeners 24 * shop for obtaining Pcep devices and (un)register listeners
25 * on pcep events 25 * on pcep events
26 */ 26 */
......
...@@ -17,7 +17,7 @@ package org.onosproject.pcep.controller; ...@@ -17,7 +17,7 @@ package org.onosproject.pcep.controller;
17 17
18 import org.onosproject.pcepio.protocol.PcepMessage; 18 import org.onosproject.pcepio.protocol.PcepMessage;
19 /** 19 /**
20 - * Notifies providers about pcep msg events. 20 + * Notifies providers about PCEP message events.
21 */ 21 */
22 public interface PcepEventListener { 22 public interface PcepEventListener {
23 23
......
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * PCEP controller driver API. 18 + * PCEP client controller driver API.
19 */ 19 */
20 package org.onosproject.pcep.controller.driver; 20 package org.onosproject.pcep.controller.driver;
......
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * PCEP controller API. 18 + * PCEP client controller API.
19 */ 19 */
20 package org.onosproject.pcep.controller; 20 package org.onosproject.pcep.controller;
......
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
28 <artifactId>onos-pcep-controller-impl</artifactId> 28 <artifactId>onos-pcep-controller-impl</artifactId>
29 <packaging>bundle</packaging> 29 <packaging>bundle</packaging>
30 30
31 - <description>ONOS PCEP controller subsystem API</description> 31 + <description>ONOS PCEP client controller subsystem API implementation</description>
32 32
33 <dependencies> 33 <dependencies>
34 <dependency> 34 <dependency>
......
...@@ -15,23 +15,16 @@ ...@@ -15,23 +15,16 @@
15 */ 15 */
16 package org.onosproject.pcep.controller.impl; 16 package org.onosproject.pcep.controller.impl;
17 17
18 -import static org.onlab.util.Tools.groupedThreads;
19 -
20 import java.util.Collection; 18 import java.util.Collection;
21 import java.util.Collections; 19 import java.util.Collections;
22 import java.util.HashSet; 20 import java.util.HashSet;
23 import java.util.Set; 21 import java.util.Set;
24 import java.util.concurrent.ConcurrentHashMap; 22 import java.util.concurrent.ConcurrentHashMap;
25 -import java.util.concurrent.ExecutorService;
26 -import java.util.concurrent.Executors;
27 -import java.util.concurrent.locks.Lock;
28 -import java.util.concurrent.locks.ReentrantLock;
29 23
30 import org.apache.felix.scr.annotations.Activate; 24 import org.apache.felix.scr.annotations.Activate;
31 import org.apache.felix.scr.annotations.Component; 25 import org.apache.felix.scr.annotations.Component;
32 import org.apache.felix.scr.annotations.Deactivate; 26 import org.apache.felix.scr.annotations.Deactivate;
33 import org.apache.felix.scr.annotations.Service; 27 import org.apache.felix.scr.annotations.Service;
34 -import org.onosproject.net.driver.DriverService;
35 import org.onosproject.pcep.controller.PccId; 28 import org.onosproject.pcep.controller.PccId;
36 import org.onosproject.pcep.controller.PcepClient; 29 import org.onosproject.pcep.controller.PcepClient;
37 import org.onosproject.pcep.controller.PcepClientController; 30 import org.onosproject.pcep.controller.PcepClientController;
...@@ -44,21 +37,15 @@ import org.slf4j.LoggerFactory; ...@@ -44,21 +37,15 @@ import org.slf4j.LoggerFactory;
44 37
45 import com.google.common.collect.Sets; 38 import com.google.common.collect.Sets;
46 39
40 +/**
41 + * Implementation of PCEP client controller.
42 + */
47 @Component(immediate = true) 43 @Component(immediate = true)
48 @Service 44 @Service
49 public class PcepClientControllerImpl implements PcepClientController { 45 public class PcepClientControllerImpl implements PcepClientController {
50 46
51 private static final Logger log = LoggerFactory.getLogger(PcepClientControllerImpl.class); 47 private static final Logger log = LoggerFactory.getLogger(PcepClientControllerImpl.class);
52 48
53 - //@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
54 - protected DriverService driverService;
55 -
56 - private final ExecutorService executorMsgs =
57 - Executors.newFixedThreadPool(32, groupedThreads("onos/pcep", "event-stats-%d"));
58 -
59 - private final ExecutorService executorBarrier =
60 - Executors.newFixedThreadPool(4, groupedThreads("onos/pcep", "event-barrier-%d"));
61 -
62 protected ConcurrentHashMap<PccId, PcepClient> connectedClients = 49 protected ConcurrentHashMap<PccId, PcepClient> connectedClients =
63 new ConcurrentHashMap<PccId, PcepClient>(); 50 new ConcurrentHashMap<PccId, PcepClient>();
64 51
...@@ -188,7 +175,6 @@ public class PcepClientControllerImpl implements PcepClientController { ...@@ -188,7 +175,6 @@ public class PcepClientControllerImpl implements PcepClientController {
188 public class PcepClientAgent implements PcepAgent { 175 public class PcepClientAgent implements PcepAgent {
189 176
190 private final Logger log = LoggerFactory.getLogger(PcepClientAgent.class); 177 private final Logger log = LoggerFactory.getLogger(PcepClientAgent.class);
191 - private final Lock clientLock = new ReentrantLock();
192 178
193 @Override 179 @Override
194 public boolean addConnectedClient(PccId pccId, PcepClient pc) { 180 public boolean addConnectedClient(PccId pccId, PcepClient pc) {
......
...@@ -15,13 +15,10 @@ ...@@ -15,13 +15,10 @@
15 */ 15 */
16 package org.onosproject.pcep.controller.impl; 16 package org.onosproject.pcep.controller.impl;
17 17
18 -
19 import org.onosproject.pcep.controller.PcepPacketStats; 18 import org.onosproject.pcep.controller.PcepPacketStats;
19 +
20 /** 20 /**
21 - * A representation of a packet context which allows any provider 21 + * The implementation for PCEP packet statistics.
22 - * to view a packet in event, but may block the response to the
23 - * event if blocked has been called. This packet context can be used
24 - * to react to the packet in event with a packet out.
25 */ 22 */
26 public class PcepPacketStatsImpl implements PcepPacketStats { 23 public class PcepPacketStatsImpl implements PcepPacketStats {
27 24
...@@ -30,6 +27,9 @@ public class PcepPacketStatsImpl implements PcepPacketStats { ...@@ -30,6 +27,9 @@ public class PcepPacketStatsImpl implements PcepPacketStats {
30 private int wrongPacketCount; 27 private int wrongPacketCount;
31 private long time; 28 private long time;
32 29
30 + /**
31 + * Default constructor.
32 + */
33 public PcepPacketStatsImpl() { 33 public PcepPacketStatsImpl() {
34 this.inPacketCount = 0; 34 this.inPacketCount = 0;
35 this.outPacketCount = 0; 35 this.outPacketCount = 0;
...@@ -82,6 +82,9 @@ public class PcepPacketStatsImpl implements PcepPacketStats { ...@@ -82,6 +82,9 @@ public class PcepPacketStatsImpl implements PcepPacketStats {
82 this.wrongPacketCount++; 82 this.wrongPacketCount++;
83 } 83 }
84 84
85 + /**
86 + * Resets wrong packet count.
87 + */
85 public void resetWrongPacket() { 88 public void resetWrongPacket() {
86 this.wrongPacketCount = 0; 89 this.wrongPacketCount = 0;
87 } 90 }
......
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * Implementation of the PCEP controller subsystem. 18 + * Implementation of the PCEP client controller subsystem.
19 */ 19 */
20 package org.onosproject.pcep.controller.impl; 20 package org.onosproject.pcep.controller.impl;
......
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 + * PCEP custom exceptions.
19 + */
20 +package org.onosproject.pcepio.exceptions;
...@@ -16,14 +16,14 @@ ...@@ -16,14 +16,14 @@
16 16
17 package org.onosproject.pcepio.protocol; 17 package org.onosproject.pcepio.protocol;
18 18
19 -/**
20 - * Abstraction of an entity which Provides List of PCEP Attributes.
21 - */
22 import java.util.LinkedList; 19 import java.util.LinkedList;
23 20
24 import org.jboss.netty.buffer.ChannelBuffer; 21 import org.jboss.netty.buffer.ChannelBuffer;
25 import org.onosproject.pcepio.exceptions.PcepParseException; 22 import org.onosproject.pcepio.exceptions.PcepParseException;
26 23
24 +/**
25 + * Abstraction of an entity which Provides List of PCEP Attributes.
26 + */
27 public interface PcepAttribute { 27 public interface PcepAttribute {
28 28
29 /** 29 /**
......
...@@ -22,6 +22,9 @@ import org.onosproject.pcepio.protocol.ver1.PcepFactoryVer1; ...@@ -22,6 +22,9 @@ import org.onosproject.pcepio.protocol.ver1.PcepFactoryVer1;
22 import org.slf4j.Logger; 22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory; 23 import org.slf4j.LoggerFactory;
24 24
25 +/**
26 + * Abstraction to provide the version for PCEP.
27 + */
25 public final class PcepFactories { 28 public final class PcepFactories {
26 29
27 protected static final Logger log = LoggerFactory.getLogger(PcepFactories.class); 30 protected static final Logger log = LoggerFactory.getLogger(PcepFactories.class);
......
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 + * Abstraction of an entity providing PCEP messages.
19 + */
20 +package org.onosproject.pcepio.protocol;
...@@ -16,9 +16,6 @@ ...@@ -16,9 +16,6 @@
16 16
17 package org.onosproject.pcepio.protocol.ver1; 17 package org.onosproject.pcepio.protocol.ver1;
18 18
19 -/*
20 - * Provides PCEP Attribute List.
21 - */
22 import java.util.LinkedList; 19 import java.util.LinkedList;
23 import java.util.ListIterator; 20 import java.util.ListIterator;
24 21
...@@ -36,18 +33,20 @@ import org.slf4j.LoggerFactory; ...@@ -36,18 +33,20 @@ import org.slf4j.LoggerFactory;
36 import com.google.common.base.MoreObjects; 33 import com.google.common.base.MoreObjects;
37 import com.google.common.base.MoreObjects.ToStringHelper; 34 import com.google.common.base.MoreObjects.ToStringHelper;
38 35
39 -/* Reference : RFC5440 36 +/**
40 - * where: 37 + * Provides PCEP Attribute List.
41 - * <attribute-list> ::=[<LSPA>]
42 - * [<BANDWIDTH>]
43 - * [<metric-list>]
44 - * [<IRO>]
45 - *
46 - * <metric-list> ::=<METRIC>[<metric-list>]
47 */ 38 */
48 -
49 public class PcepAttributeVer1 implements PcepAttribute { 39 public class PcepAttributeVer1 implements PcepAttribute {
50 40
41 + /* Reference : RFC5440
42 + * where:
43 + * <attribute-list> ::=[<LSPA>]
44 + * [<BANDWIDTH>]
45 + * [<metric-list>]
46 + * [<IRO>]
47 + *
48 + * <metric-list> ::=<METRIC>[<metric-list>]
49 + */
51 protected static final Logger log = LoggerFactory.getLogger(PcepAttributeVer1.class); 50 protected static final Logger log = LoggerFactory.getLogger(PcepAttributeVer1.class);
52 51
53 public static final int OBJECT_HEADER_LENGTH = 4; 52 public static final int OBJECT_HEADER_LENGTH = 4;
......
...@@ -33,26 +33,30 @@ import org.slf4j.LoggerFactory; ...@@ -33,26 +33,30 @@ import org.slf4j.LoggerFactory;
33 33
34 import com.google.common.base.MoreObjects; 34 import com.google.common.base.MoreObjects;
35 35
36 -/* 36 +/**
37 - * RFC : 5440 , section : 6.8 37 + * Provides PCEP Close Message.
38 - * <Close Message> ::= <Common Header> <CLOSE>
39 - *
40 - 0 1 2 3
41 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
42 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
43 - | Ver | Flags | Message-Type | Message-Length |
44 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
45 - | Object-Class | OT |Res|P|I| Object Length (bytes) |
46 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
47 - | Reserved | Flags | Reason |
48 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49 - | |
50 - // Optional TLVs //
51 - | |
52 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53 */ 38 */
54 class PcepCloseMsgVer1 implements PcepCloseMsg { 39 class PcepCloseMsgVer1 implements PcepCloseMsg {
55 40
41 + /*
42 + * RFC : 5440 , section : 6.8
43 + * <Close Message> ::= <Common Header> <CLOSE>
44 + *
45 + 0 1 2 3
46 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
47 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
48 + | Ver | Flags | Message-Type | Message-Length |
49 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
50 + | Object-Class | OT |Res|P|I| Object Length (bytes) |
51 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
52 + | Reserved | Flags | Reason |
53 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
54 + | |
55 + // Optional TLVs //
56 + | |
57 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
58 + */
59 +
56 protected static final Logger log = LoggerFactory.getLogger(PcepCloseMsgVer1.class); 60 protected static final Logger log = LoggerFactory.getLogger(PcepCloseMsgVer1.class);
57 61
58 // Pcep version: 1 62 // Pcep version: 1
...@@ -74,6 +78,9 @@ class PcepCloseMsgVer1 implements PcepCloseMsg { ...@@ -74,6 +78,9 @@ class PcepCloseMsgVer1 implements PcepCloseMsg {
74 78
75 public static final PcepCloseMsgVer1.Reader READER = new Reader(); 79 public static final PcepCloseMsgVer1.Reader READER = new Reader();
76 80
81 + /**
82 + * Reader class for reading close message for channel buffer.
83 + */
77 static class Reader implements PcepMessageReader<PcepCloseMsg> { 84 static class Reader implements PcepMessageReader<PcepCloseMsg> {
78 PcepObjectHeader closeObjHeader; 85 PcepObjectHeader closeObjHeader;
79 byte yReason; 86 byte yReason;
...@@ -248,6 +255,9 @@ class PcepCloseMsgVer1 implements PcepCloseMsg { ...@@ -248,6 +255,9 @@ class PcepCloseMsgVer1 implements PcepCloseMsg {
248 255
249 static final Writer WRITER = new Writer(); 256 static final Writer WRITER = new Writer();
250 257
258 + /**
259 + * Writer class for writing close message to channel buffer.
260 + */
251 static class Writer implements PcepMessageWriter<PcepCloseMsgVer1> { 261 static class Writer implements PcepMessageWriter<PcepCloseMsgVer1> {
252 262
253 @Override 263 @Override
......
...@@ -25,6 +25,9 @@ import org.slf4j.LoggerFactory; ...@@ -25,6 +25,9 @@ import org.slf4j.LoggerFactory;
25 25
26 import com.google.common.base.MoreObjects; 26 import com.google.common.base.MoreObjects;
27 27
28 +/**
29 + * Provides PCEP Endpoints Object.
30 + */
28 public class PcepEndPointsObjectVer1 implements PcepEndPointsObject { 31 public class PcepEndPointsObjectVer1 implements PcepEndPointsObject {
29 32
30 /* 33 /*
......
...@@ -35,8 +35,12 @@ import org.slf4j.LoggerFactory; ...@@ -35,8 +35,12 @@ import org.slf4j.LoggerFactory;
35 35
36 import com.google.common.base.MoreObjects; 36 import com.google.common.base.MoreObjects;
37 37
38 -/* 38 +/**
39 - * rfc3209 39 + * Provides PCEP Ero Object.
40 + */
41 +public class PcepEroObjectVer1 implements PcepEroObject {
42 + /*
43 + * rfc3209
40 0 1 2 3 44 0 1 2 3
41 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 45 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
42 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 46 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
...@@ -130,8 +134,7 @@ import com.google.common.base.MoreObjects; ...@@ -130,8 +134,7 @@ import com.google.common.base.MoreObjects;
130 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 134 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
131 // NAI (variable) // 135 // NAI (variable) //
132 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 136 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
133 - */ 137 + */
134 -public class PcepEroObjectVer1 implements PcepEroObject {
135 138
136 protected static final Logger log = LoggerFactory.getLogger(PcepEroObjectVer1.class); 139 protected static final Logger log = LoggerFactory.getLogger(PcepEroObjectVer1.class);
137 140
......
...@@ -20,6 +20,9 @@ import org.slf4j.LoggerFactory; ...@@ -20,6 +20,9 @@ import org.slf4j.LoggerFactory;
20 import com.google.common.base.MoreObjects; 20 import com.google.common.base.MoreObjects;
21 import com.google.common.base.MoreObjects.ToStringHelper; 21 import com.google.common.base.MoreObjects.ToStringHelper;
22 22
23 +/**
24 + * Provides PCEP Error Message.
25 + */
23 public class PcepErrorMsgVer1 implements PcepErrorMsg { 26 public class PcepErrorMsgVer1 implements PcepErrorMsg {
24 27
25 /* 28 /*
...@@ -71,6 +74,9 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg { ...@@ -71,6 +74,9 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg {
71 this.errInfo = errInfo; 74 this.errInfo = errInfo;
72 } 75 }
73 76
77 + /**
78 + * Reader class for reading PCEP error Message from channel buffer.
79 + */
74 public static class Reader implements PcepMessageReader<PcepErrorMsg> { 80 public static class Reader implements PcepMessageReader<PcepErrorMsg> {
75 81
76 ErrorObjListWithOpen errObjListWithOpen; 82 ErrorObjListWithOpen errObjListWithOpen;
...@@ -187,7 +193,6 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg { ...@@ -187,7 +193,6 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg {
187 break; 193 break;
188 } 194 }
189 } 195 }
190 -
191 return tempObjHeader; 196 return tempObjHeader;
192 } 197 }
193 } 198 }
...@@ -246,6 +251,9 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg { ...@@ -246,6 +251,9 @@ public class PcepErrorMsgVer1 implements PcepErrorMsg {
246 251
247 public static final Writer WRITER = new Writer(); 252 public static final Writer WRITER = new Writer();
248 253
254 + /**
255 + * Writer class for writing PCEP error Message to channel buffer.
256 + */
249 static class Writer implements PcepMessageWriter<PcepErrorMsgVer1> { 257 static class Writer implements PcepMessageWriter<PcepErrorMsgVer1> {
250 @Override 258 @Override
251 public void write(ChannelBuffer cb, PcepErrorMsgVer1 message) throws PcepParseException { 259 public void write(ChannelBuffer cb, PcepErrorMsgVer1 message) throws PcepParseException {
......
...@@ -13,22 +13,24 @@ import org.slf4j.LoggerFactory; ...@@ -13,22 +13,24 @@ import org.slf4j.LoggerFactory;
13 13
14 import com.google.common.base.MoreObjects; 14 import com.google.common.base.MoreObjects;
15 15
16 -/* 16 +/**
17 -0 1 2 3 17 + * Provides PCEP Error Object.
18 -0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
19 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
20 -| Object-Class | OT |Res|P|I| Object Length (bytes) |
21 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
22 -| Reserved | Flags | Error-Type | Error-value |
23 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
24 -| |
25 -// Optional TLVs //
26 -| |
27 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
28 */ 18 */
29 -
30 public class PcepErrorObjectVer1 implements PcepErrorObject { 19 public class PcepErrorObjectVer1 implements PcepErrorObject {
31 20
21 + /*
22 + 0 1 2 3
23 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
24 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
25 + | Object-Class | OT |Res|P|I| Object Length (bytes) |
26 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
27 + | Reserved | Flags | Error-Type | Error-value |
28 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
29 + | |
30 + // Optional TLVs //
31 + | |
32 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
33 + */
32 protected static final Logger log = LoggerFactory.getLogger(PcepErrorObjectVer1.class); 34 protected static final Logger log = LoggerFactory.getLogger(PcepErrorObjectVer1.class);
33 35
34 public static final byte ERROR_OBJ_TYPE = 1; 36 public static final byte ERROR_OBJ_TYPE = 1;
......
...@@ -52,6 +52,9 @@ import org.onosproject.pcepio.protocol.PcepUpdateMsg; ...@@ -52,6 +52,9 @@ import org.onosproject.pcepio.protocol.PcepUpdateMsg;
52 import org.onosproject.pcepio.protocol.PcepUpdateRequest; 52 import org.onosproject.pcepio.protocol.PcepUpdateRequest;
53 import org.onosproject.pcepio.protocol.PcepVersion; 53 import org.onosproject.pcepio.protocol.PcepVersion;
54 54
55 +/**
56 + * Provides PCEP Factory and returns builder classes for all objects and messages.
57 + */
55 public class PcepFactoryVer1 implements PcepFactory { 58 public class PcepFactoryVer1 implements PcepFactory {
56 59
57 public static final PcepFactoryVer1 INSTANCE = new PcepFactoryVer1(); 60 public static final PcepFactoryVer1 INSTANCE = new PcepFactoryVer1();
......
...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory; ...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 +/**
30 + * Provides PCEP fec Object IPv4 Adjacency object.
31 + */
29 public class PcepFecObjectIPv4AdjacencyVer1 implements PcepFecObjectIPv4Adjacency { 32 public class PcepFecObjectIPv4AdjacencyVer1 implements PcepFecObjectIPv4Adjacency {
30 33
31 /* 34 /*
......
...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory; ...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 +/**
30 + * Provides Pcep Fec Object IPv4 Unnumbered Adjacency object.
31 + */
29 public class PcepFecObjectIPv4UnnumberedAdjacencyVer1 implements PcepFecObjectIPv4UnnumberedAdjacency { 32 public class PcepFecObjectIPv4UnnumberedAdjacencyVer1 implements PcepFecObjectIPv4UnnumberedAdjacency {
30 33
31 /* 34 /*
......
...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory; ...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 +/**
30 + * Provides Pcep Fec Object IPv4 object.
31 + */
29 public class PcepFecObjectIPv4Ver1 implements PcepFecObjectIPv4 { 32 public class PcepFecObjectIPv4Ver1 implements PcepFecObjectIPv4 {
30 33
31 /* 34 /*
......
...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory; ...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 +/**
30 + * Provides Pcep Fec Object IPv6 Adjacency object.
31 + */
29 public class PcepFecObjectIPv6AdjacencyVer1 implements PcepFecObjectIPv6Adjacency { 32 public class PcepFecObjectIPv6AdjacencyVer1 implements PcepFecObjectIPv6Adjacency {
30 33
31 /* 34 /*
......
...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory; ...@@ -26,6 +26,9 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 +/**
30 + * Provides Pcep Fec Object IPv6 object.
31 + */
29 public class PcepFecObjectIPv6Ver1 implements PcepFecObjectIPv6 { 32 public class PcepFecObjectIPv6Ver1 implements PcepFecObjectIPv6 {
30 33
31 /* 34 /*
......
...@@ -37,6 +37,9 @@ import org.slf4j.LoggerFactory; ...@@ -37,6 +37,9 @@ import org.slf4j.LoggerFactory;
37 37
38 import com.google.common.base.MoreObjects; 38 import com.google.common.base.MoreObjects;
39 39
40 +/**
41 + * Provides PCEP initiate message.
42 + */
40 class PcepInitiateMsgVer1 implements PcepInitiateMsg { 43 class PcepInitiateMsgVer1 implements PcepInitiateMsg {
41 44
42 protected static final Logger log = LoggerFactory.getLogger(PcepInitiateMsgVer1.class); 45 protected static final Logger log = LoggerFactory.getLogger(PcepInitiateMsgVer1.class);
...@@ -70,6 +73,9 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg { ...@@ -70,6 +73,9 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg {
70 private LinkedList<PcInitiatedLspRequest> llPcInitiatedLspRequestList; 73 private LinkedList<PcInitiatedLspRequest> llPcInitiatedLspRequestList;
71 public static final PcepInitiateMsgVer1.Reader READER = new Reader(); 74 public static final PcepInitiateMsgVer1.Reader READER = new Reader();
72 75
76 + /**
77 + * Reader class for reading of Pcep initiate message from channel buffer.
78 + */
73 static class Reader implements PcepMessageReader<PcepInitiateMsg> { 79 static class Reader implements PcepMessageReader<PcepInitiateMsg> {
74 80
75 LinkedList<PcInitiatedLspRequest> llPcInitiatedLspRequestList; 81 LinkedList<PcInitiatedLspRequest> llPcInitiatedLspRequestList;
...@@ -159,7 +165,6 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg { ...@@ -159,7 +165,6 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg {
159 } 165 }
160 llPcInitiatedLspRequestList.add(pceInitLspReq); 166 llPcInitiatedLspRequestList.add(pceInitLspReq);
161 } 167 }
162 -
163 return true; 168 return true;
164 } 169 }
165 } 170 }
...@@ -219,6 +224,9 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg { ...@@ -219,6 +224,9 @@ class PcepInitiateMsgVer1 implements PcepInitiateMsg {
219 224
220 static final Writer WRITER = new Writer(); 225 static final Writer WRITER = new Writer();
221 226
227 + /**
228 + * Writer class for writing pcep initiate message to channel buffer.
229 + */
222 static class Writer implements PcepMessageWriter<PcepInitiateMsgVer1> { 230 static class Writer implements PcepMessageWriter<PcepInitiateMsgVer1> {
223 231
224 @Override 232 @Override
......
...@@ -24,15 +24,18 @@ import org.slf4j.LoggerFactory; ...@@ -24,15 +24,18 @@ import org.slf4j.LoggerFactory;
24 24
25 import com.google.common.base.MoreObjects; 25 import com.google.common.base.MoreObjects;
26 26
27 -/* 27 +/**
28 - * 0 1 2 3 28 + * Provides PCEP inter layer object.
29 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
30 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
31 - | Reserved |N|I|
32 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
33 */ 29 */
34 public class PcepInterLayerObjectVer1 implements PcepInterLayerObject { 30 public class PcepInterLayerObjectVer1 implements PcepInterLayerObject {
35 31
32 + /*
33 + * 0 1 2 3
34 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
35 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
36 + | Reserved |N|I|
37 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
38 + */
36 protected static final Logger log = LoggerFactory.getLogger(PcepInterLayerObjectVer1.class); 39 protected static final Logger log = LoggerFactory.getLogger(PcepInterLayerObjectVer1.class);
37 40
38 public static final byte INTER_LAYER_OBJ_TYPE = 1; 41 public static final byte INTER_LAYER_OBJ_TYPE = 1;
......
...@@ -30,7 +30,12 @@ import org.slf4j.LoggerFactory; ...@@ -30,7 +30,12 @@ import org.slf4j.LoggerFactory;
30 30
31 import com.google.common.base.MoreObjects; 31 import com.google.common.base.MoreObjects;
32 32
33 -/* 33 +/**
34 + * Provides PCEP iro object.
35 + */
36 +public class PcepIroObjectVer1 implements PcepIroObject {
37 +
38 + /*
34 0 1 2 3 39 0 1 2 3
35 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 40 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
36 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 41 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
...@@ -50,9 +55,7 @@ import com.google.common.base.MoreObjects; ...@@ -50,9 +55,7 @@ import com.google.common.base.MoreObjects;
50 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 55 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51 | IPv4 address (continued) | Prefix Length | Resvd | 56 | IPv4 address (continued) | Prefix Length | Resvd |
52 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 57 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53 - */ 58 + */
54 -public class PcepIroObjectVer1 implements PcepIroObject {
55 -
56 protected static final Logger log = LoggerFactory.getLogger(PcepIroObjectVer1.class); 59 protected static final Logger log = LoggerFactory.getLogger(PcepIroObjectVer1.class);
57 60
58 public static final byte IRO_OBJ_TYPE = 1; 61 public static final byte IRO_OBJ_TYPE = 1;
...@@ -217,6 +220,9 @@ public class PcepIroObjectVer1 implements PcepIroObject { ...@@ -217,6 +220,9 @@ public class PcepIroObjectVer1 implements PcepIroObject {
217 return objLenIndex; 220 return objLenIndex;
218 } 221 }
219 222
223 + /**
224 + * Builder class for PCEP iro object.
225 + */
220 public static class Builder implements PcepIroObject.Builder { 226 public static class Builder implements PcepIroObject.Builder {
221 227
222 private boolean bIsHeaderSet = false; 228 private boolean bIsHeaderSet = false;
......
...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory; ...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory;
28 28
29 import com.google.common.base.MoreObjects; 29 import com.google.common.base.MoreObjects;
30 30
31 +/**
32 + * Provides PCEP keep alive message.
33 + */
31 class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg { 34 class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg {
32 35
33 /* 36 /*
...@@ -47,6 +50,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg { ...@@ -47,6 +50,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg {
47 50
48 public static final PcepKeepaliveMsgVer1.Reader READER = new Reader(); 51 public static final PcepKeepaliveMsgVer1.Reader READER = new Reader();
49 52
53 + /**
54 + * Reader class for reading PCEP keepalive message from channel buffer.
55 + */
50 static class Reader implements PcepMessageReader<PcepKeepaliveMsg> { 56 static class Reader implements PcepMessageReader<PcepKeepaliveMsg> {
51 57
52 @Override 58 @Override
...@@ -81,6 +87,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg { ...@@ -81,6 +87,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg {
81 PcepKeepaliveMsgVer1() { 87 PcepKeepaliveMsgVer1() {
82 } 88 }
83 89
90 + /**
91 + * Builder class for PCEP keepalive message.
92 + */
84 static class Builder implements PcepKeepaliveMsg.Builder { 93 static class Builder implements PcepKeepaliveMsg.Builder {
85 @Override 94 @Override
86 public PcepVersion getVersion() { 95 public PcepVersion getVersion() {
...@@ -105,6 +114,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg { ...@@ -105,6 +114,9 @@ class PcepKeepaliveMsgVer1 implements PcepKeepaliveMsg {
105 114
106 static final Writer WRITER = new Writer(); 115 static final Writer WRITER = new Writer();
107 116
117 + /**
118 + * Writer class for writing the PCEP keepalive message to channel buffer.
119 + */
108 static class Writer implements PcepMessageWriter<PcepKeepaliveMsgVer1> { 120 static class Writer implements PcepMessageWriter<PcepKeepaliveMsgVer1> {
109 121
110 @Override 122 @Override
......
...@@ -32,8 +32,13 @@ import org.slf4j.LoggerFactory; ...@@ -32,8 +32,13 @@ import org.slf4j.LoggerFactory;
32 32
33 import com.google.common.base.MoreObjects; 33 import com.google.common.base.MoreObjects;
34 34
35 -/* 35 +/**
36 - * ref : draft-zhao-pce-pcep-extension-for-pce-controller-01 , section : 7.4. 36 + * Provides PCEP label object.
37 + */
38 +public class PcepLabelObjectVer1 implements PcepLabelObject {
39 +
40 + /*
41 + * ref : draft-zhao-pce-pcep-extension-for-pce-controller-01 , section : 7.4.
37 42
38 0 1 2 3 43 0 1 2 3
39 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 44 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
...@@ -47,9 +52,7 @@ import com.google.common.base.MoreObjects; ...@@ -47,9 +52,7 @@ import com.google.common.base.MoreObjects;
47 | | 52 | |
48 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 53 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49 The LABEL Object format 54 The LABEL Object format
50 - */ 55 + */
51 -public class PcepLabelObjectVer1 implements PcepLabelObject {
52 -
53 protected static final Logger log = LoggerFactory.getLogger(PcepLspObjectVer1.class); 56 protected static final Logger log = LoggerFactory.getLogger(PcepLspObjectVer1.class);
54 57
55 public static final byte LABEL_OBJ_TYPE = 1; 58 public static final byte LABEL_OBJ_TYPE = 1;
......
...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory; ...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory;
30 30
31 import com.google.common.base.MoreObjects; 31 import com.google.common.base.MoreObjects;
32 32
33 +/**
34 + * Provides PCEP label range object.
35 + */
33 public class PcepLabelRangeObjectVer1 implements PcepLabelRangeObject { 36 public class PcepLabelRangeObjectVer1 implements PcepLabelRangeObject {
34 37
35 /* 38 /*
......
...@@ -29,6 +29,9 @@ import org.slf4j.LoggerFactory; ...@@ -29,6 +29,9 @@ import org.slf4j.LoggerFactory;
29 29
30 import com.google.common.base.MoreObjects; 30 import com.google.common.base.MoreObjects;
31 31
32 +/**
33 + * Provides PCEP label range reserve message.
34 + */
32 class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg { 35 class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg {
33 36
34 // Pcep version: 1 37 // Pcep version: 1
...@@ -57,7 +60,9 @@ class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg { ...@@ -57,7 +60,9 @@ class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg {
57 60
58 public static final PcepLabelRangeResvMsgVer1.Reader READER = new Reader(); 61 public static final PcepLabelRangeResvMsgVer1.Reader READER = new Reader();
59 62
60 - //Reader reads LabelRangeResv Message from the channel. 63 + /**
64 + * Reader reads LabelRangeResv Message from the channel.
65 + */
61 static class Reader implements PcepMessageReader<PcepLabelRangeResvMsg> { 66 static class Reader implements PcepMessageReader<PcepLabelRangeResvMsg> {
62 67
63 @Override 68 @Override
...@@ -138,7 +143,9 @@ class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg { ...@@ -138,7 +143,9 @@ class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg {
138 143
139 static final Writer WRITER = new Writer(); 144 static final Writer WRITER = new Writer();
140 145
141 - //Writer writes LabelRangeResv Message to the channel. 146 + /**
147 + * Writer writes LabelRangeResv Message to the channel.
148 + */
142 static class Writer implements PcepMessageWriter<PcepLabelRangeResvMsgVer1> { 149 static class Writer implements PcepMessageWriter<PcepLabelRangeResvMsgVer1> {
143 150
144 @Override 151 @Override
......
...@@ -32,6 +32,9 @@ import org.slf4j.LoggerFactory; ...@@ -32,6 +32,9 @@ import org.slf4j.LoggerFactory;
32 32
33 import com.google.common.base.MoreObjects; 33 import com.google.common.base.MoreObjects;
34 34
35 +/**
36 + * Provides PCEP lable update message.
37 + */
35 class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg { 38 class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg {
36 39
37 // Pcep version: 1 40 // Pcep version: 1
...@@ -72,7 +75,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg { ...@@ -72,7 +75,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg {
72 75
73 static final PcepLabelUpdateMsgVer1.Reader READER = new Reader(); 76 static final PcepLabelUpdateMsgVer1.Reader READER = new Reader();
74 77
75 - //Reader reads LabelUpdate Message from the channel. 78 + /**
79 + * Reader reads LabelUpdate Message from the channel.
80 + */
76 static class Reader implements PcepMessageReader<PcepLabelUpdateMsg> { 81 static class Reader implements PcepMessageReader<PcepLabelUpdateMsg> {
77 82
78 @Override 83 @Override
...@@ -131,6 +136,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg { ...@@ -131,6 +136,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg {
131 this.llPcLabelUpdateList = llPcLabelUpdateList; 136 this.llPcLabelUpdateList = llPcLabelUpdateList;
132 } 137 }
133 138
139 + /**
140 + * Builder class for PCEP label update message.
141 + */
134 static class Builder implements PcepLabelUpdateMsg.Builder { 142 static class Builder implements PcepLabelUpdateMsg.Builder {
135 143
136 LinkedList<PcepLabelUpdate> llPcLabelUpdateList; 144 LinkedList<PcepLabelUpdate> llPcLabelUpdateList;
...@@ -169,7 +177,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg { ...@@ -169,7 +177,9 @@ class PcepLabelUpdateMsgVer1 implements PcepLabelUpdateMsg {
169 177
170 static final Writer WRITER = new Writer(); 178 static final Writer WRITER = new Writer();
171 179
172 - //Writer writes LabelUpdate Message to the channel. 180 + /**
181 + * Writer writes LabelUpdate Message to the channel.
182 + */
173 static class Writer implements PcepMessageWriter<PcepLabelUpdateMsgVer1> { 183 static class Writer implements PcepMessageWriter<PcepLabelUpdateMsgVer1> {
174 184
175 @Override 185 @Override
......
...@@ -34,7 +34,12 @@ import org.slf4j.LoggerFactory; ...@@ -34,7 +34,12 @@ import org.slf4j.LoggerFactory;
34 34
35 import com.google.common.base.MoreObjects; 35 import com.google.common.base.MoreObjects;
36 36
37 -/* 37 +/**
38 + * Provides PCEP lsp object.
39 + */
40 +public class PcepLspObjectVer1 implements PcepLspObject {
41 +
42 + /*
38 message format. 43 message format.
39 Reference : draft-ietf-pce-stateful-pce-11, section 7.3. 44 Reference : draft-ietf-pce-stateful-pce-11, section 7.3.
40 0 1 2 3 45 0 1 2 3
...@@ -49,10 +54,7 @@ import com.google.common.base.MoreObjects; ...@@ -49,10 +54,7 @@ import com.google.common.base.MoreObjects;
49 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 54 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
50 55
51 The LSP Object format 56 The LSP Object format
52 - */ 57 + */
53 -
54 -public class PcepLspObjectVer1 implements PcepLspObject {
55 -
56 protected static final Logger log = LoggerFactory.getLogger(PcepLspObjectVer1.class); 58 protected static final Logger log = LoggerFactory.getLogger(PcepLspObjectVer1.class);
57 59
58 public static final byte LSP_OBJ_TYPE = 1; 60 public static final byte LSP_OBJ_TYPE = 1;
......
...@@ -29,6 +29,9 @@ import org.slf4j.LoggerFactory; ...@@ -29,6 +29,9 @@ import org.slf4j.LoggerFactory;
29 29
30 import com.google.common.base.MoreObjects; 30 import com.google.common.base.MoreObjects;
31 31
32 +/**
33 + * Provides PCEP label Object .
34 + */
32 public class PcepLspaObjectVer1 implements PcepLspaObject { 35 public class PcepLspaObjectVer1 implements PcepLspaObject {
33 36
34 /* LSPA Object Body Format 37 /* LSPA Object Body Format
...@@ -72,8 +75,6 @@ public class PcepLspaObjectVer1 implements PcepLspaObject { ...@@ -72,8 +75,6 @@ public class PcepLspaObjectVer1 implements PcepLspaObject {
72 private int iIncludeAll; 75 private int iIncludeAll;
73 private byte cSetupPriority; 76 private byte cSetupPriority;
74 private byte cHoldPriority; 77 private byte cHoldPriority;
75 - private byte flags;
76 - private byte reserved;
77 private boolean bLFlag; 78 private boolean bLFlag;
78 private LinkedList<PcepValueType> llOptionalTlv; //Optional TLV 79 private LinkedList<PcepValueType> llOptionalTlv; //Optional TLV
79 80
...@@ -343,7 +344,7 @@ public class PcepLspaObjectVer1 implements PcepLspaObject { ...@@ -343,7 +344,7 @@ public class PcepLspaObjectVer1 implements PcepLspaObject {
343 } 344 }
344 345
345 /** 346 /**
346 - * builder class for PCEP lspa object. 347 + * Builder class for PCEP lspa object.
347 */ 348 */
348 public static class Builder implements PcepLspaObject.Builder { 349 public static class Builder implements PcepLspaObject.Builder {
349 private boolean bIsHeaderSet = false; 350 private boolean bIsHeaderSet = false;
......
...@@ -25,6 +25,9 @@ import org.onosproject.pcepio.types.PcepErrorDetailInfo; ...@@ -25,6 +25,9 @@ import org.onosproject.pcepio.types.PcepErrorDetailInfo;
25 import org.slf4j.Logger; 25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory; 26 import org.slf4j.LoggerFactory;
27 27
28 +/**
29 + * Provides PCEP messages.
30 + */
28 public abstract class PcepMessageVer1 { 31 public abstract class PcepMessageVer1 {
29 32
30 protected static final Logger log = LoggerFactory.getLogger(PcepFactories.class); 33 protected static final Logger log = LoggerFactory.getLogger(PcepFactories.class);
...@@ -48,6 +51,9 @@ public abstract class PcepMessageVer1 { ...@@ -48,6 +51,9 @@ public abstract class PcepMessageVer1 {
48 51
49 public static final PcepMessageVer1.Reader READER = new Reader(); 52 public static final PcepMessageVer1.Reader READER = new Reader();
50 53
54 + /**
55 + * Reader class for reading PCEP messages from channel buffer.
56 + */
51 static class Reader implements PcepMessageReader<PcepMessage> { 57 static class Reader implements PcepMessageReader<PcepMessage> {
52 @Override 58 @Override
53 public PcepMessage readFrom(ChannelBuffer cb) throws PcepParseException { 59 public PcepMessage readFrom(ChannelBuffer cb) throws PcepParseException {
......
...@@ -25,7 +25,12 @@ import org.slf4j.LoggerFactory; ...@@ -25,7 +25,12 @@ import org.slf4j.LoggerFactory;
25 25
26 import com.google.common.base.MoreObjects; 26 import com.google.common.base.MoreObjects;
27 27
28 -/* 28 +/**
29 + * Provides PCEP metric object.
30 + */
31 +public class PcepMetricObjectVer1 implements PcepMetricObject {
32 +
33 + /*
29 METRIC Object Body Format. 34 METRIC Object Body Format.
30 35
31 0 1 2 3 36 0 1 2 3
...@@ -35,9 +40,7 @@ import com.google.common.base.MoreObjects; ...@@ -35,9 +40,7 @@ import com.google.common.base.MoreObjects;
35 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 40 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
36 | metric-value | 41 | metric-value |
37 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 42 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
38 - */ 43 + */
39 -
40 -public class PcepMetricObjectVer1 implements PcepMetricObject {
41 44
42 protected static final Logger log = LoggerFactory.getLogger(PcepMetricObjectVer1.class); 45 protected static final Logger log = LoggerFactory.getLogger(PcepMetricObjectVer1.class);
43 46
......
...@@ -102,7 +102,7 @@ public class PcepMsgPathVer1 implements PcepMsgPath { ...@@ -102,7 +102,7 @@ public class PcepMsgPathVer1 implements PcepMsgPath {
102 } 102 }
103 103
104 /** 104 /**
105 - * builder class for PCEP Message path. 105 + * Builder class for PCEP Message path.
106 */ 106 */
107 public static class Builder implements PcepMsgPath.Builder { 107 public static class Builder implements PcepMsgPath.Builder {
108 108
......
...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory; ...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory;
30 30
31 import com.google.common.base.MoreObjects; 31 import com.google.common.base.MoreObjects;
32 32
33 +/**
34 + * Provides PCEP open message.
35 + */
33 public class PcepOpenMsgVer1 implements PcepOpenMsg { 36 public class PcepOpenMsgVer1 implements PcepOpenMsg {
34 37
35 /* 38 /*
...@@ -87,6 +90,9 @@ public class PcepOpenMsgVer1 implements PcepOpenMsg { ...@@ -87,6 +90,9 @@ public class PcepOpenMsgVer1 implements PcepOpenMsg {
87 return MSG_TYPE; 90 return MSG_TYPE;
88 } 91 }
89 92
93 + /**
94 + * Reader class for reading PCEP open message from channel buffer.
95 + */
90 public static class Reader implements PcepMessageReader<PcepOpenMsg> { 96 public static class Reader implements PcepMessageReader<PcepOpenMsg> {
91 97
92 @Override 98 @Override
...@@ -162,6 +168,9 @@ public class PcepOpenMsgVer1 implements PcepOpenMsg { ...@@ -162,6 +168,9 @@ public class PcepOpenMsgVer1 implements PcepOpenMsg {
162 168
163 public static final Writer WRITER = new Writer(); 169 public static final Writer WRITER = new Writer();
164 170
171 + /**
172 + * Writer class for writing PCEP opne message to channel buffer.
173 + */
165 public static class Writer implements PcepMessageWriter<PcepOpenMsgVer1> { 174 public static class Writer implements PcepMessageWriter<PcepOpenMsgVer1> {
166 175
167 @Override 176 @Override
......
...@@ -37,7 +37,12 @@ import org.slf4j.LoggerFactory; ...@@ -37,7 +37,12 @@ import org.slf4j.LoggerFactory;
37 37
38 import com.google.common.base.MoreObjects; 38 import com.google.common.base.MoreObjects;
39 39
40 -/* 40 +/**
41 + * Provides PCEP open object.
42 + */
43 +public class PcepOpenObjectVer1 implements PcepOpenObject {
44 +
45 + /*
41 message format. 46 message format.
42 0 1 2 3 47 0 1 2 3
43 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 48 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
...@@ -52,10 +57,7 @@ import com.google.common.base.MoreObjects; ...@@ -52,10 +57,7 @@ import com.google.common.base.MoreObjects;
52 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 57 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53 58
54 The OPEN Object format 59 The OPEN Object format
55 - */ 60 + */
56 -
57 -public class PcepOpenObjectVer1 implements PcepOpenObject {
58 -
59 protected static final Logger log = LoggerFactory.getLogger(PcepOpenObjectVer1.class); 61 protected static final Logger log = LoggerFactory.getLogger(PcepOpenObjectVer1.class);
60 62
61 public static final PcepType MSG_TYPE = PcepType.OPEN; 63 public static final PcepType MSG_TYPE = PcepType.OPEN;
...@@ -341,10 +343,12 @@ public class PcepOpenObjectVer1 implements PcepOpenObject { ...@@ -341,10 +343,12 @@ public class PcepOpenObjectVer1 implements PcepOpenObject {
341 } 343 }
342 } 344 }
343 } 345 }
344 -
345 return cb.writerIndex() - startIndex; 346 return cb.writerIndex() - startIndex;
346 } 347 }
347 348
349 + /**
350 + * Builder class for PCPE open object.
351 + */
348 public static class Builder implements PcepOpenObject.Builder { 352 public static class Builder implements PcepOpenObject.Builder {
349 // Pcep open message fields 353 // Pcep open message fields
350 private boolean bIsHeaderSet = false; 354 private boolean bIsHeaderSet = false;
......
...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory; ...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory;
28 28
29 import com.google.common.base.MoreObjects; 29 import com.google.common.base.MoreObjects;
30 30
31 +/**
32 + * Provides PCEP RP object.
33 + */
31 public class PcepRPObjectVer1 implements PcepRPObject { 34 public class PcepRPObjectVer1 implements PcepRPObject {
32 35
33 /* 36 /*
...@@ -271,6 +274,9 @@ public class PcepRPObjectVer1 implements PcepRPObject { ...@@ -271,6 +274,9 @@ public class PcepRPObjectVer1 implements PcepRPObject {
271 return cb.writerIndex(); 274 return cb.writerIndex();
272 } 275 }
273 276
277 + /**
278 + * Builder class for PCEP rp object.
279 + */
274 public static class Builder implements PcepRPObject.Builder { 280 public static class Builder implements PcepRPObject.Builder {
275 281
276 private boolean bIsHeaderSet = false; 282 private boolean bIsHeaderSet = false;
......
...@@ -35,6 +35,9 @@ import org.slf4j.LoggerFactory; ...@@ -35,6 +35,9 @@ import org.slf4j.LoggerFactory;
35 35
36 import com.google.common.base.MoreObjects; 36 import com.google.common.base.MoreObjects;
37 37
38 +/**
39 + * Provides PCEP report message.
40 + */
38 class PcepReportMsgVer1 implements PcepReportMsg { 41 class PcepReportMsgVer1 implements PcepReportMsg {
39 42
40 // Pcep version: 1 43 // Pcep version: 1
...@@ -71,6 +74,9 @@ class PcepReportMsgVer1 implements PcepReportMsg { ...@@ -71,6 +74,9 @@ class PcepReportMsgVer1 implements PcepReportMsg {
71 74
72 public static final PcepReportMsgVer1.Reader READER = new Reader(); 75 public static final PcepReportMsgVer1.Reader READER = new Reader();
73 76
77 + /**
78 + * Reader class for reading PCEP report message from channel buffer.
79 + */
74 static class Reader implements PcepMessageReader<PcepReportMsg> { 80 static class Reader implements PcepMessageReader<PcepReportMsg> {
75 81
76 LinkedList<PcepStateReport> llStateReportList; 82 LinkedList<PcepStateReport> llStateReportList;
...@@ -217,6 +223,9 @@ class PcepReportMsgVer1 implements PcepReportMsg { ...@@ -217,6 +223,9 @@ class PcepReportMsgVer1 implements PcepReportMsg {
217 223
218 static final Writer WRITER = new Writer(); 224 static final Writer WRITER = new Writer();
219 225
226 + /**
227 + * Writer class for writing PCEP report message to channel buffer.
228 + */
220 static class Writer implements PcepMessageWriter<PcepReportMsgVer1> { 229 static class Writer implements PcepMessageWriter<PcepReportMsgVer1> {
221 230
222 @Override 231 @Override
......
...@@ -32,8 +32,13 @@ import org.slf4j.LoggerFactory; ...@@ -32,8 +32,13 @@ import org.slf4j.LoggerFactory;
32 32
33 import com.google.common.base.MoreObjects; 33 import com.google.common.base.MoreObjects;
34 34
35 -/* 35 +/**
36 - * rfc3209 36 + * Provides PCEP RRO object.
37 + */
38 +public class PcepRroObjectVer1 implements PcepRroObject {
39 +
40 + /*
41 + * rfc3209
37 0 1 2 3 42 0 1 2 3
38 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 43 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
39 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 44 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
...@@ -88,9 +93,7 @@ import com.google.common.base.MoreObjects; ...@@ -88,9 +93,7 @@ import com.google.common.base.MoreObjects;
88 | Contents of Label Object | 93 | Contents of Label Object |
89 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 94 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
90 95
91 - */ 96 + */
92 -public class PcepRroObjectVer1 implements PcepRroObject {
93 -
94 protected static final Logger log = LoggerFactory.getLogger(PcepRroObjectVer1.class); 97 protected static final Logger log = LoggerFactory.getLogger(PcepRroObjectVer1.class);
95 98
96 public static final byte RRO_OBJ_TYPE = 1; 99 public static final byte RRO_OBJ_TYPE = 1;
......
...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory; ...@@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory;
30 30
31 import com.google.common.base.MoreObjects; 31 import com.google.common.base.MoreObjects;
32 32
33 +/**
34 + * Provides PCEP SRP obejct.
35 + */
33 public class PcepSrpObjectVer1 implements PcepSrpObject { 36 public class PcepSrpObjectVer1 implements PcepSrpObject {
34 37
35 /* 38 /*
...@@ -276,7 +279,7 @@ public class PcepSrpObjectVer1 implements PcepSrpObject { ...@@ -276,7 +279,7 @@ public class PcepSrpObjectVer1 implements PcepSrpObject {
276 } 279 }
277 280
278 /** 281 /**
279 - * builder class for PCEP srp Object. 282 + * Builder class for PCEP srp Object.
280 */ 283 */
281 public static class Builder implements PcepSrpObject.Builder { 284 public static class Builder implements PcepSrpObject.Builder {
282 private boolean bIsHeaderSet = false; 285 private boolean bIsHeaderSet = false;
......
...@@ -89,9 +89,10 @@ public class PcepStateReportVer1 implements PcepStateReport { ...@@ -89,9 +89,10 @@ public class PcepStateReportVer1 implements PcepStateReport {
89 * @param eroObj PCEP ERO Object 89 * @param eroObj PCEP ERO Object
90 * @param attrList PCEP Attribute 90 * @param attrList PCEP Attribute
91 * @param rroObj PCEP Rro Object 91 * @param rroObj PCEP Rro Object
92 + * @param bandwidth PCEP bandwidth object
92 */ 93 */
93 public PcepMsgPath(PcepEroObject eroObj, PcepAttribute attrList, PcepRroObject rroObj, 94 public PcepMsgPath(PcepEroObject eroObj, PcepAttribute attrList, PcepRroObject rroObj,
94 - PcepBandwidthObject bandwidth) { 95 + PcepBandwidthObject bandwidth) {
95 96
96 this.eroObj = eroObj; 97 this.eroObj = eroObj;
97 this.attrList = attrList; 98 this.attrList = attrList;
......
...@@ -35,6 +35,9 @@ import org.slf4j.LoggerFactory; ...@@ -35,6 +35,9 @@ import org.slf4j.LoggerFactory;
35 35
36 import com.google.common.base.MoreObjects; 36 import com.google.common.base.MoreObjects;
37 37
38 +/**
39 + * Provides PCEP TE Object.
40 + */
38 public class PcepTEObjectVer1 implements PcepTEObject { 41 public class PcepTEObjectVer1 implements PcepTEObject {
39 /* 42 /*
40 * 43 *
...@@ -325,7 +328,6 @@ public class PcepTEObjectVer1 implements PcepTEObject { ...@@ -325,7 +328,6 @@ public class PcepTEObjectVer1 implements PcepTEObject {
325 328
326 throw new PcepParseException("Optional Tlv parsing error. Extra bytes received."); 329 throw new PcepParseException("Optional Tlv parsing error. Extra bytes received.");
327 } 330 }
328 -
329 return llOutOptionalTlv; 331 return llOutOptionalTlv;
330 } 332 }
331 333
...@@ -358,10 +360,12 @@ public class PcepTEObjectVer1 implements PcepTEObject { ...@@ -358,10 +360,12 @@ public class PcepTEObjectVer1 implements PcepTEObject {
358 } 360 }
359 } 361 }
360 } 362 }
361 -
362 return cb.writerIndex(); 363 return cb.writerIndex();
363 } 364 }
364 365
366 + /**
367 + * Builder class for PCEP te object.
368 + */
365 public static class Builder implements PcepTEObject.Builder { 369 public static class Builder implements PcepTEObject.Builder {
366 private boolean bIsHeaderSet = false; 370 private boolean bIsHeaderSet = false;
367 private boolean bIsProtocolIdSet = false; 371 private boolean bIsProtocolIdSet = false;
......
...@@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; ...@@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory;
32 32
33 import com.google.common.base.MoreObjects; 33 import com.google.common.base.MoreObjects;
34 34
35 -/* 35 +/**
36 * Provides PCEP TE Report Message. 36 * Provides PCEP TE Report Message.
37 */ 37 */
38 class PcepTEReportMsgVer1 implements PcepTEReportMsg { 38 class PcepTEReportMsgVer1 implements PcepTEReportMsg {
...@@ -55,6 +55,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg { ...@@ -55,6 +55,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg {
55 55
56 public static final PcepTEReportMsgVer1.Reader READER = new Reader(); 56 public static final PcepTEReportMsgVer1.Reader READER = new Reader();
57 57
58 + /**
59 + * Reader class for reading PCPE te report message form channel buffer.
60 + */
58 static class Reader implements PcepMessageReader<PcepTEReportMsg> { 61 static class Reader implements PcepMessageReader<PcepTEReportMsg> {
59 62
60 LinkedList<PcepTEObject> teReportList; 63 LinkedList<PcepTEObject> teReportList;
...@@ -118,6 +121,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg { ...@@ -118,6 +121,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg {
118 this.teReportList = teReportList; 121 this.teReportList = teReportList;
119 } 122 }
120 123
124 + /**
125 + * Builder class for PCEP te report message.
126 + */
121 static class Builder implements PcepTEReportMsg.Builder { 127 static class Builder implements PcepTEReportMsg.Builder {
122 // PCEP TE Report message fields 128 // PCEP TE Report message fields
123 LinkedList<PcepTEObject> teReportList; 129 LinkedList<PcepTEObject> teReportList;
...@@ -156,6 +162,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg { ...@@ -156,6 +162,9 @@ class PcepTEReportMsgVer1 implements PcepTEReportMsg {
156 162
157 static final Writer WRITER = new Writer(); 163 static final Writer WRITER = new Writer();
158 164
165 + /**
166 + * Writer class for writing PCEP te report message to channel buffer.
167 + */
159 static class Writer implements PcepMessageWriter<PcepTEReportMsgVer1> { 168 static class Writer implements PcepMessageWriter<PcepTEReportMsgVer1> {
160 169
161 @Override 170 @Override
......
...@@ -36,9 +36,7 @@ import org.slf4j.LoggerFactory; ...@@ -36,9 +36,7 @@ import org.slf4j.LoggerFactory;
36 import com.google.common.base.MoreObjects; 36 import com.google.common.base.MoreObjects;
37 37
38 /** 38 /**
39 - * PCEP Update Message: A Path Computation LSP Update Request message 39 + * Provides PCEP update message.
40 - * (also referred to as PCUpd message) is a PCEP message sent by a PCE
41 - * to a PCC to update attributes of an LSP.
42 */ 40 */
43 41
44 class PcepUpdateMsgVer1 implements PcepUpdateMsg { 42 class PcepUpdateMsgVer1 implements PcepUpdateMsg {
...@@ -88,7 +86,9 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg { ...@@ -88,7 +86,9 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg {
88 86
89 public static final PcepUpdateMsgVer1.Reader READER = new Reader(); 87 public static final PcepUpdateMsgVer1.Reader READER = new Reader();
90 88
91 - //Reader reads UpdateMessage from the channel. 89 + /**
90 + * Reader reads UpdateMessage from the channel.
91 + */
92 static class Reader implements PcepMessageReader<PcepUpdateMsg> { 92 static class Reader implements PcepMessageReader<PcepUpdateMsg> {
93 93
94 LinkedList<PcepUpdateRequest> llUpdateRequestList; 94 LinkedList<PcepUpdateRequest> llUpdateRequestList;
...@@ -184,7 +184,7 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg { ...@@ -184,7 +184,7 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg {
184 } 184 }
185 185
186 /** 186 /**
187 - * builder class for PCPE update message. 187 + * Builder class for PCPE update message.
188 */ 188 */
189 static class Builder implements PcepUpdateMsg.Builder { 189 static class Builder implements PcepUpdateMsg.Builder {
190 190
...@@ -226,7 +226,9 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg { ...@@ -226,7 +226,9 @@ class PcepUpdateMsgVer1 implements PcepUpdateMsg {
226 226
227 static final Writer WRITER = new Writer(); 227 static final Writer WRITER = new Writer();
228 228
229 - //Writer writes UpdateMessage to the channel buffer. 229 + /**
230 + * Writer writes UpdateMessage to the channel buffer.
231 + */
230 static class Writer implements PcepMessageWriter<PcepUpdateMsgVer1> { 232 static class Writer implements PcepMessageWriter<PcepUpdateMsgVer1> {
231 233
232 @Override 234 @Override
......
...@@ -26,8 +26,8 @@ import org.slf4j.LoggerFactory; ...@@ -26,8 +26,8 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 -/* 29 +/**
30 - * PCEP Update Request List. 30 + * Provides PCEP Update Request List.
31 */ 31 */
32 public class PcepUpdateRequestVer1 implements PcepUpdateRequest { 32 public class PcepUpdateRequestVer1 implements PcepUpdateRequest {
33 33
......
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 PCEP messages.
19 + */
20 +package org.onosproject.pcepio.protocol.ver1;
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
16 16
17 package org.onosproject.pcepio.types; 17 package org.onosproject.pcepio.types;
18 18
19 -/* 19 +/**
20 * Provide the PCEP Error Info Details. 20 * Provide the PCEP Error Info Details.
21 */ 21 */
22 public final class PcepErrorDetailInfo { 22 public final class PcepErrorDetailInfo {
......
...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai; ...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai;
23 23
24 import com.google.common.base.MoreObjects; 24 import com.google.common.base.MoreObjects;
25 25
26 +/**
27 + * Provides Pcep Nai Ipv4 Adjacency.
28 + */
26 public class PcepNaiIpv4Adjacency implements PcepNai { 29 public class PcepNaiIpv4Adjacency implements PcepNai {
27 30
28 public static final byte ST_TYPE = 0x03; 31 public static final byte ST_TYPE = 0x03;
......
...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai; ...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai;
23 23
24 import com.google.common.base.MoreObjects; 24 import com.google.common.base.MoreObjects;
25 25
26 +/**
27 + * Provides Pcep Nai Ipv4 Node Id.
28 + */
26 public class PcepNaiIpv4NodeId implements PcepNai { 29 public class PcepNaiIpv4NodeId implements PcepNai {
27 30
28 public static final byte ST_TYPE = 0x01; 31 public static final byte ST_TYPE = 0x01;
......
...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai; ...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai;
23 23
24 import com.google.common.base.MoreObjects; 24 import com.google.common.base.MoreObjects;
25 25
26 +/**
27 + * Provides Pcep Nai Ipv6 Adjacency.
28 + */
26 public class PcepNaiIpv6Adjacency implements PcepNai { 29 public class PcepNaiIpv6Adjacency implements PcepNai {
27 30
28 public static final byte ST_TYPE = 0x04; 31 public static final byte ST_TYPE = 0x04;
......
...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai; ...@@ -23,6 +23,9 @@ import org.onosproject.pcepio.protocol.PcepNai;
23 23
24 import com.google.common.base.MoreObjects; 24 import com.google.common.base.MoreObjects;
25 25
26 +/**
27 + * Provides Pcep Nai Ipv6 Node Id.
28 + */
26 public class PcepNaiIpv6NodeId implements PcepNai { 29 public class PcepNaiIpv6NodeId implements PcepNai {
27 30
28 public static final byte ST_TYPE = 0x02; 31 public static final byte ST_TYPE = 0x02;
......
...@@ -7,6 +7,9 @@ import org.onosproject.pcepio.protocol.PcepNai; ...@@ -7,6 +7,9 @@ import org.onosproject.pcepio.protocol.PcepNai;
7 7
8 import com.google.common.base.MoreObjects; 8 import com.google.common.base.MoreObjects;
9 9
10 +/**
11 + * Provides Pcep Nai Unnumbered Adjacency Ipv4.
12 + */
10 public class PcepNaiUnnumberedAdjacencyIpv4 implements PcepNai { 13 public class PcepNaiUnnumberedAdjacencyIpv4 implements PcepNai {
11 /** 14 /**
12 * draft-ietf-pce-segment-routing-03 section 5.3.2. 15 * draft-ietf-pce-segment-routing-03 section 5.3.2.
......
...@@ -17,6 +17,9 @@ package org.onosproject.pcepio.types; ...@@ -17,6 +17,9 @@ package org.onosproject.pcepio.types;
17 17
18 import org.jboss.netty.buffer.ChannelBuffer; 18 import org.jboss.netty.buffer.ChannelBuffer;
19 19
20 +/**
21 + * Abstraction of an entity which provides PCPE RSVP error spec.
22 + */
20 public interface PcepRsvpErrorSpec extends PcepValueType { 23 public interface PcepRsvpErrorSpec extends PcepValueType {
21 24
22 /** 25 /**
......
...@@ -20,6 +20,9 @@ import org.onosproject.pcepio.protocol.PcepVersion; ...@@ -20,6 +20,9 @@ import org.onosproject.pcepio.protocol.PcepVersion;
20 20
21 import com.google.common.base.MoreObjects; 21 import com.google.common.base.MoreObjects;
22 22
23 +/**
24 + * Provides Pcep Rsvp Ipv4 Error Spec.
25 + */
23 public class PcepRsvpIpv4ErrorSpec implements PcepRsvpErrorSpec { 26 public class PcepRsvpIpv4ErrorSpec implements PcepRsvpErrorSpec {
24 27
25 /* 28 /*
......
...@@ -5,6 +5,9 @@ import org.onosproject.pcepio.protocol.PcepVersion; ...@@ -5,6 +5,9 @@ import org.onosproject.pcepio.protocol.PcepVersion;
5 5
6 import com.google.common.base.MoreObjects; 6 import com.google.common.base.MoreObjects;
7 7
8 +/**
9 + * Provides Pcep Rsvp Ipv6 Error Spec.
10 + */
8 public class PcepRsvpIpv6ErrorSpec implements PcepRsvpErrorSpec { 11 public class PcepRsvpIpv6ErrorSpec implements PcepRsvpErrorSpec {
9 12
10 /* 13 /*
......
...@@ -24,6 +24,9 @@ import org.onosproject.pcepio.protocol.PcepVersion; ...@@ -24,6 +24,9 @@ import org.onosproject.pcepio.protocol.PcepVersion;
24 24
25 import com.google.common.base.MoreObjects; 25 import com.google.common.base.MoreObjects;
26 26
27 +/**
28 + * Provides Pcep Rsvp User Error Spec.
29 + */
27 public class PcepRsvpUserErrorSpec implements PcepRsvpErrorSpec { 30 public class PcepRsvpUserErrorSpec implements PcepRsvpErrorSpec {
28 31
29 /* 32 /*
......
...@@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory; ...@@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory;
26 26
27 import com.google.common.base.MoreObjects; 27 import com.google.common.base.MoreObjects;
28 28
29 -/* 29 +/**
30 * Provides SrEroSubObject. 30 * Provides SrEroSubObject.
31 */ 31 */
32 public class SrEroSubObject implements PcepValueType { 32 public class SrEroSubObject implements PcepValueType {
......
...@@ -150,6 +150,7 @@ public class StatefulRsvpErrorSpecTlv implements PcepValueType { ...@@ -150,6 +150,7 @@ public class StatefulRsvpErrorSpecTlv implements PcepValueType {
150 * 150 *
151 * @param cb of type channel buffer 151 * @param cb of type channel buffer
152 * @return object of StatefulRsvpErrorSpecTlv 152 * @return object of StatefulRsvpErrorSpecTlv
153 + * @throws PcepParseException while parsing this tlv from channel buffer
153 */ 154 */
154 public static PcepValueType read(ChannelBuffer cb) throws PcepParseException { 155 public static PcepValueType read(ChannelBuffer cb) throws PcepParseException {
155 156
......
...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory; ...@@ -28,6 +28,9 @@ import org.slf4j.LoggerFactory;
28 28
29 import com.google.common.base.MoreObjects; 29 import com.google.common.base.MoreObjects;
30 30
31 +/**
32 + * Provides TE Node Attributes Tlv.
33 + */
31 public class TENodeAttributesTlv implements PcepValueType { 34 public class TENodeAttributesTlv implements PcepValueType {
32 /* 35 /*
33 * Reference :PCEP Extension for Transporting TE Data draft-dhodylee-pce-pcep-te-data-extn-02 36 * Reference :PCEP Extension for Transporting TE Data draft-dhodylee-pce-pcep-te-data-extn-02
......
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 Tlvs and Pcep common objects.
19 + */
20 +package org.onosproject.pcepio.types;
...@@ -4,6 +4,9 @@ import org.jboss.netty.buffer.ChannelBuffer; ...@@ -4,6 +4,9 @@ import org.jboss.netty.buffer.ChannelBuffer;
4 import org.slf4j.Logger; 4 import org.slf4j.Logger;
5 import org.slf4j.LoggerFactory; 5 import org.slf4j.LoggerFactory;
6 6
7 +/**
8 + * Provides Hex Dump for debugging.
9 + */
7 public final class HexDump { 10 public final class HexDump {
8 protected static final Logger log = LoggerFactory.getLogger(HexDump.class); 11 protected static final Logger log = LoggerFactory.getLogger(HexDump.class);
9 12
......
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 + * Provides utility functionality for PCEP messages.
19 + */
20 +package org.onosproject.pcepio.util;
...@@ -185,8 +185,8 @@ public class PcepTunnelApiMapper { ...@@ -185,8 +185,8 @@ public class PcepTunnelApiMapper {
185 /** 185 /**
186 * Returns whether tunnel exist in tunnel db. 186 * Returns whether tunnel exist in tunnel db.
187 * 187 *
188 - * @param tunnelId 188 + * @param tunnelId tunnel id
189 - * @return true/false 189 + * @return true/false if the tunnel exists in the tunnel db
190 */ 190 */
191 public boolean checkFromTunnelDBQueue(TunnelId tunnelId) { 191 public boolean checkFromTunnelDBQueue(TunnelId tunnelId) {
192 int value = tunnelIdMap.get(tunnelId); 192 int value = tunnelIdMap.get(tunnelId);
......