Package org.opennms.web.api

Class Authentication

java.lang.Object

org.opennms.web.api.Authentication

public final class Authentication
extends java.lang.Object

An uninstantiatable class that provides a servlet container-independent interface to the authentication system and a list of useful constants. A predefined list of roles will be used. Optionally, it is possible to define additional roles by creating a file called security-roles.proeprties. Here is an example for adding 2 additional roles: roles=operator,manager The 'default' roles are always going to be added, so the above list is equivalent to: roles=user,admin,operator,manager The role names will be translated to upper case, prefixing it with 'ROLE_'.

Author:

Lawrence Karnowski, Alejandro Galue

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ROLE_ADMIN
static java.lang.String	ROLE_ASSET_EDITOR
static java.lang.String	ROLE_CONFIGURATION_FILE
static java.lang.String	ROLE_DASHBOARD
static java.lang.String	ROLE_DELEGATE
static java.lang.String	ROLE_FLOW_MANAGER
static java.lang.String	ROLE_JMX
static java.lang.String	ROLE_MINION
static java.lang.String	ROLE_MOBILE
static java.lang.String	ROLE_PROVISION
static java.lang.String	ROLE_READONLY
static java.lang.String	ROLE_REPORT_DESIGNER
static java.lang.String	ROLE_REST
static java.lang.String	ROLE_RTC
static java.lang.String	ROLE_USER

Method Summary

Modifier and Type	Method	Description
static java.util.List<java.lang.String>	getAvailableRoles()
static boolean	isValidRole(java.lang.String role)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE_CONFIGURATION_FILE

public static final java.lang.String ROLE_CONFIGURATION_FILE

See Also:

Constant Field Values

ROLE_USER

public static final java.lang.String ROLE_USER

See Also:

Constant Field Values

ROLE_ADMIN

public static final java.lang.String ROLE_ADMIN

See Also:

Constant Field Values

ROLE_READONLY

public static final java.lang.String ROLE_READONLY

See Also:

Constant Field Values

ROLE_DASHBOARD

public static final java.lang.String ROLE_DASHBOARD

See Also:

Constant Field Values

ROLE_DELEGATE

public static final java.lang.String ROLE_DELEGATE

See Also:

Constant Field Values

ROLE_RTC

public static final java.lang.String ROLE_RTC

See Also:

Constant Field Values

ROLE_PROVISION

public static final java.lang.String ROLE_PROVISION

See Also:

Constant Field Values

ROLE_REST

public static final java.lang.String ROLE_REST

See Also:

Constant Field Values

ROLE_ASSET_EDITOR

public static final java.lang.String ROLE_ASSET_EDITOR

See Also:

Constant Field Values

ROLE_MOBILE

public static final java.lang.String ROLE_MOBILE

See Also:

Constant Field Values

ROLE_JMX

public static final java.lang.String ROLE_JMX

See Also:

Constant Field Values

ROLE_MINION

public static final java.lang.String ROLE_MINION

See Also:

Constant Field Values

ROLE_REPORT_DESIGNER

public static final java.lang.String ROLE_REPORT_DESIGNER

See Also:

Constant Field Values

ROLE_FLOW_MANAGER

public static final java.lang.String ROLE_FLOW_MANAGER

See Also:

Constant Field Values

Method Detail

getAvailableRoles

public static java.util.List<java.lang.String> getAvailableRoles()

isValidRole

public static boolean isValidRole(java.lang.String role)