org.apache.isis.core.commons.authentication

Class AuthenticationSessionAbstract

java.lang.Object

org.apache.isis.core.commons.authentication.AuthenticationSessionAbstract

All Implemented Interfaces:

Serializable, AuthenticationSession, Encodable

Direct Known Subclasses:

AnonymousSession, AuthenticationSessionNoRuntime, SimpleSession

public abstract class AuthenticationSessionAbstract
extends Object
implements AuthenticationSession, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationSessionAbstract(DataInputExtended input)
AuthenticationSessionAbstract(String name, List<String> roles, String validationCode)
AuthenticationSessionAbstract(String name, String code)

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(DataOutputExtended output) Returns the domain object's value as an encoded byte array via the encoder.
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() Can be overridden.
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).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationSessionAbstract

public AuthenticationSessionAbstract(String name,
                             String code)

AuthenticationSessionAbstract

public AuthenticationSessionAbstract(String name,
                             List<String> roles,
                             String validationCode)

AuthenticationSessionAbstract

public AuthenticationSessionAbstract(DataInputExtended input)
                              throws IOException

Throws:

IOException

Method Detail

encode

public void encode(DataOutputExtended output)
            throws IOException

Description copied from interface: Encodable

Returns the domain object's value as an encoded byte array via the encoder.

Specified by:

encode in interface Encodable

Throws:

IOException

getUserName

public String getUserName()

Description copied from interface: AuthenticationSession

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

Specified by:

getUserName in interface AuthenticationSession

hasUserNameOf

public boolean hasUserNameOf(String userName)

Specified by:

hasUserNameOf in interface AuthenticationSession

getRoles

public List<String> getRoles()

Can be overridden.

Specified by:

getRoles in interface AuthenticationSession

getValidationCode

public String getValidationCode()

Description copied from interface: AuthenticationSession

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).

Specified by:

getValidationCode in interface AuthenticationSession

getAttribute

public Object getAttribute(String attributeName)

Description copied from interface: AuthenticationSession

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

Specified by:

getAttribute in interface AuthenticationSession

setAttribute

public void setAttribute(String attributeName,
                Object attribute)

Specified by:

setAttribute in interface AuthenticationSession

See Also:

AuthenticationSession.getAttribute(String)

getMessageBroker

public MessageBroker getMessageBroker()

Description copied from interface: AuthenticationSession

The MessageBroker that holds messages for this user.

Specified by:

getMessageBroker in interface AuthenticationSession

setMessageBroker

public void setMessageBroker(MessageBroker messageBroker)

Description copied from interface: AuthenticationSession

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

Specified by:

setMessageBroker in interface AuthenticationSession

toString

public String toString()

Overrides:

toString in class Object