org.ballerinalang.net.http.session

Class HTTPSession

java.lang.Object

org.ballerinalang.net.http.session.HTTPSession

All Implemented Interfaces:

Serializable, Session

public class HTTPSession
extends Object
implements Session, Serializable

HTTPSession represents the Java session object.

Since:

0.89

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HTTPSession(String id, int maxInactiveInterval, String path)

Method Summary

Modifier and Type	Method and Description
void	generateSessionHeader(org.wso2.transport.http.netty.message.HTTPCarbonMessage message, boolean isSecureRequest) Add header to response message.
String[]	getAttributeNames() Get attribute name list.
BMap<String,BValue>	getAttributes() Get attribute key value map.
BValue	getAttributeValue(String attributeKey) Retrieve a session attribute value.
Long	getCreationTime() Get session creation time.
String	getId() Retrieve a session id.
Long	getLastAccessedTime() Get last accessed time.
int	getMaxInactiveInterval() Get max inactive time duration.
String	getPath() Get path of session.
void	invalidate() Invalidate a session.
boolean	isNew() Get session status.
boolean	isValid() check validity.
void	removeAttribute(String name) Remove attribute from session.
Session	setAccessed() Update lastaccesed time and return Session.
void	setAttribute(String attributeKey, BValue attributeValue) Add attribute key and value to session attribute map.
void	setManager(SessionManager sessionManager)
void	setMaxInactiveInterval(int maxInactiveInterval) Set max inactive time duration.
Session	setNew(boolean isNew) Update session stage whether new or already used.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPSession

public HTTPSession(String id,
                   int maxInactiveInterval,
                   String path)

Method Detail

getId

public String getId()

Description copied from interface: Session

Retrieve a session id.

Specified by:

getId in interface Session

Returns:

String id of the session.

setAttribute

public void setAttribute(String attributeKey,
                         BValue attributeValue)

Description copied from interface: Session

Add attribute key and value to session attribute map.

Specified by:

setAttribute in interface Session

Parameters:

attributeKey - key of the session attribute

attributeValue - value of the session attribute

getAttributeValue

public BValue getAttributeValue(String attributeKey)

Description copied from interface: Session

Retrieve a session attribute value.

Specified by:

getAttributeValue in interface Session

Parameters:

attributeKey - key of the session attribute

Returns:

attribute values from map if it exists, and null otherwise.

getAttributeNames

public String[] getAttributeNames()

Description copied from interface: Session

Get attribute name list.

Specified by:

getAttributeNames in interface Session

Returns:

array of attribute names.

getAttributes

public BMap<String,BValue> getAttributes()

Description copied from interface: Session

Get attribute key value map.

Specified by:

getAttributes in interface Session

Returns:

map of key value pairs.

setNew

public Session setNew(boolean isNew)

Description copied from interface: Session

Update session stage whether new or already used.

Specified by:

setNew in interface Session

Parameters:

isNew - is the stage of session

Returns:

session

getPath

public String getPath()

Description copied from interface: Session

Get path of session.

Specified by:

getPath in interface Session

Returns:

session path

removeAttribute

public void removeAttribute(String name)

Description copied from interface: Session

Remove attribute from session.

Specified by:

removeAttribute in interface Session

Parameters:

name - which needs to delete

getLastAccessedTime

public Long getLastAccessedTime()

Description copied from interface: Session

Get last accessed time.

Specified by:

getLastAccessedTime in interface Session

Returns:

Time in milliseconds.

getCreationTime

public Long getCreationTime()

Description copied from interface: Session

Get session creation time.

Specified by:

getCreationTime in interface Session

Returns:

Time in milliseconds.

getMaxInactiveInterval

public int getMaxInactiveInterval()

Description copied from interface: Session

Get max inactive time duration.

Specified by:

getMaxInactiveInterval in interface Session

Returns:

Time duration in seconds.

setMaxInactiveInterval

public void setMaxInactiveInterval(int maxInactiveInterval)

Description copied from interface: Session

Set max inactive time duration.

Specified by:

setMaxInactiveInterval in interface Session

Parameters:

maxInactiveInterval - is the session max inactive time in seconds

invalidate

public void invalidate()

Description copied from interface: Session

Invalidate a session.

Specified by:

invalidate in interface Session

setAccessed

public Session setAccessed()

Description copied from interface: Session

Update lastaccesed time and return Session.

Specified by:

setAccessed in interface Session

Returns:

current session.

isValid

public boolean isValid()

Description copied from interface: Session

check validity.

Specified by:

isValid in interface Session

Returns:

boolean depend on validity

generateSessionHeader

public void generateSessionHeader(org.wso2.transport.http.netty.message.HTTPCarbonMessage message,
                                  boolean isSecureRequest)

Description copied from interface: Session

Add header to response message.

Specified by:

generateSessionHeader in interface Session

Parameters:

message - which send to client

setManager

public void setManager(SessionManager sessionManager)

isNew

public boolean isNew()

Description copied from interface: Session

Get session status.

Specified by:

isNew in interface Session

Returns:

session status