aQute.remote.api

Interface Supervisor

public interface Supervisor

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.

Method Summary

Modifier and Type	Method and Description
void	event(Event e) An event sent from the agent.
byte[]	getFile(java.lang.String sha) Return the contents of the file that has the given SHA-1.
boolean	stderr(java.lang.String out) Redirected standard error.
boolean	stdout(java.lang.String out) Redirected standard output

Method Detail

event

void event(Event e)
    throws java.lang.Exception

An event sent from the agent.

Parameters:

e - the event

Throws:

java.lang.Exception

stdout

boolean stdout(java.lang.String out)
        throws java.lang.Exception

Redirected standard output

Parameters:

out - the text that was redirected

Returns:

ignored (to make sync)

Throws:

java.lang.Exception

stderr

boolean stderr(java.lang.String out)
        throws java.lang.Exception

Redirected standard error.

Parameters:

out - the text that was redirected

Returns:

ignored (to make sync)

Throws:

java.lang.Exception

getFile

byte[] getFile(java.lang.String sha)
        throws java.lang.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.

Parameters:

sha - the SHA-1

Returns:

the contents of that file or null if no such file exists.

Throws:

java.lang.Exception