Package i5.las2peer.tools

Class L2pNodeLauncher

java.lang.Object

i5.las2peer.tools.L2pNodeLauncher

public class L2pNodeLauncher
extends Object

las2peer node launcher It is the main tool for service developers / node maintainers to start their services, upload agents to the network and to test their service methods directly in the p2p network. The launcher both supports the start of a new network as well as starting a node that connects to an already existing network via a bootstrap. All methods to be executed can be stated via additional command line parameters to the main(java.lang.String[]) method.

Method Summary

Modifier and Type	Method	Description
Object[]	findAgent(String agentId)	Searches for the given agent in the las2peer network.
Object[]	findService(String serviceNameVersion)	Looks for the given service in the las2peer network.
String	getEnvelope(String id)	Get the envelope with the given id
NodeInformation	getLocalNodeInfo()	get the information stored about the local Node
List<ServiceNameVersion>	getLocalServices()	Gets a list of local running services on this node
String	getNetInfo()	get information about other nodes (probably neighbors in the ring etc)
PastryNodeImpl	getNode()
EthereumNode	getNodeAsEthereumNode()
ListMethodsContent	getServiceMethods(String serviceNameVersion)	Returns a list of available methods for the given service class name.
static String	getVersion()	Gets the las2peer version as String.
void	interactive()	start interactive console mode based on a CommandPrompt
Serializable	invoke(String serviceIdentifier, String serviceMethod, String parameters)	Invokes a service method as the current agent, choosing an approptiate service version.
boolean	isFinished()
static L2pNodeLauncher	launchConfiguration(L2pNodeLauncherConfiguration launcherConfiguration)
static L2pNodeLauncher	launchSingle(int port, String bootstrap, SharedStorage.STORAGE_MODE storageMode, boolean observer, String sLogDir, Iterable<String> serviceDirectories, Long nodeIdSeed, Iterable<String> commands)	Deprecated. Use launchConfiguration(L2pNodeLauncherConfiguration) instead.
static L2pNodeLauncher	launchSingle(Iterable<String> args)	Deprecated. Use launchConfiguration(L2pNodeLauncherConfiguration) instead.
AgentImpl	loadAgentFromXml(String filename)	load an agent from an XML file and return it for later usage
static void	main(String[] argv)	Main method for command line processing.
static void	printHelp()	Prints a help message for command line usage.
static void	printVersion()	Prints the las2peer version.
void	registerUserAgent(UserAgentImpl agent)	Register the given agent at the las2peer node and for later usage with invoke(java.lang.String, java.lang.String, java.lang.String).
void	registerUserAgent(UserAgentImpl agent, String passphrase)	Register the given agent at the las2peer node and for later usage with invoke(java.lang.String, java.lang.String, java.lang.String).
boolean	registerUserAgent(String idOrLogin, String passphrase)	Try to register the user of the given id at the node and for later usage in this launcher, i.e.
void	shutdown()	Closes the current node.
void	startConnector(String connectorClass)	Starts a connector given by its classname.
void	startNodeAdminConnector()	Deprecated. Use startWebConnector() instead.
void	startService(AgentImpl serviceAgent)	start the service defined by the given (Service-)Agent
void	startService(String serviceNameVersion)	Starts a service with a known agent or generate a new agent for the service (using a random passphrase) Will create an xml file for the generated agent and store the passphrase lcoally
void	startService(String serviceNameVersion, String defaultPass)	start a service with a known agent or generate a new agent for the service will create an xml file for the generated agent and store the passphrase lcoally
ServiceAgentImpl	startServiceXml(String file, String passphrase)	start a service defined by an XML file of the corresponding agent
void	startWebConnector()	Starts the WebConnector
void	stopConnector(String connectorClass)	Stops a connector given by its classname.
void	stopNodeAdminConnector()	Deprecated. Use stopWebConnector() instead.
void	stopService(String serviceNameVersion)	stop the given service needs name and version
void	stopWebConnector()	Stops the WebConnector
void	unlockAgent(PassphraseAgentImpl agent, String passphrase)	try to unlock the private key of the given agent with the given pass phrase
void	unregisterCurrentAgent()	Unregister the current user from the las2peer node and from this launcher.
void	uploadServicePackage(String serviceJarFile, String developerAgentXMLFile, String developerPassword)	Uploads the service jar file and its dependencies into the shared storage to be used for network class loading.
void	uploadServicePackage(String serviceJarFile, String developerAgentXMLFile, String developerPassword, String supplement)	Uploads the service jar file and its dependencies into the shared storage to be used for network class loading.
void	uploadStartupDirectory()	Upload the contents of the startup sub directory to the global storage of the las2peer network.
void	uploadStartupDirectory(String directory)	Uploads the contents of the given directory to the global storage of the las2peer network.

