votorola.a.response

Class CommandResponder.Session

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<Object,Object>

CommandResponder.Session

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, AuthenticatedUser, ServiceSession

Enclosing interface:

CommandResponder

@ThreadRestricted
public static final class CommandResponder.Session
extends HashMap<Object,Object>
implements AuthenticatedUser, ServiceSession

A service session with a user. It is intended for short service in response to a single email message, for example, or a single HTTP request. It embodies a keyed map of ad hoc, session-scope variables.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandResponder.Session.ResponderNameComparator A comparator to compare command-responders by commandName.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
CommandResponder.Session(VoterInterface _voterInterface, String _email, int _trustLevel, BundleFormatter _bunA, ReplyBuilder _replyBuilder) Constructs a Session.

Method Summary

Methods

Modifier and Type	Method and Description
BundleFormatter	bunA() The application (A) bundle formatter for this session.
BundleFormatter	bunCR() The command/response (CR) bundle formatter for this session.
String	email() The user's canonical email address, which might be that of NOBODY.email().
ReplyBuilder	replyBuilder() The command-response (CR) builder to use in replying to commands.
int	trustLevel() The user's trust level.
AuthenticatedUser	user() The authenticated user, or null if the user is unauthenticated.
AuthenticatedUser	userOrNobody() The authenticated user, or NOBODY if the user is unauthenticated.
VoterInterface	voterInterface() The voter interface that is providing this session.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

CommandResponder.Session

public CommandResponder.Session(VoterInterface _voterInterface,
                        String _email,
                        int _trustLevel,
                        BundleFormatter _bunA,
                        ReplyBuilder _replyBuilder)

Constructs a Session.

See Also:

voterInterface(), email(), trustLevel(), bunA(), replyBuilder()

Method Detail

bunA

public BundleFormatter bunA()

The application (A) bundle formatter for this session. It uses bundle base name 'votorola.a.locale.A'.

See Also:

../locale/A.properties, bunCR()

bunCR

public BundleFormatter bunCR()

The command/response (CR) bundle formatter for this session. It uses bundle base name 'votorola.a.locale.CR'.

Returns:

the reply builder.

See Also:

../locale/CR.properties, bunA(), replyBuilder()

replyBuilder

public ReplyBuilder replyBuilder()

The command-response (CR) builder to use in replying to commands. It uses bundle base name 'votorola.a.locale.CR'.

See Also:

../locale/CR.properties, bunA(), bunCR()

voterInterface

public VoterInterface voterInterface()

The voter interface that is providing this session.

email

public String email()

Description copied from interface: AuthenticatedUser

The user's canonical email address, which might be that of NOBODY.email().

Specified by:

email in interface AuthenticatedUser

trustLevel

public int trustLevel()

Description copied from interface: AuthenticatedUser

The user's trust level.

Specified by:

trustLevel in interface AuthenticatedUser

user

public AuthenticatedUser user()

Description copied from interface: ServiceSession

The authenticated user, or null if the user is unauthenticated.

Specified by:

user in interface ServiceSession

userOrNobody

public AuthenticatedUser userOrNobody()

Description copied from interface: ServiceSession

The authenticated user, or NOBODY if the user is unauthenticated.

Specified by:

userOrNobody in interface ServiceSession