org.csstudio.startup.module
Interface StartupParametersExtPoint

All Superinterfaces:

CSSStartupExtensionPoint

public interface StartupParametersExtPoint
extends CSSStartupExtensionPoint

StartupParametersExtPoint reads the input parameters and provides access to those parameters to the application, which subsequently forwards the parameters to other extension points.

Author:

Jaka Bobnar

NAME

static final java.lang.String NAME

The name of the extension point element

See Also:

Constant Field Values

EXIT_CODE

static final java.lang.String EXIT_CODE

The tag which defines the exit code.

See Also:

Constant Field Values

readStartupParameters

java.util.Map<java.lang.String,java.lang.Object> readStartupParameters(Display display,
                                                                       IApplicationContext context)
                                                                       throws java.lang.Exception

Gather the applications startup parameters and returns them to the user. It is up to the implementation from where the parameters will be read (either from the context, configuration file, system properties etc.). It is important that the returned parameters are properly place inside the map which is returned by this method. There is no general rule what the key and and the object should be. However, they should be of the type that is understood by the other CSSStartupExtensionPoint that are used afterwards (Some of the default implementation might use certain parameters. For details see the individual extension points.)

In the case when something happened what requires the application to exit or restart this method can put a parameter "css.exit" in the returned map which should trigger the application to take appropriate actions.

Parameters:

display - the display of the application

context - the application's context

Returns:

the map of all parameters

Throws:

java.lang.Exception - if something unexpected happened