Methods inherited from class java.lang.Object

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

Method Details

isFinished

public boolean isFinished()

getNode

public PastryNodeImpl getNode()

getNodeAsEthereumNode

public EthereumNode getNodeAsEthereumNode()

getEnvelope

public String getEnvelope(String id)
                   throws NumberFormatException,
EnvelopeNotFoundException,
EnvelopeException,
SerializationException

Get the envelope with the given id

Parameters:

id -

Returns:

the XML-representation of an envelope as a String

Throws:

EnvelopeException

EnvelopeNotFoundException

NumberFormatException

SerializationException

findAgent

public Object[] findAgent(String agentId)
                   throws AgentNotRegisteredException

Searches for the given agent in the las2peer network.

Parameters:

agentId -

Returns:

node handles

Throws:

AgentNotRegisteredException

findService

public Object[] findService(String serviceNameVersion)
                     throws AgentException

Looks for the given service in the las2peer network. Needs an active user

Parameters:

serviceNameVersion - Exact name and version, same syantax as in startService(String)

Returns:

node handles

Throws:

AgentException

See Also:

• registerUserAgent(java.lang.String, java.lang.String)

shutdown

public void shutdown()

Closes the current node.

uploadStartupDirectory

public void uploadStartupDirectory(String directory)

Uploads the contents of the given directory to the global storage of the las2peer network. Each contained .xml-file is used as an artifact or - in case the name of the file starts with agent- - as an agent to upload. If agents are to be uploaded, make sure, that the startup directory contains a passphrases.txt file giving the passphrases for the agents.

Parameters:

directory -

uploadStartupDirectory

public void uploadStartupDirectory()

Upload the contents of the startup sub directory to the global storage of the las2peer network. Each contained .xml-file is used as an artifact or - in case the name of the file starts with agent- - as an agent to upload. If agents are to be uploaded, make sure, that the startup directory contains a passphrases.txt file giving the passphrases for the agents.

uploadServicePackage

public void uploadServicePackage(String serviceJarFile,
 String developerAgentXMLFile,
 String developerPassword)
                          throws ServicePackageException,
EnvelopeAlreadyExistsException

Uploads the service jar file and its dependencies into the shared storage to be used for network class loading.

Parameters:

serviceJarFile - The service jar file that should be uploaded.

developerAgentXMLFile - The XML file of the developers agent.

developerPassword - The password for the developer agent.

Throws:

ServicePackageException

EnvelopeAlreadyExistsException

uploadServicePackage

public void uploadServicePackage(String serviceJarFile,
 String developerAgentXMLFile,
 String developerPassword,
 String supplement)
                          throws ServicePackageException,
EnvelopeAlreadyExistsException

Uploads the service jar file and its dependencies into the shared storage to be used for network class loading.

Parameters:

serviceJarFile - The service jar file that should be uploaded.

developerAgentXMLFile - The XML file of the developers agent.

developerPassword - The password for the developer agent.

supplement - Additional service metadata string.

Throws:

ServicePackageException

EnvelopeAlreadyExistsException

startWebConnector

public void startWebConnector()

Starts the WebConnector

stopWebConnector

public void stopWebConnector()

Stops the WebConnector

startNodeAdminConnector

@Deprecated
public void startNodeAdminConnector()

Deprecated.

Use startWebConnector() instead.

stopNodeAdminConnector

