Add bundle activator and use it
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / BGPSessionImpl.java
index 9892942748abd6b9a06b01c83912e6f21b217b73..4824a52c09fa4d970bf51729d30abc18911c0b4a 100644 (file)
@@ -19,34 +19,62 @@ import java.util.concurrent.TimeUnit;
 
 import javax.annotation.concurrent.GuardedBy;
 
-import org.opendaylight.protocol.bgp.concepts.BGPTableType;
 import org.opendaylight.protocol.bgp.parser.BGPError;
-import org.opendaylight.protocol.bgp.parser.BGPMessage;
-import org.opendaylight.protocol.bgp.parser.BGPParameter;
 import org.opendaylight.protocol.bgp.parser.BGPSession;
 import org.opendaylight.protocol.bgp.parser.BGPSessionListener;
 import org.opendaylight.protocol.bgp.parser.BGPTerminationReason;
-import org.opendaylight.protocol.bgp.parser.message.BGPKeepAliveMessage;
-import org.opendaylight.protocol.bgp.parser.message.BGPNotificationMessage;
-import org.opendaylight.protocol.bgp.parser.message.BGPOpenMessage;
-import org.opendaylight.protocol.bgp.parser.parameter.MultiprotocolCapability;
+import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
 import org.opendaylight.protocol.framework.AbstractProtocolSession;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.Keepalive;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.KeepaliveBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.Notify;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.NotifyBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.Open;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.open.BgpParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.open.bgp.parameters.CParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130918.BgpTableType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130918.open.bgp.parameters.c.parameters.CMultiprotocol;
+import org.opendaylight.yangtools.yang.binding.Notification;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Objects;
 import com.google.common.base.Objects.ToStringHelper;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Sets;
 
