Class app.authkit.envoy.Tool

All Packages  This Package  Class Hierarchy  Class Search  Index

Class app.authkit.envoy.Tool

java.lang.Object
   |
   +----app.authkit.envoy.Tool

Summary

public abstract class  Tool
     extends java.lang.Object
{
          // Constructors 1
     protected Tool();

          // Methods 24
     protected void addEnvoyTask(Vector, String, String[]);
     protected void addJavaCommand(Vector, String, String[]);
     protected void addOneProperty(Vector, String);
     protected void addPrefixedProperties(Vector, String);
     protected void alert(String, Object[]);
     protected byte[] captureUntilEOF(InputStream, OutputStream, int) throws IOException;
     protected String[] chooseTarget(String, int);
     public void depart(int);
     public void explain(String);
     public void explain(Throwable);
     protected void failed(Throwable, boolean, String);
     protected Object[] getEnvoyMessageParts(String, int, String);
     protected String getJavaPath(String);
     protected String[] makeEnvoyCommand(String, String[], String, String, String, String[]);
     public String mustBeAppBundle(String) throws IOException;
     protected Authorization newAuth();
     protected Frame nonceFrame();
     public abstract void perform(String[]);
     protected void presupposeProperty(String, String);
     protected long schlepUntilEOF(InputStream, OutputStream) throws IOException;
     protected String[] stripPrefixed(String[], String);
     public void tell(String);
     protected String translateEnvoyMessage(byte[]);
     protected int waitForEnvoy(InputStream, OutputStream) throws IOException;
}

A Tool is a class that runs a privileged Envoy process and presents the results. It encapsulates the unprivileged side of peforming privileged Tasks using an Authorization.

Typically, a concrete Tool subclass is given a purpose-specific perform() method along with a completely generalized main() method that calls perform(). But this is only typical, not required. You don't have to give your Tool class a main() method. You don't have to give it a meaningful perform() method. You don't even have to use a Tool class at all to run a privileged Envoy process. It's just a convenient way to do so.

A Tool may represent only a command-line program, only a GUI program, or both, or neither. Some Tool methods refer to AWT classes, but you don't have to use them if you don't want to. If you want to use Swing classes, or some other GUI's classes, you can do that.

Most Tool methods are utility or support methods for doing the things a Tool should do on behalf of an Envoy process:

creating a concrete Authorization
preauthorizing the user, as appropriate
selecting a target item interactively, as appropriate
building a complete 'java' command-line to run an Envoy process
reading and parsing Envoy-protocol results
presenting alerts, as appropriate

System Properties Used

"file.encoding": in addJavaCommand() as a predefined property when building the Envoy process's command-line. Also implicitly used anywhere a PrintStream is created or parsed, such as captureUntilEOF(), schlepUntilEOF(), or waitForEnvoy(); or anywhere encoded bytes are turned into a String, such as translateEnvoyMessage().
"java.class.path": in addJavaCommand() as the "-cp" parameter when building a 'java' command-line.
"java.home": in getJavaPath() to determine where javaCommand is located, to construct an absolute pathname.
"os.name": in newAuth() to determine which Authorization class to instantiate.
"envoy.tasks.between": a string value, in addEnvoyTask() to precede the task-name when building an Envoy-process command-line.
"alert": a boolean value, in alert() to decide whether to present a BasicAlert or to do nothing. If alert() isn't called, this property has no effect.
"no-exit": a boolean value, in depart() to decide whether to call System.exit() or throw a ThreadDeath. If depart() isn't called, this property has no effect.

See Also: Envoy

Cross Reference

Extended By:: AppBundleLockdown, PerformAsRoot

Constructors