net.dpml.component
Interface ControllerContext

All Known Implementing Classes:
InitialContext

public interface ControllerContext

The ControllerContext declares the runtime context that a controller is established within. Controller implementations will typically receive be bsupplied with a context object as a constructor argument.

Version:
1.0.4
Author:
Digital Product Meta Library

Method Summary
 void addControllerContextListener(ControllerContextListener listener)
          Add the supplied controller context listener to the controller context.
 String getPartition()
          Return the assigned root partition.
 File getTempDirectory()
          Return the root temporary directory.
 File getWorkingDirectory()
          Return the root working directory.
 void removeControllerContextListener(ControllerContextListener listener)
          Remove the supplied controller context listener from the controller context.
 

Method Detail

getPartition

String getPartition()
Return the assigned root partition.

Returns:
the partition name

getWorkingDirectory

File getWorkingDirectory()
Return the root working directory.

Returns:
directory representing the root of the working directory hierachy

getTempDirectory

File getTempDirectory()
Return the root temporary directory.

Returns:
directory representing the root of the temporary directory hierachy.

addControllerContextListener

void addControllerContextListener(ControllerContextListener listener)
Add the supplied controller context listener to the controller context. A controller implementation should not maintain strong references to supplied listeners.

Parameters:
listener - the controller context listener to add

removeControllerContextListener

void removeControllerContextListener(ControllerContextListener listener)
Remove the supplied controller context listener from the controller context.

Parameters:
listener - the controller context listener to remove