-class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPSession {
+@VisibleForTesting
+public class BGPSessionImpl extends AbstractProtocolSession<Notification> implements BGPSession {
 
        private static final Logger logger = LoggerFactory.getLogger(BGPSessionImpl.class);
 
        private static final int DEFAULT_HOLD_TIMER_VALUE = 15;
 
+       private static final Notification keepalive = new KeepaliveBuilder().build();
+
        public static int HOLD_TIMER_VALUE = DEFAULT_HOLD_TIMER_VALUE; // 240
 
+       /**
+        * Internal session state.
+        */
+       public enum State {
+               /**
+                * The session object is created by the negotiator in OpenConfirm state. While in this state, the session object
+                * is half-alive, e.g. the timers are running, but the session is not completely up, e.g. it has not been
+                * announced to the listener. If the session is torn down in this state, we do not inform the listener.
+                */
+               OpenConfirm,
+               /**
+                * The session has been completely established.
+                */
+               Up,
+               /**
+                * The session has been closed. It will not be resurrected.
+                */
+               Idle,
+       }
+
        /**
         * System.nanoTime value about when was sent the last message Protected to be updated also in tests.
         */
@@ -71,23 +99,25 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
        private final Channel channel;
 
        @GuardedBy("this")
-       private boolean closed = false;
+       private State state = State.OpenConfirm;
 
-       private final short keepAlive;
+       private final int keepAlive;
 
-       private final Set<BGPTableType> tableTypes;
+       private final Set<BgpTableType> tableTypes;
 
-       BGPSessionImpl(final Timer timer, final BGPSessionListener listener, final Channel channel, final short keepAlive, final BGPOpenMessage remoteOpen) {
+       BGPSessionImpl(final Timer timer, final BGPSessionListener listener, final Channel channel, final Open remoteOpen) {
                this.listener = Preconditions.checkNotNull(listener);
                this.stateTimer = Preconditions.checkNotNull(timer);
                this.channel = Preconditions.checkNotNull(channel);
-               this.keepAlive = keepAlive;
-
-               final Set<BGPTableType> tts = Sets.newHashSet();
-               if (remoteOpen.getOptParams() != null) {
-                       for (final BGPParameter param : remoteOpen.getOptParams()) {
-                               if (param instanceof MultiprotocolCapability) {
-                                       tts.add(((MultiprotocolCapability) param).getTableType());
+               this.keepAlive = remoteOpen.getHoldTimer() / 3;
+
+               final Set<BgpTableType> tts = Sets.newHashSet();
+               if (remoteOpen.getBgpParameters() != null) {
+                       for (final BgpParameters param : remoteOpen.getBgpParameters()) {
+                               if (param instanceof CParameters) {
+                                       final CParameters cp = (CParameters) param;
+                                       final BgpTableType tt = new BgpTableTypeImpl(((CMultiprotocol) cp).getMultiprotocolCapability().getAfi(), ((CMultiprotocol) cp).getMultiprotocolCapability().getSafi());
+                                       tts.add(tt);
                                }
                        }
                }
@@ -95,31 +125,31 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
                this.sync = new BGPSynchronization(this, this.listener, tts);
                this.tableTypes = tts;
 
-               if (remoteOpen.getHoldTime() != 0) {
+               if (remoteOpen.getHoldTimer() != 0) {
                        this.stateTimer.newTimeout(new TimerTask() {
 
                                @Override
                                public void run(final Timeout timeout) throws Exception {
                                        handleHoldTimer();
                                }
-                       }, remoteOpen.getHoldTime(), TimeUnit.SECONDS);
+                       }, remoteOpen.getHoldTimer(), TimeUnit.SECONDS);
 
                        this.stateTimer.newTimeout(new TimerTask() {
                                @Override
                                public void run(final Timeout timeout) throws Exception {
                                        handleKeepaliveTimer();
                                }
-                       }, keepAlive, TimeUnit.SECONDS);
+                       }, this.keepAlive, TimeUnit.SECONDS);
                }
        }
 
        @Override
        public synchronized void close() {
                logger.debug("Closing session: {}", this);
-               if (!closed) {
-                       this.sendMessage(new BGPNotificationMessage(BGPError.CEASE));
-                       channel.close();
-                       closed = true;
+               if (this.state != State.Idle) {
+                       this.sendMessage(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode()).build());
+                       this.channel.close();
+                       this.state = State.Idle;
                }
        }
 
@@ -129,19 +159,21 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
         * @param msg incoming message
         */
        @Override
-       public void handleMessage(final BGPMessage msg) {
+       public void handleMessage(final Notification msg) {
                // Update last reception time
                this.lastMessageReceivedAt = System.nanoTime();
 
-               if (msg instanceof BGPOpenMessage) {
+               if (msg instanceof Open) {
                        // Open messages should not be present here
                        this.terminate(BGPError.FSM_ERROR);
-               } else if (msg instanceof BGPNotificationMessage) {
+               } else if (msg instanceof Notify) {
                        // Notifications are handled internally
-                       logger.info("Session closed because Notification message received: {}", ((BGPNotificationMessage) msg).getError());
+                       logger.info("Session closed because Notification message received: {} / {}", ((Notify) msg).getErrorCode(),
+                                       ((Notify) msg).getErrorSubcode());
                        this.closeWithoutMessage();
-                       this.listener.onSessionTerminated(this, new BGPTerminationReason(((BGPNotificationMessage) msg).getError()));
-               } else if (msg instanceof BGPKeepAliveMessage) {
+                       this.listener.onSessionTerminated(this,
+                                       new BGPTerminationReason(BGPError.forValue(((Notify) msg).getErrorCode(), ((Notify) msg).getErrorSubcode())));
+               } else if (msg instanceof Keepalive) {
                        // Keepalives are handled internally
                        logger.debug("Received KeepAlive messsage.");
                        this.kaCounter++;
@@ -156,12 +188,12 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
 
        @Override
        public synchronized void endOfInput() {
-               if (!closed) {
+               if (this.state == State.Up) {
                        this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
                }
        }
 
-       void sendMessage(final BGPMessage msg) {
+       void sendMessage(final Notification msg) {
                try {
                        this.channel.writeAndFlush(msg);
                        this.lastMessageSentAt = System.nanoTime();
@@ -173,8 +205,8 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
 
        private synchronized void closeWithoutMessage() {
                logger.debug("Closing session: {}", this);
-               channel.close();
-               closed = true;
+               this.channel.close();
+               this.state = State.Idle;
        }
 
        /**
@@ -184,8 +216,9 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
         * @param closeObject
         */
        private void terminate(final BGPError error) {
-               this.sendMessage(new BGPNotificationMessage(error));
+               this.sendMessage(new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode()).build());
                this.closeWithoutMessage();
+
                this.listener.onSessionTerminated(this, new BGPTerminationReason(error));
        }
 
@@ -196,22 +229,23 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
         * state will become IDLE), then rescheduling won't occur.
         */
        private synchronized void handleHoldTimer() {
-               final long ct = System.nanoTime();
+               if (this.state == State.Idle) {
+                       return;
+               }
 
+               final long ct = System.nanoTime();
                final long nextHold = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(HOLD_TIMER_VALUE);
 
-               if (!closed) {
-                       if (ct >= nextHold) {
-                               logger.debug("HoldTimer expired. " + new Date());
-                               this.terminate(BGPError.HOLD_TIMER_EXPIRED);
-                       } else {
-                               this.stateTimer.newTimeout(new TimerTask() {
-                                       @Override
-                                       public void run(final Timeout timeout) throws Exception {
-                                               handleHoldTimer();
-                                       }
-                               }, nextHold - ct, TimeUnit.NANOSECONDS);
-                       }
+               if (ct >= nextHold) {
+                       logger.debug("HoldTimer expired. " + new Date());
+                       this.terminate(BGPError.HOLD_TIMER_EXPIRED);
+               } else {
+                       this.stateTimer.newTimeout(new TimerTask() {
+                               @Override
+                               public void run(final Timeout timeout) throws Exception {
+                                       handleHoldTimer();
+                               }
+                       }, nextHold - ct, TimeUnit.NANOSECONDS);
                }
        }
 
@@ -222,22 +256,23 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
         * starts to execute (the session state will become IDLE), that rescheduling won't occur.
         */
        private synchronized void handleKeepaliveTimer() {
-               final long ct = System.nanoTime();
+               if (this.state == State.Idle) {
+                       return;
+               }
 
+               final long ct = System.nanoTime();
                long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
 
-               if (!closed) {
-                       if (ct >= nextKeepalive) {
-                               this.sendMessage(new BGPKeepAliveMessage());
-                               nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
-                       }
-                       this.stateTimer.newTimeout(new TimerTask() {
-                               @Override
-                               public void run(final Timeout timeout) throws Exception {
-                                       handleKeepaliveTimer();
-                               }
-                       }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
+               if (ct >= nextKeepalive) {
+                       this.sendMessage(keepalive);
+                       nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
                }
+               this.stateTimer.newTimeout(new TimerTask() {
+                       @Override
+                       public void run(final Timeout timeout) throws Exception {
+                               handleKeepaliveTimer();
+                       }
+               }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
        }
 
        @Override
@@ -246,18 +281,23 @@ class BGPSessionImpl extends AbstractProtocolSession<BGPMessage> implements BGPS
        }
 
        protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
-               toStringHelper.add("channel", channel);
-               toStringHelper.add("closed", closed);
+               toStringHelper.add("channel", this.channel);
+               toStringHelper.add("state", this.state);
                return toStringHelper;
        }
 
        @Override
-       public Set<BGPTableType> getAdvertisedTableTypes() {
+       public Set<BgpTableType> getAdvertisedTableTypes() {
                return this.tableTypes;
        }
 
        @Override
-       protected void sessionUp() {
-               listener.onSessionUp(this);
+       protected synchronized void sessionUp() {
+               this.state = State.Up;
+               this.listener.onSessionUp(this);
+       }
+
+       public synchronized State getState() {
+               return this.state;
        }
 }