net.javapla.jawn.security

Class JawnRememberMeManager

java.lang.Object

org.apache.shiro.mgt.AbstractRememberMeManager

net.javapla.jawn.security.JawnRememberMeManager

All Implemented Interfaces:

org.apache.shiro.mgt.RememberMeManager

public class JawnRememberMeManager
extends org.apache.shiro.mgt.AbstractRememberMeManager

A reimplementation of Shiro's CookieRememberMeManager

Field Summary

Fields

Modifier and Type	Field and Description
protected net.javapla.jawn.core.http.Cookie	cookie
static java.lang.String	DEFAULT_REMEMBER_ME_COOKIE_NAME The default name of the underlying rememberMe cookie which is jawnRememberMe.
static java.lang.String	IDENTITY_REMOVED_KEY

Constructor Summary

Constructors

Constructor and Description
JawnRememberMeManager() Constructs a new CookieRememberMeManager with a default rememberMe cookie template.

Method Summary

Modifier and Type	Method and Description
protected void	forgetIdentity(org.apache.shiro.subject.Subject subject)
void	forgetIdentity(org.apache.shiro.subject.SubjectContext subjectContext)
net.javapla.jawn.core.http.Cookie	getCookie() Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager.
protected byte[]	getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext subjectContext) Returns a previously serialized identity byte array or null if the byte array could not be acquired.
protected java.lang.String	readCookieValue(net.javapla.jawn.core.http.Context context)
protected void	rememberSerializedIdentity(org.apache.shiro.subject.Subject subject, byte[] serialized) Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.
void	setCookie(net.javapla.jawn.core.http.Cookie cookie) Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager.

Methods inherited from class org.apache.shiro.mgt.AbstractRememberMeManager

convertBytesToPrincipals, convertPrincipalsToBytes, decrypt, deserialize, encrypt, getCipherKey, getCipherService, getDecryptionCipherKey, getEncryptionCipherKey, getIdentityToRemember, getRememberedPrincipals, getSerializer, isRememberMe, onFailedLogin, onLogout, onRememberedPrincipalFailure, onSuccessfulLogin, rememberIdentity, rememberIdentity, serialize, setCipherKey, setCipherService, setDecryptionCipherKey, setEncryptionCipherKey, setSerializer

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REMEMBER_ME_COOKIE_NAME

public static final java.lang.String DEFAULT_REMEMBER_ME_COOKIE_NAME

The default name of the underlying rememberMe cookie which is jawnRememberMe.

See Also:

Constant Field Values

IDENTITY_REMOVED_KEY

public static final java.lang.String IDENTITY_REMOVED_KEY

cookie

protected net.javapla.jawn.core.http.Cookie cookie

Constructor Detail

JawnRememberMeManager

public JawnRememberMeManager()

Constructs a new CookieRememberMeManager with a default rememberMe cookie template.

Method Detail

getCookie

public net.javapla.jawn.core.http.Cookie getCookie()

Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager. Outgoing cookies will match this one except for the value attribute, which is necessarily set dynamically at runtime.

Please see the class-level JavaDoc for the default cookie's attribute values.

Returns:

the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager.

setCookie

public void setCookie(net.javapla.jawn.core.http.Cookie cookie)

Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager. Outgoing cookies will match this one except for the value attribute, which is necessarily set dynamically at runtime.

Please see the class-level JavaDoc for the default cookie's attribute values.

Parameters:

cookie - the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager.

forgetIdentity

public void forgetIdentity(org.apache.shiro.subject.SubjectContext subjectContext)

forgetIdentity

protected void forgetIdentity(org.apache.shiro.subject.Subject subject)

Specified by:

forgetIdentity in class org.apache.shiro.mgt.AbstractRememberMeManager

rememberSerializedIdentity

protected void rememberSerializedIdentity(org.apache.shiro.subject.Subject subject,
                                          byte[] serialized)

Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.

The subject instance is expected to be a WebSubject instance with an HTTP Request/Response pair so an HTTP cookie can be set on the outgoing response. If it is not a WebSubject or that WebSubject does not have an HTTP Request/Response pair, this implementation does nothing.

Specified by:

rememberSerializedIdentity in class org.apache.shiro.mgt.AbstractRememberMeManager

Parameters:

subject - the Subject for which the identity is being serialized.

serialized - the serialized bytes to be persisted.

getRememberedSerializedIdentity

protected byte[] getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext subjectContext)

Returns a previously serialized identity byte array or null if the byte array could not be acquired. This implementation retrieves an HTTP cookie, Base64-decodes the cookie value, and returns the resulting byte array.

The SubjectContext instance is expected to be a WebSubjectContext instance with an HTTP Request/Response pair so an HTTP cookie can be retrieved from the incoming request. If it is not a WebSubjectContext or that WebSubjectContext does not have an HTTP Request/Response pair, this implementation returns null.

Specified by:

getRememberedSerializedIdentity in class org.apache.shiro.mgt.AbstractRememberMeManager

Parameters:

subjectContext - the contextual data, usually provided by a Subject.Builder implementation, that is being used to construct a Subject instance. To be used to assist with data lookup.

Returns:

a previously serialized identity byte array or null if the byte array could not be acquired.

readCookieValue

protected java.lang.String readCookieValue(net.javapla.jawn.core.http.Context context)