ej.wadapps.admin

Interface Application

All Known Implementing Classes:

ApplicationStandalone, ApplicationStandalone, ModuleApplication, SignedFeatureApplicationStorage

public interface Application

An application represents a deployment unit.

Two applications are equals if and only if they have the same identifier.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Application.State Represents an application state.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIdentifier() Gets the application identifier.
java.lang.String	getProperty(java.lang.String key) Gets an application property.
java.io.InputStream	getResourceAsStream(java.lang.String name) Gets an input stream for reading the specified resource from the application.
Application.State	getState() Returns the current application state.
java.lang.String	getVersion() Gets the application version.
void	install() Deprecated.
void	install(IProgressMonitor monitor) Deprecated.
void	start() Causes this application to start.
void	start(IProgressMonitor monitor) Causes this application to start.
void	stop() Causes this application to stop.
void	uninstall() Causes the application to be uninstalled.

Method Detail

getIdentifier

java.lang.String getIdentifier()

Gets the application identifier.

The identifier remains the same even between different application version.

Returns:

the application identifier.

getVersion

java.lang.String getVersion()

Gets the application version.

Returns:

the application version.

getResourceAsStream

java.io.InputStream getResourceAsStream(java.lang.String name)
                                 throws java.lang.IllegalStateException

Gets an input stream for reading the specified resource from the application.

Parameters:

name - the resource name.

Returns:

an input stream for reading the resource, or null if the resource could not be found.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.STARTED state.

getProperty

java.lang.String getProperty(java.lang.String key)
                      throws java.lang.IllegalStateException

Gets an application property.

Parameters:

key - the property key to search.

Returns:

the requested property or null if not existing.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.STARTED state.

getState

Application.State getState()

Returns the current application state.

Returns:

the application state.

See Also:

Application.State

install

@Deprecated
void install()
                  throws java.lang.IllegalStateException,
                         java.lang.SecurityException,
                         ApplicationOperationException

Deprecated.

Causes this application to be installed.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.UNINSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while installing this application.

install

@Deprecated
void install(IProgressMonitor monitor)
                  throws java.lang.IllegalStateException,
                         java.lang.SecurityException,
                         ApplicationOperationException

Deprecated.

Causes this application to be installed.

Parameters:

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.UNINSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while installing this application.

start

void start()
    throws java.lang.IllegalStateException,
           java.lang.SecurityException,
           ApplicationOperationException

Causes this application to start. A new thread owned by the application is created and started. The application is switched in the Application.State.STARTED state and this method returns.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.INSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while starting this application.

start

void start(IProgressMonitor monitor)
    throws java.lang.IllegalStateException,
           java.lang.SecurityException,
           ApplicationOperationException

Causes this application to start. A new thread owned by the application is created and started. The application is switched in the Application.State.STARTED state and this method returns.

Parameters:

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

Throws:

java.lang.IllegalStateException - if the application state is not Application.State.INSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while starting this application.

stop

void stop()
   throws java.lang.IllegalStateException,
          java.lang.SecurityException,
          ApplicationOperationException

Causes this application to stop. The application is switched in the Application.State.INSTALLED state and this method returns.

Throws:

java.lang.IllegalStateException - if the application is in the Application.State.INSTALLED or Application.State.UNINSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while stopping this application.

uninstall

void uninstall()
        throws java.lang.IllegalStateException,
               java.lang.SecurityException,
               ApplicationOperationException

Causes the application to be uninstalled.

Throws:

java.lang.IllegalStateException - if the application is not in the Application.State.INSTALLED state.

java.lang.SecurityException - if a security manager exits and if the caller does not have the appropriate permissions.

ApplicationOperationException - If any unexpected errors occur while uninstalling this application.