aQute.remote.agent

Class AgentServer

java.lang.Object

aQute.remote.agent.AgentServer

All Implemented Interfaces:

Agent, java.io.Closeable, java.lang.AutoCloseable, java.util.EventListener, org.osgi.framework.FrameworkListener

public class AgentServer
extends java.lang.Object
implements Agent, java.io.Closeable, org.osgi.framework.FrameworkListener

Implementation of the Agent. This implementation implements the Agent interfaces and communicates with a Supervisor interfaces.

Field Summary

Fields inherited from interface aQute.remote.api.Agent

AGENT_SERVER_PORT_KEY, COMMAND_SESSION, CONSOLE, DEFAULT_PORT, NONE, PORT_P

Constructor Summary

Constructors

Constructor and Description
AgentServer(java.lang.String name, org.osgi.framework.BundleContext context, java.io.File cache) An agent server is based on a context and takes a name and cache directory
AgentServer(java.lang.String name, org.osgi.framework.BundleContext context, java.io.File cache, StartLevelRuntimeHandler startlevels)

Method Summary

Modifier and Type	Method and Description
void	abort() Abort the remote agent.
void	close()
boolean	createFramework(java.lang.String name, java.util.Collection<java.lang.String> runpath, java.util.Map<java.lang.String,java.lang.Object> properties) This method is only implemented in the Envoy (the pre-Agent).
void	frameworkEvent(org.osgi.framework.FrameworkEvent event)
java.util.List<org.osgi.framework.wiring.dto.BundleRevisionDTO>	getBundleRevisons(long... bundleId) Return the bundle revisions
java.util.List<BundleDTO>	getBundles(long... bundleId) Get the Bundles for the given ids.
org.osgi.framework.BundleContext	getContext()
FrameworkDTO	getFramework() Get the framework's DTO
Supervisor	getSupervisor()
java.util.Map<java.lang.String,java.lang.String>	getSystemProperties() Get the remote's system's System properties
BundleDTO	install(java.lang.String location, java.lang.String sha) Install a new bundle at the given bundle location.
BundleDTO	installFromURL(java.lang.String location, java.lang.String url) Install a new bundle at the given location using a url to get the stream.
BundleDTO	installWithData(java.lang.String location, byte[] data) Install or update a bundle from the specified byte array instance.
boolean	isEnvoy() An Envoy is an agent that can install a framework (well, -runpath) and launch it with an Agent.
boolean	ping() Ping the remote agent to see if it is still alive.
boolean	redirect(int port) Redirect I/O from port.
void	refresh(boolean async)
void	setLink(Link<Agent,Supervisor> link)
void	setRemote(Supervisor supervisor)
void	setSupervisor(Supervisor remote)
java.lang.String	shell(java.lang.String cmd) Execute a remote command on Gogo (if present) and return the result.
java.lang.String	start(long... ids) Start a number of bundles
boolean	stdin(java.lang.String s) Send a text to the potentially redirected stdin stream so that remotely executing code will read it from an InputStream.
java.lang.String	stop(long... ids) Stop a number of bundles
java.lang.String	uninstall(long... ids) Uninstall a number of bundles
java.lang.String	update(long id, java.lang.String sha) Updates a single bundle by id in the framework.
java.lang.String	update(java.util.Map<java.lang.String,java.lang.String> bundles) Update the bundles in the framework.
java.lang.String	updateFromURL(long id, java.lang.String url) Updates a single bundle from a url

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentServer

public AgentServer(java.lang.String name,
                   org.osgi.framework.BundleContext context,
                   java.io.File cache)

An agent server is based on a context and takes a name and cache directory

Parameters:

name - the name of the agent's framework

context - a bundle context of the framework

cache - the directory for caching

AgentServer

public AgentServer(java.lang.String name,
                   org.osgi.framework.BundleContext context,
                   java.io.File cache,
                   StartLevelRuntimeHandler startlevels)

Method Detail

getFramework

public FrameworkDTO getFramework()
                          throws java.lang.Exception

