aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/pcep/pcepio/src/main/java/org/onosproject/pcepio/protocol/PcepUpdateRequest.java
blob: 8d1c89e24430e833d8507f1dfdfb6bc1571ff68f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.pcepio.protocol;

import org.onosproject.pcepio.exceptions.PcepParseException;

/**
 * Abstraction of an entity providing PCEP Update Request List.
 */
public interface PcepUpdateRequest {

    /**
     * Returns object of PCEP SRP Object.
     *
     * @return srpObject of type PCEP SRP Object
     */
    PcepSrpObject getSrpObject();

    /**
     * Returns object of PCEP LSP Object.
     *
     * @return lspObject of type PCEP LSP Object
     */
    PcepLspObject getLspObject();

    /**
     * Returns object of PCEP MSG PATH.
     *
     * @return msgPath of type PCEP MSG PATH
     */
    PcepMsgPath getMsgPath();

    /**
     * Sets the PCEP SRP Object.
     *
     * @param srpObject object of type PCEP SRP Object
     */
    void setSrpObject(PcepSrpObject srpObject);

    /**
     * Sets the PCEP LSP Object.
     *
     * @param lspObject object of type PCEP LSP Object
     */
    void setLspObject(PcepLspObject lspObject);

    /**
     * sets the PCEP MSG PATH.
     *
     * @param msgPath object of type PCEP MSG PATH
     */
    void setMsgPath(PcepMsgPath msgPath);

    /**
     * Builder interface with get and set functions to build PcepUpdateRequest.
     */
    interface Builder {

        /**
         * Builds PcepUpdateRequest.
         *
         * @return PcepUpdateRequest
         * @throws PcepParseException if mandatory object is not set
         */
        PcepUpdateRequest build() throws PcepParseException;

        /**
         * Returns PcepSrpObject.
         *
         * @return srpObject
         */
        PcepSrpObject getSrpObject();

        /**
         * Returns PcepLspObject.
         *
         * @return lspObject
         */
        PcepLspObject getLspObject();

        /**
         * Returns PcepMsgPath.
         *
         * @return msgPath
         */
        PcepMsgPath getMsgPath();

        /**
         * Sets the SRP Object.
         *
         * @param srpObj of type PcepSrpObject
         * @return builder by setting PcepSrpObject
         */
        Builder setSrpObject(PcepSrpObject srpObj);

        /**
         * Sets the LSP Object.
         *
         * @param lspObject of type PcepLspObject
         * @return builder by setting PcepLspObject
         */
        Builder setLspObject(PcepLspObject lspObject);

        /**
         * Sets the Path Object.
         *
         * @param msgPath of type PcepMsgPath
         * @return builder by setting PcepMsgPath
         */
        Builder setMsgPath(PcepMsgPath msgPath);
    }
}