org.scion.jpan

Class ScionService

java.lang.Object

org.scion.jpan.ScionService

Direct Known Subclasses:

Scion.CloseableService

public class ScionService
extends Object

The ScionService provides information such as:
- Paths from A to B - The local ISD/AS numbers
- Lookup op ISD/AS for host names via DNS.

The ScionService is intended as singleton. There should usually be only one instance that is shared by all users. However, it may sometimes be desirable to have multiple instances, e.g. for connecting to a different daemon or for better concurrency.

The default instance is of type ScionService. All other ScionService are of type Scion.CloseableService which extends AutoCloseable.

See Also:

Scion.CloseableService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScionService.Mode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScionService(String addressOrHost, ScionService.Mode mode)

Method Summary

Modifier and Type	Method and Description
void	close()
static void	closeDefault()
long	getIsdAs(String hostName)
long	getLocalIsdAs()
List<Path>	getPaths(long dstIsdAs, InetAddress dstAddress, int dstPort) Request paths from the local ISD/AS to the destination.
List<Path>	getPaths(long dstIsdAs, InetSocketAddress dstScionAddress) Request paths from the local ISD/AS to the destination.
List<Path>	getPaths(Path path) Request paths to the same destination as the provided path.
Path	lookupAndGetPath(InetSocketAddress dstAddr, PathPolicy policy) Resolves the address to a SCION address, request paths, and selects a path using the policy.
Path	lookupAndGetPath(String hostName, int port, PathPolicy policy) Resolves the address to a SCION address, request paths, and selects a path using the policy.
ScionDatagramChannel	openChannel()
ScionDatagramChannel	openChannel(DatagramChannel channel)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScionService

protected ScionService(String addressOrHost,
                       ScionService.Mode mode)

Method Detail

closeDefault

public static void closeDefault()

close

public void close()
           throws IOException

Throws:

IOException

openChannel

public ScionDatagramChannel openChannel()
                                 throws IOException

Throws:

IOException

openChannel

public ScionDatagramChannel openChannel(DatagramChannel channel)
                                 throws IOException

Throws:

IOException

getPaths

public List<Path> getPaths(long dstIsdAs,
                           InetSocketAddress dstScionAddress)

Request paths from the local ISD/AS to the destination.

Parameters:

dstIsdAs - Destination ISD/AS

dstScionAddress - Destination IP address. Must belong to a SCION enabled end host.

Returns:

All paths returned by the path service.

getPaths

public List<Path> getPaths(Path path)

Request paths to the same destination as the provided path.

Parameters:

path - A path

Returns:

All paths returned by the path service.

getPaths

public List<Path> getPaths(long dstIsdAs,
                           InetAddress dstAddress,
                           int dstPort)

Request paths from the local ISD/AS to the destination.

Parameters:

dstIsdAs - Destination ISD/AS

dstAddress - A SCION-enabled Destination IP address

dstPort - Destination port

Returns:

All paths returned by the path service. Returns an empty list if no paths are found.

lookupAndGetPath

public Path lookupAndGetPath(String hostName,
                             int port,
                             PathPolicy policy)
                      throws ScionException

Resolves the address to a SCION address, request paths, and selects a path using the policy.

Parameters:

hostName - Destination host name

port - Destination port

policy - Path policy. 'null' means PathPolicy.DEFAULT.

Returns:

All paths returned by the path service.

Throws:

ScionException - if the DNS/TXT lookup did not return a (valid) SCION address.

lookupAndGetPath

public Path lookupAndGetPath(InetSocketAddress dstAddr,
                             PathPolicy policy)
                      throws ScionException

Resolves the address to a SCION address, request paths, and selects a path using the policy.

Parameters:

dstAddr - Destination address

policy - Path policy. 'null' means PathPolicy.DEFAULT.

Returns:

All paths returned by the path service.

Throws:

ScionException - if the DNS/TXT lookup did not return a (valid) SCION address.

getLocalIsdAs

public long getLocalIsdAs()

getIsdAs

public long getIsdAs(String hostName)
              throws ScionException

Parameters:

hostName - hostName of the host to resolve

Returns:

The ISD/AS code for a hostname

Throws:

ScionException - if the DNS/TXT lookup did not return a (valid) SCION address.