org.scion.jpan

Class PathMetadata

java.lang.Object

org.scion.jpan.PathMetadata

public class PathMetadata
extends Object

PathMetadata contains the raw path and meta information such as bandwidth, latency or geo coordinates. PathMetadata is available from Paths that are created/returned by the ScionService when requesting a new path from the control service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathMetadata.EpicAuths
static class	PathMetadata.GeoCoordinates
static class	PathMetadata.Interface
static class	PathMetadata.LinkType
static class	PathMetadata.PathInterface

Method Summary

Modifier and Type	Method and Description
List<Long>	getBandwidthList()
PathMetadata.EpicAuths	getEpicAuths()
long	getExpiration()
InetSocketAddress	getFirstHopAddress()
List<PathMetadata.GeoCoordinates>	getGeoList()
PathMetadata.Interface	getInterface()
List<PathMetadata.PathInterface>	getInterfacesList()
List<Integer>	getInternalHopsList()
List<Integer>	getLatencyList()
List<PathMetadata.LinkType>	getLinkTypeList()
int	getMtu()
List<String>	getNotesList()
byte[]	getRawPath()

Methods inherited from class java.lang.Object

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

Method Detail

getFirstHopAddress

public InetSocketAddress getFirstHopAddress()
                                     throws UnknownHostException

Throws:

UnknownHostException

getRawPath

public byte[] getRawPath()

getInterface

public PathMetadata.Interface getInterface()

Returns:

Interface for exiting the local AS using this path.

Throws:

IllegalStateException - if this is path is only a raw path

getInterfacesList

public List<PathMetadata.PathInterface> getInterfacesList()

Returns:

The list of interfaces the path is composed of.

Throws:

IllegalStateException - if this is path is only a raw path

getMtu

public int getMtu()

Returns:

The maximum transmission unit (MTU) on the path.

Throws:

IllegalStateException - if this is path is only a raw path

getExpiration

public long getExpiration()

Returns:

The point in time when this path expires. In seconds since UNIX epoch.

Throws:

IllegalStateException - if this is path is only a raw path

getLatencyList

public List<Integer> getLatencyList()

Returns:

Latency lists the latencies between any two consecutive interfaces. Entry i describes the latency between interface i and i+1. Consequently, there are N-1 entries for N interfaces. A 0-value indicates that the AS did not announce a latency for this hop.

Throws:

IllegalStateException - if this is path is only a raw path

getBandwidthList

public List<Long> getBandwidthList()

Returns:

Bandwidth lists the bandwidth between any two consecutive interfaces, in Kbit/s. Entry i describes the bandwidth between interfaces i and i+1. A 0-value indicates that the AS did not announce a bandwidth for this hop.

Throws:

IllegalStateException - if this is path is only a raw path

getGeoList

public List<PathMetadata.GeoCoordinates> getGeoList()

Returns:

Geo lists the geographical position of the border routers along the path. Entry i describes the position of the router for interface i. A 0-value indicates that the AS did not announce a position for this router.

Throws:

IllegalStateException - if this is path is only a raw path

getLinkTypeList

public List<PathMetadata.LinkType> getLinkTypeList()

Returns:

LinkType contains the announced link type of inter-domain links. Entry i describes the link between interfaces 2*i and 2*i+1.

Throws:

IllegalStateException - if this is path is only a raw path

getInternalHopsList

public List<Integer> getInternalHopsList()

Returns:

InternalHops lists the number of AS internal hops for the ASes on path. Entry i describes the hop between interfaces 2*i+1 and 2*i+2 in the same AS. Consequently, there are no entries for the first and last ASes, as these are not traversed completely by the path.

Throws:

IllegalStateException - if this is path is only a raw path

getNotesList

public List<String> getNotesList()

Returns:

Notes contains the notes added by ASes on the path, in the order of occurrence. Entry i is the note of AS i on the path.

Throws:

IllegalStateException - if this is path is only a raw path

getEpicAuths

public PathMetadata.EpicAuths getEpicAuths()

Returns:

EpicAuths contains the EPIC authenticators used to calculate the PHVF and LHVF.

Throws:

IllegalStateException - if this is path is only a raw path