net.dpml.station
Interface Application

All Superinterfaces:
Remote
All Known Implementing Classes:
RemoteApplication

public interface Application
extends Remote

Application process controller.

Version:
1.0.1
Author:
Digital Product Meta Library

Field Summary
static int DEFAULT_SHUTDOWN_TIMEOUT
          The default shutdown timeout in seconds.
static int DEFAULT_STARTUP_TIMEOUT
          The default startup timeout in seconds.
 
Method Summary
 void addApplicationListener(ApplicationListener listener)
          Add an application listener.
 ApplicationDescriptor getApplicationDescriptor()
          Return the profile associated with this application
 String getID()
          Return the application id.
 PID getPID()
          Return the process identifier of the process within which the application is running.
 ProcessState getProcessState()
          Return the current deployment state of the process.
 Provider getProvider()
          Return the component instance handler.
 void removeApplicationListener(ApplicationListener listener)
          Remove an application listener.
 void restart()
          Restart the application.
 void start()
          Start the application.
 void stop()
          Stop the application.
 

Field Detail

DEFAULT_STARTUP_TIMEOUT

public static final int DEFAULT_STARTUP_TIMEOUT
The default startup timeout in seconds.

See Also:
Constant Field Values

DEFAULT_SHUTDOWN_TIMEOUT

public static final int DEFAULT_SHUTDOWN_TIMEOUT
The default shutdown timeout in seconds.

See Also:
Constant Field Values
Method Detail

getID

public String getID()
             throws RemoteException
Return the application id.

Returns:
the id
Throws:
RemoteException - if a remote error occurs

getPID

public PID getPID()
           throws RemoteException
Return the process identifier of the process within which the application is running.

Returns:
the pid
Throws:
RemoteException - if a remote error occurs

getApplicationDescriptor

public ApplicationDescriptor getApplicationDescriptor()
                                               throws RemoteException
Return the profile associated with this application

Returns:
the application profile
Throws:
RemoteException - if a remote error occurs

getProcessState

public ProcessState getProcessState()
                             throws RemoteException
Return the current deployment state of the process.

Returns:
the current process state
Throws:
RemoteException - if a remote error occurs

start

public void start()
           throws RemoteException
Start the application.

Throws:
RemoteException - if a remote error occurs

stop

public void stop()
          throws RemoteException
Stop the application.

Throws:
RemoteException - if a remote error occurs

restart

public void restart()
             throws RemoteException
Restart the application.

Throws:
RemoteException - if a rmote error occurs

getProvider

public Provider getProvider()
                     throws RemoteException
Return the component instance handler.

Returns:
the instance handler (possibly null)
Throws:
RemoteException - if a remote error occurs

addApplicationListener

public void addApplicationListener(ApplicationListener listener)
                            throws RemoteException
Add an application listener.

Parameters:
listener - the listener to add
Throws:
RemoteException - if a remote error occurs

removeApplicationListener

public void removeApplicationListener(ApplicationListener listener)
                               throws RemoteException
Remove an application listener.

Parameters:
listener - the listener to remove
Throws:
RemoteException - if a remote error occurs