Package convex.cli.peer

Class Session

java.lang.Object

convex.cli.peer.Session

public class Session
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected List<SessionItem>	items

Constructor Summary

Constructors

Constructor	Description
Session()

Method Summary

Modifier and Type	Method	Description
void	addPeer(AccountKey accountKey, String hostname, String etchFilename)	Add a peer to the list of peers kept in the session data.
SessionItem	getItemFromAccountKey(AccountKey accountKey)	Get a session item based on the peers AccountKey.
SessionItem	getItemFromIndex(int index)	Return a session item based on the peer index.
String[]	getPeerHostnameList()	Get a list of peer hostnames.
int	getSize()	Return the number of session items added to this session.
boolean	isPeer(AccountKey accountKey)	Return true of false if the peer name exists in the list of peers for this session
void	load(File filename)	Load a session data from file.
void	removePeer(AccountKey accountKey)	Remove a peer from the list of peers held by this session.
void	store(File filename)	Store the session list to a file.

Methods inherited from class java.lang.Object

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

Field Details

items

protected List<SessionItem> items

Constructor Details

Session

public Session()

Method Details

load

public void load(File filename)
          throws IOException

Load a session data from file.

Parameters:

filename - Filename of the session file to load.

Throws:

IOException - If IO fails

addPeer

public void addPeer(AccountKey accountKey,
 String hostname,
 String etchFilename)

Add a peer to the list of peers kept in the session data.

Parameters:

accountKey - Public key of Peer

hostname - Hostname of the peer. This includes the port number.

etchFilename - Filename that the peer is using to store the peer's state.

removePeer

public void removePeer(AccountKey accountKey)

Remove a peer from the list of peers held by this session.

Parameters:

accountKey - Address of the peer, this is the public key used by the peer.

store

public void store(File filename)
           throws IOException

Store the session list to a file.

Parameters:

filename - Filename to save the session too.

Throws:

IOException - if the file data cannot be writtern.

getSize

public int getSize()

Return the number of session items added to this session.

Returns:

number of items found for this session.

isPeer

public boolean isPeer(AccountKey accountKey)

Return true of false if the peer name exists in the list of peers for this session

Parameters:

accountKey - Public Key of the peer to check to see if it exists.

Returns:

true if the peer name exists, flase otherwise

getItemFromIndex

public SessionItem getItemFromIndex(int index)

Return a session item based on the peer index.

Parameters:

index - The index of the peer in the list, starting from 0.

Returns:

Session Item if the item is found at the index, if not then return null.

getItemFromAccountKey

public SessionItem getItemFromAccountKey(AccountKey accountKey)

Get a session item based on the peers AccountKey.

Parameters:

accountKey - AccountKey of the peer to get the session item for.

Returns:

SessionItem object or null if the peer account key cannot be found

getPeerHostnameList

public String[] getPeerHostnameList()

Get a list of peer hostnames.

Returns:

List hostname item for each stored peer.