Get the framework's DTO

Specified by:

getFramework in interface Agent

Throws:

java.lang.Exception

installWithData

public BundleDTO installWithData(java.lang.String location,
                                 byte[] data)
                          throws java.lang.Exception

Description copied from interface: Agent

Install or update a bundle from the specified byte array instance.

This method does check if there is any existing bundle with the specified location identifier. If found, the existing bundle gets updated with the specified byte array instance. Otherwise, a new bundle gets installed with the specified byte array instance.

Specified by:

installWithData in interface Agent

Parameters:

location - The bundle location (cannot be null)

data - The byte array instance from which this bundle will be read (cannot be null)

Returns:

A Bundle DTO (cannot be null)

Throws:

java.lang.Exception - if the bundle cannot be installed or updated

install

public BundleDTO install(java.lang.String location,
                         java.lang.String sha)
                  throws java.lang.Exception

Description copied from interface: Agent

Install a new bundle at the given bundle location. The SHA identifies the file and should be retrievable through Supervisor.getFile(String) .

Specified by:

install in interface Agent

Parameters:

location - the bundle location

sha - the sha of the bundle's JAR

Returns:

A Bundle DTO

Throws:

java.lang.Exception

installFromURL

public BundleDTO installFromURL(java.lang.String location,
                                java.lang.String url)
                         throws java.lang.Exception

Description copied from interface: Agent

Install a new bundle at the given location using a url to get the stream.

NOTICE: this method makes assumptions about the target e.g. that it will be able to use out-of-band communication to read from the URL and have the necessary url handlers to open the URL stream.

Specified by:

installFromURL in interface Agent

Parameters:

location - the bundle location

url - url of the bundle that can retrived using url.openStream()

Returns:

A bundle DTO

Throws:

java.lang.Exception

start

public java.lang.String start(long... ids)

Description copied from interface: Agent

Start a number of bundles

Specified by:

start in interface Agent

Parameters:

ids - the bundle ids

Returns:

any errors that occurred

stop

public java.lang.String stop(long... ids)

Description copied from interface: Agent

Stop a number of bundles

Specified by:

stop in interface Agent

Parameters:

ids - the bundle ids

Returns:

any errors that occurred

uninstall

public java.lang.String uninstall(long... ids)

Description copied from interface: Agent

Uninstall a number of bundles

Specified by:

uninstall in interface Agent

Parameters:

ids - the bundle ids

Returns:

any errors that occurred

update

public java.lang.String update(java.util.Map<java.lang.String,java.lang.String> bundles)
                        throws java.lang.InterruptedException

Description copied from interface: Agent

Update the bundles in the framework. Each agent compares this map against a map of installed bundles. The map maps a bundle location to SHA. Any differences are reflected in the installed bundles. That is, a change in the SHA will update, a new entry will install, and a removed entry will uninstall. This is the preferred way to keep the remote framework synchronized since it is idempotent.

Specified by:

update in interface Agent

Parameters:

bundles - the bundles to update

Throws:

java.lang.InterruptedException

update

public java.lang.String update(long id,
                               java.lang.String sha)
                        throws java.lang.Exception

Description copied from interface: Agent

Updates a single bundle by id in the framework. The SHA identifies the file and should be retrievable through Supervisor.getFile(String)

Specified by:

update in interface Agent

Parameters:

id - the bundle id

sha - the sha of the bundle

Returns:

any errors that occurred

Throws:

java.lang.Exception

updateFromURL

public java.lang.String updateFromURL(long id,
                                      java.lang.String url)
                               throws java.lang.Exception

Description copied from interface: Agent

Updates a single bundle from a url

NOTICE: this method makes assumptions about the target e.g. that it will be able to use out-of-band communication to read from the URL and have the necessary url handlers to open the URL stream.

Specified by:

updateFromURL in interface Agent

Parameters:

id - bundle to update

url - location of bundle contents

Returns:

any errors that occurred

Throws:

java.lang.Exception

redirect

public boolean redirect(int port)
                 throws java.lang.Exception

