org.csstudio.startup.module
Interface LoginExtPoint

All Superinterfaces:

CSSStartupExtensionPoint

public interface LoginExtPoint
extends CSSStartupExtensionPoint

LoginExtPoint defines the credentials for the login to the application and logins the user to the application.

Author:

Jaka Bobnar

NAME

static final java.lang.String NAME

The name of this extension point element

See Also:

Constant Field Values

USERNAME

static final java.lang.String USERNAME

The tag under which the username should be stored in the parameters map

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

The tag under which the password should be stored in the parameters map

See Also:

Constant Field Values

login

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

Prompts the user to enter the credentials and logins to the application. The credentials should be placed in the parameters map since they might be used by other extension points. Use the USERNAME and PASSWORD tags to store the data into the map.

Parameters:

display - the display of the application

context - the application's context

parameters - contains additional parameters, which can define some special behavior during the execution of this method (the keys are parameters names and the values are parameters values)

Returns:

the exit code if something happened which requires to exit or restart application or null if everything is alright

Throws:

java.lang.Exception - if an error occurred during the operation