com.elasticpath.xpf.connectivity.entity

Class XPFHttpSession

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFHttpSession

public class XPFHttpSession
extends XPFEntity

Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFHttpSession.XPFHttpSessionBuilder<C extends XPFHttpSession,B extends XPFHttpSession.XPFHttpSessionBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFHttpSession(@NonNull Map<String,Object> attributes, long creationTime, String id, long lastAccessedTime)
protected	XPFHttpSession(XPFHttpSession.XPFHttpSessionBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFHttpSession.XPFHttpSessionBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Object	getAttribute(String name) Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Enumeration<String>	getAttributeNames() Returns an Enumeration of String objects containing the names of all the objects bound to this session.
@NonNull Map<String,Object>	getAttributes() Returns a map of attributes associated with this request.
long	getCreationTime() Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
String	getId() Returns a string containing the unique identifier assigned to this session.
long	getLastAccessedTime() Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
int	hashCode()
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

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

Constructor Detail

XPFHttpSession

protected XPFHttpSession(XPFHttpSession.XPFHttpSessionBuilder<?,?> b)

XPFHttpSession

public XPFHttpSession(@NonNull
                      @NonNull Map<String,Object> attributes,
                      long creationTime,
                      String id,
                      long lastAccessedTime)

Method Detail

getAttribute

public Object getAttribute(String name)

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

Throws:

IllegalStateException - if this method is called on an invalidated session

getAttributeNames

public Enumeration<String> getAttributeNames()

Returns an Enumeration of String objects containing the names of all the objects bound to this session.

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session

Throws:

IllegalStateException - if this method is called on an invalidated session

builder

public static XPFHttpSession.XPFHttpSessionBuilder<?,?> builder()

toString

public String toString()

Overrides:

toString in class XPFEntity

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity

getAttributes

@NonNull
public @NonNull Map<String,Object> getAttributes()

Returns a map of attributes associated with this request.

Returns:

a map of attributes where the key is a String and the value is an Object

getCreationTime

public long getCreationTime()

Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.

Returns:

a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT

Throws:

IllegalStateException - if this method is called on an invalidated session

getId

public String getId()

Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.

Returns:

a string specifying the identifier assigned to this session

getLastAccessedTime

public long getLastAccessedTime()

Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Returns:

a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT

Throws:

IllegalStateException - if this method is called on an invalidated session