@Deprecated
public void stopNodeAdminConnector()

Deprecated.

Use stopWebConnector() instead.

startConnector

public void startConnector(String connectorClass)

Starts a connector given by its classname.

Parameters:

connectorClass -

stopConnector

public void stopConnector(String connectorClass)

Stops a connector given by its classname.

Parameters:

connectorClass -

registerUserAgent

public boolean registerUserAgent(String idOrLogin,
 String passphrase)

Try to register the user of the given id at the node and for later usage in this launcher, i.e. for service method calls via invoke(java.lang.String, java.lang.String, java.lang.String).

Parameters:

idOrLogin - id or login of the agent to load

passphrase - passphrase to unlock the private key of the agent

Returns:

the registered agent

registerUserAgent

public void registerUserAgent(UserAgentImpl agent)
                       throws InternalSecurityException,
AgentAlreadyRegisteredException,
AgentException,
AgentAccessDeniedException

Register the given agent at the las2peer node and for later usage with invoke(java.lang.String, java.lang.String, java.lang.String). Make sure, that the private key of the agent is unlocked before registering

Parameters:

agent -

Throws:

InternalSecurityException

AgentAlreadyRegisteredException

AgentException

AgentAccessDeniedException

registerUserAgent

public void registerUserAgent(UserAgentImpl agent,
 String passphrase)
                       throws InternalSecurityException,
AgentException,
AgentAccessDeniedException

Register the given agent at the las2peer node and for later usage with invoke(java.lang.String, java.lang.String, java.lang.String). If the private key of the agent is not unlocked and a pass phrase has been given, an attempt to unlock the key is started before registering.

Parameters:

agent -

passphrase -

Throws:

InternalSecurityException

AgentAlreadyRegisteredException

AgentException

AgentAccessDeniedException

unregisterCurrentAgent

public void unregisterCurrentAgent()

Unregister the current user from the las2peer node and from this launcher.

See Also:

• registerUserAgent(java.lang.String, java.lang.String)

invoke

public Serializable invoke(String serviceIdentifier,
 String serviceMethod,
 String parameters)
                    throws AgentLockedException,
ServiceInvocationException

Invokes a service method as the current agent, choosing an approptiate service version. The arguments must be passed via ONE String separated by "-".

Parameters:

serviceIdentifier -

serviceMethod -

parameters - pass an empty string if you want to call a method without parameters

Returns:

Returns the invocation result

Throws:

ServiceInvocationException

AgentLockedException

See Also:

• registerUserAgent(java.lang.String, java.lang.String)

getServiceMethods

public ListMethodsContent getServiceMethods(String serviceNameVersion)
                                     throws InternalSecurityException,
AgentException,
InterruptedException,
EncodingFailedException,
SerializationException,
TimeoutException

Returns a list of available methods for the given service class name.

Parameters:

serviceNameVersion - Exact service name and version, same syntax as in startService(String)

Returns:

list of methods encapsulated in a ListMethodsContent

Throws:

InternalSecurityException

AgentException

InterruptedException

SerializationException

EncodingFailedException

TimeoutException

startService

public void startService(String serviceNameVersion)
                  throws Exception

Starts a service with a known agent or generate a new agent for the service (using a random passphrase) Will create an xml file for the generated agent and store the passphrase lcoally

Parameters:

serviceNameVersion - Specify the service name and version to run: package.serviceClass@Version. Exact match required.

Throws:

Exception - on error

startService

public void startService(String serviceNameVersion,
 String defaultPass)
                  throws Exception

start a service with a known agent or generate a new agent for the service will create an xml file for the generated agent and store the passphrase lcoally

Parameters:

serviceNameVersion - the exact name and version of the service to be started

defaultPass - this pass will be used to generate the agent if no agent exists

Throws:

Exception - on error

startServiceXml

public ServiceAgentImpl startServiceXml(String file,
 String passphrase)
                                 throws Exception

start a service defined by an XML file of the corresponding agent

Parameters:

file - path to the file containing the service

passphrase - passphrase to unlock the service agent

Returns:

the service agent

