ej.wadapps.application

Interface Application

All Known Implementing Classes:

AbstractApplicationMonoSandbox, FeatureApplication

public interface Application

An application represents a deployment unit.

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

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Gets the application unique identifier.
String	getVersion() Gets the application version.
boolean	isStarted() Gets whether the application is started or not.
void	start() Causes this application to start.
void	start(IProgressMonitor monitor) Causes this application to start.
void	stop() Causes this application to stop.
void	stop(IProgressMonitor monitor) Causes this application to stop.

Method Detail

getIdentifier

String getIdentifier()

Gets the application unique identifier.

The identifier remains the same even between different application version.

This identifier is a unique identifier in the application ecosystem (for example an application store) and may not be the same as the one in the application MANIFEST.MF.

Returns:

the application identifier.

getVersion

String getVersion()

Gets the application version.

This version depends on the application ecosystem (for example an application store) and may not be the same as the one in the application MANIFEST.MF.

Returns:

the application version.

isStarted

boolean isStarted()

Gets whether the application is started or not.

Returns:

true if the application is started, false otherwise.

start

void start()
    throws IllegalStateException,
           SecurityException,
           ApplicationOperationException

Causes this application to start. A new thread owned by the application is created and started. The application became started and this method returns.

Throws:

IllegalStateException - if the application state is already started.

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.

See Also:

isStarted()

start

void start(IProgressMonitor monitor)
    throws IllegalStateException,
           SecurityException,
           ApplicationOperationException

Causes this application to start. A new thread owned by the application is created and started. The application became started 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.

Throws:

IllegalStateException - if the application state is already started.

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.

See Also:

isStarted()

stop

void stop()
   throws IllegalStateException,
          SecurityException,
          ApplicationOperationException

Causes this application to stop. The application became stopped and this method returns.

Throws:

IllegalStateException - if the application is not started.

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.

See Also:

isStarted()

stop

void stop(IProgressMonitor monitor)
   throws IllegalStateException,
          SecurityException,
          ApplicationOperationException

Causes this application to stop. The application became stopped 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.

Throws:

IllegalStateException - if the application is not started.

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.

See Also:

isStarted()