All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.tasks.DirectoryResolverTask

java.lang.Object
   |
   +----com.sun.wizards.core.Task
           |
           +----com.sun.wizards.tasks.DirectoryResolverTask

public class DirectoryResolverTask
extends Task
implements Serializable

The DirectoryResolver class provides a way to resolve directories at runtime. Directories can be set into the WizardState and serialized at buildtime. Flags are used within the directory specification to indicate the base directory to start from. The following directory flags are known:

[productDir] The directory products are generally installed into.
[sharedLibDir] The directory shared libraries are generally placed in.
[tmpDir] The temporary directory.
[userDir] The user's home directory.
[currentDir] The current directory.
At buildtime, the directory is set into the WizardState, using a call such as:
```
      WizardState wizardState = getWizardState();
      wizardState.setData("installDirectory", "[productDir]/myApp");
 
```
The DirectoryResolverTask is added to the initialize sequence:
```
      DirectoryResolverTask dirResolver = new DirectoryResolverTask();
      Sequence initializeSequence = wizardState.getSequence("wizardStateInitialization");
      if(initializeSequence == null)
         initializeSequence = new Sequence();
      initializeSequence.addTask(dirResolver);
      wizardState.addSequence("wizardStateInitialization", initializeSequence);
 
```
The directoryResolverTask is finally configured to resolve the directory set into the WizardState:
```
      dirResolver.registerDirectoryKey("installDirectory");
 
```
This sets up the WizardState data identified by the key "installDirectory" to point to "/opt/myApp" on Solaris, and "C:\\Program Files\myApp" on Windows.

DirectoryResolverTask()
Creates a DirectoryResolverTask.

addRuntimeResources(Vector)
Add the runtime class requirements to the specified vector.
initialize(Sequence)
We only want this task to run once.
registerDirectoryKey(String)
Registers the specified key for runtime resolution.

DirectoryResolverTask
```
 public DirectoryResolverTask()
```
Creates a DirectoryResolverTask. After creation, WizardState keys must be registered for runtime resolution via the registerDirectoryKey method.

registerDirectoryKey
```
 public void registerDirectoryKey(String key)
```
Registers the specified key for runtime resolution. The key identifies data set into the WizardState object.

Parameters:
key - The WizardState data key that identifies a directory to be resolved at runtime.

initialize
```
 public void initialize(Sequence sequence)
```
We only want this task to run once. This can be guaranteed if we use the initialize method. Also, that means that the Sequence that contains this task does not have to be performed or reversed to have this task do its job.

Parameters:
sequence - The sequence that manages this task.
Overrides:
initialize in class Task

addRuntimeResources
```
 public void addRuntimeResources(Vector resourceVector)
```
Add the runtime class requirements to the specified vector.

Parameters:
resourceVector - The vector containing all runtime resources for this wizard.
Overrides:
addRuntimeResources in class Task
```
All Packages  Class Hierarchy  This Package  Previous  Next  Index
```