Package google.registry.flows

Class CookieSessionMetadata

java.lang.Object

google.registry.flows.SessionMetadata

google.registry.flows.CookieSessionMetadata

public class CookieSessionMetadata
extends SessionMetadata

A metadata class that saves the data directly in cookies.

Unlike HttpSessionMetadata, this class does not rely on a session manager to translate an opaque session cookie into the metadata. This means that the locality of the session manager is irrelevant and as long as the client (the proxy) respects the Set-Cookie headers and sets the respective cookies in subsequent requests in a session, the metadata will be available to all servers, not just the one that created the session.

The string representation of the metadata is saved in Base64 URL-safe format in a cookie named SESSION_INFO.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COOKIE_NAME
protected static final String	FAILED_LOGIN_ATTEMPTS
protected static final String	REGISTRAR_ID
protected static final String	SERVICE_EXTENSIONS

Fields inherited from class google.registry.flows.SessionMetadata

URI_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CookieSessionMetadata(jakarta.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
protected static String	decode(String cipherText)
protected static String	encode(String plainText)
int	getFailedLoginAttempts()
String	getRegistrarId()
Set<String>	getServiceExtensionUris()
void	incrementFailedLoginAttempts()
void	invalidate()	Invalidates the session.
void	resetFailedLoginAttempts()
void	save(Response response)
void	setRegistrarId(String registrarId)
void	setServiceExtensionUris(Set<String> serviceExtensionUris)

Methods inherited from class google.registry.flows.SessionMetadata

toString

Methods inherited from class java.lang.Object

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

Field Details

COOKIE_NAME

protected static final String COOKIE_NAME

See Also:

• Constant Field Values

REGISTRAR_ID

protected static final String REGISTRAR_ID

See Also:

• Constant Field Values

SERVICE_EXTENSIONS

protected static final String SERVICE_EXTENSIONS

See Also:

• Constant Field Values

FAILED_LOGIN_ATTEMPTS

protected static final String FAILED_LOGIN_ATTEMPTS

See Also:

• Constant Field Values

Constructor Details

CookieSessionMetadata

public CookieSessionMetadata(jakarta.servlet.http.HttpServletRequest request)

Method Details

invalidate

public void invalidate()

Description copied from class: SessionMetadata

Invalidates the session. A new instance must be created after this for future sessions. Attempts to invoke methods of this class after this method has been called will throw IllegalStateException.

Specified by:

invalidate in class SessionMetadata

getRegistrarId

public String getRegistrarId()

Specified by:

getRegistrarId in class SessionMetadata

getServiceExtensionUris

public Set<String> getServiceExtensionUris()

Specified by:

getServiceExtensionUris in class SessionMetadata

getFailedLoginAttempts

public int getFailedLoginAttempts()

Specified by:

getFailedLoginAttempts in class SessionMetadata

setRegistrarId

public void setRegistrarId(String registrarId)

Specified by:

setRegistrarId in class SessionMetadata

setServiceExtensionUris

public void setServiceExtensionUris(Set<String> serviceExtensionUris)

Specified by:

setServiceExtensionUris in class SessionMetadata

incrementFailedLoginAttempts

public void incrementFailedLoginAttempts()

Specified by:

incrementFailedLoginAttempts in class SessionMetadata

resetFailedLoginAttempts

public void resetFailedLoginAttempts()

Specified by:

resetFailedLoginAttempts in class SessionMetadata

save

public void save(Response response)

Overrides:

save in class SessionMetadata

encode

protected static String encode(String plainText)

decode

protected static String decode(String cipherText)