Package org.onosproject.net.behaviour.protection

Class ProtectedTransportEndpointDescription

java.lang.Object

org.onosproject.net.behaviour.protection.ProtectedTransportEndpointDescription

@Beta
@Immutable
public class ProtectedTransportEndpointDescription
extends java.lang.Object

Configuration for a protected transport entity endpoint.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProtectedTransportEndpointDescription(java.util.List<TransportEndpointDescription> paths, DeviceId peer, java.lang.String fingerprint)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ProtectedTransportEndpointDescription	buildDescription(java.util.List<TransportEndpointDescription> paths, DeviceId peer, java.lang.String fingerprint)	Creates a ProtectedTransportEndpointDescription.
java.lang.String	fingerprint()	Returns fingerprint to identify this protected transport entity.
static ProtectedTransportEndpointDescription	of(java.util.List<TransportEndpointDescription> paths, DeviceId peer, java.lang.String fingerprint)	Creates a ProtectedTransportEndpointDescription.
java.util.List<TransportEndpointDescription>	paths()	Returns List of underlying transport entity endpoints in priority order.
DeviceId	peer()	Returns DeviceId of remote peer of this endpoint.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtectedTransportEndpointDescription

protected ProtectedTransportEndpointDescription(java.util.List<TransportEndpointDescription> paths,
                                                DeviceId peer,
                                                java.lang.String fingerprint)

Constructor.

Parameters:

paths - TransportEndpointDescriptions

peer - remote peer of this endpoint

fingerprint - to identify this protected transport entity.

Method Detail

paths

public java.util.List<TransportEndpointDescription> paths()

Returns List of underlying transport entity endpoints in priority order.

Returns:

the transport entity endpoint descriptions

peer

public DeviceId peer()

Returns DeviceId of remote peer of this endpoint.

Returns:

the peer

fingerprint

public java.lang.String fingerprint()

Returns fingerprint to identify this protected transport entity.

Returns:

the fingerprint

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

buildDescription

public static final ProtectedTransportEndpointDescription buildDescription(java.util.List<TransportEndpointDescription> paths,
                                                                           DeviceId peer,
                                                                           java.lang.String fingerprint)

Creates a ProtectedTransportEndpointDescription.

Parameters:

paths - TransportEndpointDescriptions forming protection

peer - DeviceId of remote peer of this endpoint.

fingerprint - opaque fingerprint object. must be serializable.

Returns:

TransportEndpointDescription

of

public static final ProtectedTransportEndpointDescription of(java.util.List<TransportEndpointDescription> paths,
                                                             DeviceId peer,
                                                             java.lang.String fingerprint)

Creates a ProtectedTransportEndpointDescription.

Parameters:

paths - TransportEndpointDescriptions forming protection

peer - DeviceId of remote peer of this endpoint.

fingerprint - opaque fingerprint object. must be serializable.

Returns:

TransportEndpointDescription