com.aspc.Soap

Class AppSession

java.lang.Object

com.aspc.Soap.AppSession

All Implemented Interfaces:

java.lang.Runnable

public final class AppSession
extends java.lang.Object
implements java.lang.Runnable

AppSession is a TODO: This class needs work.
THREAD MODE: MULTI-THREADED

Since:

10 December 2001, 16:58

Author:

Nigel Leck

Method Summary

Modifier and Type	Method and Description
static AppSession	create(GlobalKey loginKey, java.lang.String signature, java.lang.String timeZoneId) The function create() creates a new session based on the parameters passed in.
static AppSession	find(java.lang.String id) The function find() receives a session id as a parameter and returns the instance of AppSession for the session id.
java.lang.String	getId()
GlobalKey	getLoginKey()
java.lang.String	getSignature()
java.lang.String	getTimeZoneId()
static boolean	isSessionValid(java.lang.String sessionId) The function isSessionValid() receives a session id as a parameter.
static AppSession	remove(java.lang.String id) The function remove() removes a session identified by the parameter from the system
void	run()
void	setEnd(java.util.Date end)

Methods inherited from class java.lang.Object

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

Method Detail

find

public static AppSession find(java.lang.String id)
                       throws NotFoundException

The function find() receives a session id as a parameter and returns the instance of AppSession for the session id. If the session id is invalid and does not identify a valid session, a NotFoundException is thrown.

Parameters:

id - A session id string

Returns:

The instance of AppSession that is identified by the session id passed as a parameter.

Throws:

NotFoundException

isSessionValid

public static boolean isSessionValid(java.lang.String sessionId)

The function isSessionValid() receives a session id as a parameter. If the session id belongs top a valid session, the function returns true. If the session does not exist, the function returns false.

Parameters:

sessionId - The session id that will be checked by this function.

Returns:

true, if the session id identifies an active valid session, otherwise false.

create

public static AppSession create(GlobalKey loginKey,
                                java.lang.String signature,
                                java.lang.String timeZoneId)

The function create() creates a new session based on the parameters passed in.

Parameters:

loginKey -

signature - The database name

timeZoneId - The timezone identifier in GMT offset format

Returns:

A new instance of AppSession

remove

public static AppSession remove(java.lang.String id)

The function remove() removes a session identified by the parameter from the system

Parameters:

id - The session id of the session that will be removed.

Returns:

The AppSession instance that was removed, null if the session id was invalid or the session was not active.

getId

public java.lang.String getId()

Returns:

the value

getLoginKey

public GlobalKey getLoginKey()

Returns:

the value

getSignature

public java.lang.String getSignature()

Returns:

the value

getTimeZoneId

public java.lang.String getTimeZoneId()

Returns:

the value

setEnd

public void setEnd(java.util.Date end)
            throws java.lang.Exception

Parameters:

end -

Throws:

java.lang.Exception - a serious problem

run

public void run()

Specified by:

run in interface java.lang.Runnable