Fix spotbugs issues in network topologies module
[transportpce.git] / networkmodel / src / main / java / org / opendaylight / transportpce / networkmodel / util / LinkIdUtil.java
1 /*
2  * Copyright © 2016 AT&T and others. 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.transportpce.networkmodel.util;
10
11 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils.rev170818.InitRoadmNodesInput;
12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
13
14
15 public final class LinkIdUtil {
16
17     private static final String NETWORK = "-NETWORK";
18     private static final String TRANSMIT = "-TX";
19     private static final String RECEIVE = "-RX";
20     private static final String BIDIRECTIONAL = "-TXRX";
21     private static final String LINK_ID_FORMAT = "%1$s-%2$sto%3$s-%4$s";
22
23     private LinkIdUtil() {
24         // utility class
25     }
26
27     /**
28      * Builds the Link id in format {@link LinkIdUtil#LINK_ID_FORMAT}.
29      *
30      * @param srcNode source node id string
31      * @param srcTp source termination point
32      * @param destNode destination node id
33      * @param destTp destination termination point
34      * @return {@link LinkId}
35      */
36     public static LinkId buildLinkId(String srcNode, String srcTp, String destNode, String destTp) {
37         return new LinkId(String.format(LINK_ID_FORMAT, srcNode, srcTp, destNode, destTp));
38     }
39
40     /**
41      * Builds the opposite {@link LinkId} from the {@link InitRoadmNodesInput}.
42      *
43      * @param input an init link for ROADM nodes
44      * @return opposite {@link LinkId}
45      */
46     public static LinkId getRdm2RdmOppositeLinkId(InitRoadmNodesInput input) {
47         String srcNode = new StringBuilder(input.getRdmANode()).append("-DEG").append(input.getDegANum()).toString();
48         String srcTp = input.getTerminationPointA();
49         String destNode = new StringBuilder(input.getRdmZNode()).append("-DEG").append(input.getDegZNum()).toString();
50         String destTp = input.getTerminationPointZ();
51
52         Object[] params = buildParams(srcNode, srcTp, destNode, destTp, false);
53
54         return new LinkId(String.format(LINK_ID_FORMAT, params));
55     }
56
57     /**
58      * Builds the opposite {@link LinkId} from string descriptors.
59      *
60      * @param srcNode a source node
61      * @param srcTp a source termination point
62      * @param destNode a destination node
63      * @param destTp a destination termination point
64      * @return LinkId a link identifier
65      */
66     public static LinkId getOppositeLinkId(String srcNode, String srcTp, String destNode, String destTp) {
67         return getOppositeLinkId(srcNode, srcTp, destNode, destTp, true);
68     }
69
70     /**
71      * Builds the opposite {@link LinkId} from string descriptors.
72      *
73      * @param srcNode a source node
74      * @param srcTp a source termination point
75      * @param destNode a destination node
76      * @param destTp a destination termination point
77      * @param checkNode boolean to check node
78      *
79      * @return LinkId a link identifier
80      */
81     public static LinkId getOppositeLinkId(String srcNode, String srcTp, String destNode, String destTp,
82         boolean checkNode) {
83         Object[] params = buildParams(srcNode, srcTp, destNode, destTp, checkNode);
84         return new LinkId(String.format(LINK_ID_FORMAT, params));
85     }
86
87     private static Object[] buildParams(String srcNode, String srcTp, String destNode, String destTp,
88             boolean checkForNetwork) {
89         Object[] params = null;
90         if (checkBidirectional(checkForNetwork, srcTp)) {
91             if (checkBidirectional(checkForNetwork, destTp)) {
92                 params = new Object[] {destNode, destTp, srcNode, srcTp};
93             } else if (destTp.contains(RECEIVE)) {
94                 params = new Object[] {destNode, destTp.replace("RX", "TX"), srcNode, srcTp};
95             } else {
96                 throw new IllegalArgumentException("Dest Termination Point is either RX/TX_RX ! Check TP");
97             }
98         } else if (srcTp.contains(TRANSMIT)) {
99             String replacedSrcTp = srcTp.replace("TX", "RX");
100             if (checkBidirectional(checkForNetwork, destTp)) {
101                 params = new Object[] {destNode, destTp, srcNode, replacedSrcTp};
102             } else if (destTp.contains(RECEIVE)) {
103                 params = new Object[] {destNode, destTp.replace("RX", "TX"), srcNode, replacedSrcTp};
104             } else {
105                 throw new IllegalArgumentException("Dest Termination Point is either RX/TX_RX ! Check TP");
106             }
107         } else {
108             throw new IllegalArgumentException("SRC Termination Point is either TX/TXRX ! Check TP");
109         }
110         return params;
111     }
112
113     private static boolean checkBidirectional(boolean check, String tp) {
114         return tp.contains(BIDIRECTIONAL) || (check && tp.contains(NETWORK));
115     }
116 }