org.apache.isis.core.commons.authentication

Interface AuthenticationSession

All Superinterfaces:

Encodable, Serializable

All Known Implementing Classes:

AnonymousSession, AuthenticationSessionAbstract, AuthenticationSessionNoRuntime, SimpleSession

public interface AuthenticationSession
extends Encodable, Serializable

The representation within the system of an authenticated user.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String attributeName) For viewers (in particular) to store additional attributes, analogous to an HttpSession.
MessageBroker	getMessageBroker() The MessageBroker that holds messages for this user.
List<String>	getRoles() The roles this user belongs to
String	getUserName() The name of the authenticated user; for display purposes only.
String	getValidationCode() A unique code given to this session during authentication.
boolean	hasUserNameOf(String userName)
void	setAttribute(String attributeName, Object attribute)
void	setMessageBroker(MessageBroker messageBroker) Providing the ability for a MessageBroker to be set on this AuthenticationSession (is lazily created by the runtime).

Methods inherited from interface org.apache.isis.core.commons.encoding.Encodable

encode

Method Detail

getUserName

String getUserName()

The name of the authenticated user; for display purposes only.

hasUserNameOf

boolean hasUserNameOf(String userName)

getRoles

List<String> getRoles()

The roles this user belongs to

getValidationCode

String getValidationCode()

A unique code given to this session during authentication.

This can be used to confirm that this session has been properly created and the user has been authenticated. It should return an empty string ( "") if this is unauthenticated user (i.e., as created within an exploration system).

getAttribute

Object getAttribute(String attributeName)

For viewers (in particular) to store additional attributes, analogous to an HttpSession.

setAttribute

void setAttribute(String attributeName,
                Object attribute)

See Also:

getAttribute(String)

getMessageBroker

MessageBroker getMessageBroker()

The MessageBroker that holds messages for this user.

setMessageBroker

void setMessageBroker(MessageBroker messageBroker)

Providing the ability for a MessageBroker to be set on this AuthenticationSession (is lazily created by the runtime).