Package org.appng.api

Interface Environment

All Known Implementing Classes:

DefaultEnvironment

public interface Environment

The Environment is able to set, read and remove attributes of a certain Scope. The main purposes are:

• keeping track of the current Subject via getSubject()
• providing informations about the current Locale and TimeZone via getLocale() and getTimeZone()
• allowing to share attributes between multiple applications (using Scope.SESSION and Scope.SITE)
• keeping track of platform-wide configuration parameters ( Scope.PLATFORM and Applications where Application.isPrivileged() is true)

Author:

Matthias Müller

See Also:

Scope

Method Summary

Modifier and Type	Method	Description
<T> T	getAttribute(Scope scope, String name)	Returns the attribute with the given name for the given Scope.
String	getAttributeAsString(Scope scope, String name)	Returns the string-representation of an attribute, calling toString() on the resulting object.
Locale	getLocale()	Returns the current Locale.
Subject	getSubject()	Returns the current Subject.
TimeZone	getTimeZone()	Returns the current TimeZone.
boolean	isSubjectAuthenticated()	Returns true if the current Subject is authenticated, false otherwise
Set<String>	keySet(Scope scope)	Returns a Set of all attribute names for the given Scope
<T> T	removeAttribute(Scope scope, String name)	Removes the attribute with the given name from the given Scope and returns it.
void	setAttribute(Scope scope, String name, Object value)	Sets an attribute for the given Scope to the given value.

Method Detail

setAttribute

void setAttribute(Scope scope,
                  String name,
                  Object value)

Sets an attribute for the given Scope to the given value.

Parameters:

scope - the Scope of the attribute to set

name - the name of the attribute to set

value - the attribute to set

getAttribute

<T> T getAttribute(Scope scope,
                   String name)

Returns the attribute with the given name for the given Scope.

Parameters:

scope - the Scope of the attribute to get

name - the name of the attribute to get

Returns:

the attribute of the desired type, or null if the attribute does not exist in the given Scope

removeAttribute

<T> T removeAttribute(Scope scope,
                      String name)

Removes the attribute with the given name from the given Scope and returns it.

Parameters:

scope - the Scope of the attribute to remove

name - the name of the attribute to remove

Returns:

the attribute of the desired type, or null if the attribute does not exist in the given Scope

getAttributeAsString

String getAttributeAsString(Scope scope,
                            String name)

Returns the string-representation of an attribute, calling toString() on the resulting object.

Parameters:

scope - the Scope of the attribute to get

name - the name of the attribute to get

Returns:

the string-representation of the attribute, or null if the attribute does not exist in the given Scope

keySet

Set<String> keySet(Scope scope)

Returns a Set of all attribute names for the given Scope

Parameters:

scope - the Scope the get the attribute names for

Returns:

a Set containing all attribute names, or null if the Scope is not available

getSubject

Subject getSubject()

Returns the current Subject.

Returns:

the Subject, if present

getLocale

Locale getLocale()

Returns the current Locale. If a Subject is logged in, a Locale is returned that represent the language of the Subject via Account.getLanguage(). If no Subject is present, the default-Locale from the Site is used.

Returns:

the Locale

getTimeZone

TimeZone getTimeZone()

Returns the current TimeZone. If a Subject is present (no matter whether it is logged in or not), Account.getTimeZone() is being returned. If no Subject is present, the default-TimeZone from the Site is used.

Returns:

the TimeZone

isSubjectAuthenticated

boolean isSubjectAuthenticated()

Returns true if the current Subject is authenticated, false otherwise

Returns:

true if the current Subject is authenticated, false otherwise