Throws:

Exception - on error

startService

public void startService(AgentImpl serviceAgent)
                  throws AgentAlreadyRegisteredException,
InternalSecurityException,
AgentException

start the service defined by the given (Service-)Agent

Parameters:

serviceAgent -

Throws:

AgentAlreadyRegisteredException

InternalSecurityException

AgentException

stopService

public void stopService(String serviceNameVersion)
                 throws AgentNotRegisteredException,
NodeException,
ServiceNotFoundException

stop the given service needs name and version

Parameters:

serviceNameVersion -

Throws:

AgentNotRegisteredException

NodeException

ServiceNotFoundException

loadAgentFromXml

public AgentImpl loadAgentFromXml(String filename)
                           throws AgentException

load an agent from an XML file and return it for later usage

Parameters:

filename - name of the file to load

Returns:

the loaded agent

Throws:

AgentException

unlockAgent

public void unlockAgent(PassphraseAgentImpl agent,
 String passphrase)
                 throws AgentAccessDeniedException,
AgentOperationFailedException

try to unlock the private key of the given agent with the given pass phrase

Parameters:

agent -

passphrase -

Throws:

AgentAccessDeniedException

AgentOperationFailedException - If the agent's private key can not be deserialized.

interactive

public void interactive()

start interactive console mode based on a CommandPrompt

getLocalNodeInfo

public NodeInformation getLocalNodeInfo()
                                 throws CryptoException

get the information stored about the local Node

Returns:

a node information

Throws:

CryptoException

getNetInfo

public String getNetInfo()

get information about other nodes (probably neighbors in the ring etc)

Returns:

string with node information

getLocalServices

public List<ServiceNameVersion> getLocalServices()

Gets a list of local running services on this node

Returns:

Returns a list of local running services

launchSingle

@Deprecated
public static L2pNodeLauncher launchSingle(Iterable<String> args)
                                    throws CryptoException,
NodeException

Deprecated.

Use launchConfiguration(L2pNodeLauncherConfiguration) instead. Launches a single node.

Parameters:

args -

Returns:

the L2pNodeLauncher instance

Throws:

CryptoException - If the system encryption self test fails. See log/output for details.

NodeException - If an issue with the launched node occurs.

IllegalArgumentException - If an issue occurs with a configuration argument.

launchSingle

@Deprecated
public static L2pNodeLauncher launchSingle(int port,
 String bootstrap,
 SharedStorage.STORAGE_MODE storageMode,
 boolean observer,
 String sLogDir,
 Iterable<String> serviceDirectories,
 Long nodeIdSeed,
 Iterable<String> commands)
                                    throws CryptoException,
NodeException

Deprecated.

Use launchConfiguration(L2pNodeLauncherConfiguration) instead. Launches a single node.

Parameters:

port -

bootstrap -

storageMode -

observer -

sLogDir -

serviceDirectories -

nodeIdSeed -

commands -

Returns:

Returns a L2pNodeLauncher instance

Throws:

CryptoException - If the system encryption self test fails. See log/output for details.

NodeException - If an issue with the launched node occurs.

IllegalArgumentException - If an issue occurs with a configuration argument.

launchConfiguration

public static L2pNodeLauncher launchConfiguration(L2pNodeLauncherConfiguration launcherConfiguration)
                                           throws CryptoException,
NodeException,
IllegalArgumentException

Parameters:

launcherConfiguration -

Returns:

Returns the launcher instance.

Throws:

CryptoException - If the system encryption self test fails. See log/output for details.

NodeException - If an issue with the launched node occurs.

IllegalArgumentException - If an issue occurs with a configuration argument.

printHelp

public static void printHelp()

Prints a help message for command line usage.

getVersion

public static String getVersion()

Gets the las2peer version as String.

Returns:

Returns the las2peer version as "major.minor.build" or "DEBUG" if not set.

printVersion

public static void printVersion()

Prints the las2peer version.

main

public static void main(String[] argv)

Main method for command line processing. The method will start a node and try to invoke all command line parameters as parameterless methods of this class.

Parameters:

argv -