Description copied from interface: Agent

Redirect I/O from port. Port can be Agent.CONSOLE, Agent.COMMAND_SESSION, Agent.NONE, or a TCP Telnet port.

Specified by:

redirect in interface Agent

Parameters:

port - the port to redirect from

Returns:

if the redirection was changed

Throws:

java.lang.Exception

stdin

public boolean stdin(java.lang.String s)
              throws java.lang.Exception

Description copied from interface: Agent

Send a text to the potentially redirected stdin stream so that remotely executing code will read it from an InputStream.

Specified by:

stdin in interface Agent

Parameters:

s - text that should be read as input

Returns:

true if this was redirected

Throws:

java.lang.Exception

shell

public java.lang.String shell(java.lang.String cmd)
                       throws java.lang.Exception

Description copied from interface: Agent

Execute a remote command on Gogo (if present) and return the result.

Specified by:

shell in interface Agent

Parameters:

cmd - the command to execute

Returns:

the result

Throws:

java.lang.Exception

setSupervisor

public void setSupervisor(Supervisor remote)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

abort

public void abort()
           throws java.lang.Exception

Description copied from interface: Agent

Abort the remote agent. The agent should send an event back and die. This is an async method.

Specified by:

abort in interface Agent

Throws:

java.lang.Exception

frameworkEvent

public void frameworkEvent(org.osgi.framework.FrameworkEvent event)

Specified by:

frameworkEvent in interface org.osgi.framework.FrameworkListener

setRemote

public void setRemote(Supervisor supervisor)

isEnvoy

public boolean isEnvoy()

Description copied from interface: Agent

An Envoy is an agent that can install a framework (well, -runpath) and launch it with an Agent. An envoy can only handle this method and Agent.createFramework(String, Collection, Map) so other methods should not be called. This rather awkward model is necessary so that we do not have to reconnect to the actual agent.

Specified by:

isEnvoy in interface Agent

Returns:

true if this is a limited envoy, otherwise true for a true Agent.

getSystemProperties

public java.util.Map<java.lang.String,java.lang.String> getSystemProperties()
                                                                     throws java.lang.Exception

Description copied from interface: Agent

Get the remote's system's System properties

Specified by:

getSystemProperties in interface Agent

Returns:

the remote systems properties

Throws:

java.lang.Exception

createFramework

public boolean createFramework(java.lang.String name,
                               java.util.Collection<java.lang.String> runpath,
                               java.util.Map<java.lang.String,java.lang.Object> properties)
                        throws java.lang.Exception

Description copied from interface: Agent

This method is only implemented in the Envoy (the pre-Agent). It is meant to install a -runpath before the framework runs. An Envoy can actally created multiple independent frameworks. If this framework already existed, and the given parameters are identical, that framework will be used for the aget that will take over. Otherwise the current framework is stopped and a new framework is started.

Specified by:

createFramework in interface Agent

Parameters:

name - the name of the framework

runpath - the runpath the install

properties - the framework properties

Returns:

if this created a new framework

Throws:

java.lang.Exception

getSupervisor

public Supervisor getSupervisor()

setLink

public void setLink(Link<Agent,Supervisor> link)

ping

public boolean ping()

Description copied from interface: Agent

Ping the remote agent to see if it is still alive.

Specified by:

ping in interface Agent

getContext

public org.osgi.framework.BundleContext getContext()

refresh

public void refresh(boolean async)
             throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

getBundles

public java.util.List<BundleDTO> getBundles(long... bundleId)
                                     throws java.lang.Exception

Description copied from interface: Agent

Get the Bundles for the given ids. If no ids are given, all bundles are returned.

Specified by:

getBundles in interface Agent

Throws:

java.lang.Exception

getBundleRevisons

public java.util.List<org.osgi.framework.wiring.dto.BundleRevisionDTO> getBundleRevisons(long... bundleId)
                                                                                  throws java.lang.Exception

Return the bundle revisions

Specified by:

getBundleRevisons in interface Agent

Throws:

java.lang.Exception