aQute.remote.api.Supervisor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz.aQute.remote.api Show documentation

A main program (executable JAR) that will listen to port 29998. At first, it can only answer that it is an Envoy (a limited agent). The only function it supports is installing a -runpath. It will then create a framework + agent and transfer the connection to the just installed agent who will then install the bundles. This JAR is a main command for JPM called bndremote. In JPM, it will start up with debug enabled. This JAR does some highly complicated class loading wizardy to ensure that it does not enforce any constraints on the -runpath.

The newest version!

package aQute.remote.api;

/**
 * A Supervisor handles the initiating side of a session with a remote agent.
 * The methods defined in this interface are intended to be called by the remote
 * agent, not the initiator. I.e. this is not the interface the initiator will
 * use to control the session.
 */
public interface Supervisor {

	/**
	 * An event sent from the agent.
	 *
	 * @param e the event
	 */
	void event(Event e) throws Exception;

	/**
	 * Redirected standard output
	 *
	 * @param out the text that was redirected
	 * @return ignored (to make sync)
	 */
	boolean stdout(String out) throws Exception;

	/**
	 * Redirected standard error.
	 *
	 * @param out the text that was redirected
	 * @return ignored (to make sync)
	 */
	boolean stderr(String out) throws Exception;

	/**
	 * Return the contents of the file that has the given SHA-1. The initiator
	 * of the connection should in general register the files it refers to in
	 * the communication to the agent. The agent then calls this method to
	 * retrieve the contents if it does not have it in its local cache.
	 *
	 * @param sha the SHA-1
	 * @return the contents of that file or null if no such file exists.
	 */
	byte[] getFile(String sha) throws Exception;
}