org.opendaylight.usc.manager.topology

Class UscTopologyFactory

java.lang.Object

org.opendaylight.usc.manager.topology.UscTopologyFactory

public class UscTopologyFactory
extends Object

the create factory of Channels and nodes of usc topology

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALL_HOME_DISPLAY_STRING the call home label string for UI

Constructor Summary

Constructors

Constructor and Description
UscTopologyFactory()

Method Summary

Modifier and Type	Method and Description
static Channel	createChannel(Node source, Node destination, String id, String type, boolean isCallHome) Builds a Channel for the provided source, destination, and id.
static Channel	createChannel(Node source, Node destination, String id, String type, boolean isCallHome, long bytesIn, long bytesOut, List<ChannelAlarm> alarms, List<Session> sessions) Builds a Channel for the provided source, destination, and id.
static ChannelAlarm	createChannelAlram(String id, String code, String message) Builds a Channel alarm Passes alarm attributes to AlarmBuilder to build a alarm.
static Node	createNode(String id, String type) Builds a node for the provided id.
static Session	createSession(String sessionId, String tpPort) Builds a node for the provided id.
static Session	createSession(String sessionId, String tpPort, long bytesIn, long bytesOut, List<SessionAlarm> alarms) Builds a node for the provided id.
static SessionAlarm	createSessionAlram(String id, String code, String message) Builds a session alarm Passes alarm attributes to AlarmBuilder to build a alarm.
static Topology	createTopology(String id, List<Node> nodes, List<Channel> Channels) Builds a topology for the provided id, nodes and Channels.
static String	getCallHomeString(boolean isCallHome) convert boolean to string of call home
static boolean	isCallHome(String callHome) convert String to boolean of call home

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALL_HOME_DISPLAY_STRING

public static final String CALL_HOME_DISPLAY_STRING

the call home label string for UI

See Also:

Constant Field Values

Constructor Detail

UscTopologyFactory

public UscTopologyFactory()

Method Detail

createChannel

public static Channel createChannel(Node source,
                                    Node destination,
                                    String id,
                                    String type,
                                    boolean isCallHome)

Builds a Channel for the provided source, destination, and id. Passes Channel attributes to ChannelBuilder to build a Channel.

Parameters:

source - the source node of Channel

destination - the destination node of Channel

id - the Channel id

type - the Channel type

isCallHome - if the Channel created by call home way

Returns:

new Channel

createChannel

public static Channel createChannel(Node source,
                                    Node destination,
                                    String id,
                                    String type,
                                    boolean isCallHome,
                                    long bytesIn,
                                    long bytesOut,
                                    List<ChannelAlarm> alarms,
                                    List<Session> sessions)

Builds a Channel for the provided source, destination, and id. Passes Channel attributes to ChannelBuilder to build a Channel.

Parameters:

source - the source node of Channel

destination - the destination node of Channel

id - the Channel id

type - the Channel type

isCallHome - if the Channel created by call home way

bytesIn - Channel bytes in number

bytesOut - Channel bytes out number

alarms - the error list of Channel

sessions - the session list of Channel

Returns:

new Channel

getCallHomeString

public static String getCallHomeString(boolean isCallHome)

convert boolean to string of call home

Parameters:

isCallHome - boolean value of call home

Returns:

the string value of call home

isCallHome

public static boolean isCallHome(String callHome)

convert String to boolean of call home

Parameters:

callHome - String value of call home

Returns:

the boolean value of call home

createNode

public static Node createNode(String id,
                              String type)

Builds a node for the provided id. Passes node attributes to NodeBuilder to build a node.

Parameters:

id - node id

type - node type

Returns:

new node

createTopology

public static Topology createTopology(String id,
                                      List<Node> nodes,
                                      List<Channel> Channels)

Builds a topology for the provided id, nodes and Channels. Passes topology attributes to TopologyBuilder to build a topology.

Parameters:

id - topology id

nodes - node list of topology

Channels - Channel list of topology

Returns:

new topology

createSession

public static Session createSession(String sessionId,
                                    String tpPort)

Builds a node for the provided id. Passes node attributes to NodeBuilder to build a node.

Parameters:

sessionId - session id

tpPort - the port of terminal point which related with the session

Returns:

new session

createSession

public static Session createSession(String sessionId,
                                    String tpPort,
                                    long bytesIn,
                                    long bytesOut,
                                    List<SessionAlarm> alarms)

Builds a node for the provided id. Passes node attributes to NodeBuilder to build a node.

Parameters:

sessionId - session id

tpPort - the port of terminal point which related with the session

bytesIn - bytes in number

bytesOut - bytes out number

alarms - error list

Returns:

new session

createSessionAlram

public static SessionAlarm createSessionAlram(String id,
                                              String code,
                                              String message)

Builds a session alarm Passes alarm attributes to AlarmBuilder to build a alarm.

Parameters:

id - error id

code - error code

message - error message

Returns:

new Channel error

createChannelAlram

public static ChannelAlarm createChannelAlram(String id,
                                              String code,
                                              String message)

Builds a Channel alarm Passes alarm attributes to AlarmBuilder to build a alarm.

Parameters:

id - error id

code - error code

message - error message

Returns:

new Channel error