Enforce checkstyle and findbug under PCE Api
[bgpcep.git] / pcep / api / src / main / java / org / opendaylight / protocol / pcep / PCEPSessionNegotiatorFactoryDependencies.java
1 /*
2  * Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.protocol.pcep;
10
11 import javax.annotation.Nonnull;
12 import javax.annotation.Nullable;
13
14 /**
15  * Contains required dependencies for create SessionNegotiator.
16  */
17 public interface PCEPSessionNegotiatorFactoryDependencies {
18     /**
19      * ListenerFactory to create listeners for clients.
20      *
21      * @return ListenerFactory
22      */
23     @Nonnull
24     PCEPSessionListenerFactory getListenerFactory();
25
26     /**
27      * PeerProposal information used in our Open message.
28      *
29      * @return peerProposal null by default since its not mandatory. Otherwise method should be override it.
30      */
31     @Nullable
32     default PCEPPeerProposal getPeerProposal() {
33         return null;
34     }
35 }