railo.runtime.type.scope.storage
Interface StorageScope

All Superinterfaces:
Castable, Cloneable, Collection, Dumpable, ForEachIteratorable, Iteratorable, Map, Objects, Scope, Serializable, SharedScope, Sizeable, Struct
All Known Subinterfaces:
Client
All Known Implementing Classes:
ClientCache, ClientCookie, ClientDatasource, ClientFile, ClientMemory, SessionCache, SessionCookie, SessionDatasource, SessionFile, SessionMemory, StorageScopeCache, StorageScopeCookie, StorageScopeDatasource, StorageScopeFile, StorageScopeImpl, StorageScopeMemory

public interface StorageScope
extends SharedScope

scope that can be stored, in a storage


Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from interface railo.runtime.type.scope.Scope
SCOPE_APPLICATION, SCOPE_ARGUMENTS, SCOPE_CALLER, SCOPE_CGI, SCOPE_CLIENT, SCOPE_CLUSTER, SCOPE_COOKIE, SCOPE_COUNT, SCOPE_FORM, SCOPE_LOCAL, SCOPE_REQUEST, SCOPE_SERVER, SCOPE_SESSION, SCOPE_UNDEFINED, SCOPE_URL, SCOPE_VAR, SCOPE_VARIABLES
 
Fields inherited from interface railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SOFT, TYPE_SYNC, TYPE_WEAKED
 
Method Summary
 String generateToken(String key, boolean forceNew)
           
 long getCreated()
           
 long getLastAccess()
           
 int getMaxInactiveInterval()
          Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
 String getStorage()
          return the name of the storage used, this is not the storage type!
 String getStorageType()
           
 long getTimeSpan()
           
 boolean isExpired()
           
 long lastVisit()
           
 void setMaxInactiveInterval(int interval)
          Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
 void setStorage(String storage)
          sets the name of the storage used, this is not the storage type!
 void store(Config config)
          store content on persistent layer
 void touch()
           
 void unstore(Config config)
          remove stored data from persistent layer
 boolean verifyToken(String token, String key)
           
 
Methods inherited from interface railo.runtime.type.scope.SharedScope
touchAfterRequest, touchBeforeRequest
 
Methods inherited from interface railo.runtime.type.scope.Scope
getType, getTypeAsString, initialize, isInitalized, release, release
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, remove, removeEL, set, set, setEL, setEL, size
 
Methods inherited from interface railo.runtime.type.Iteratorable
entryIterator, keyIterator, keysAsStringIterator, valueIterator
 
Methods inherited from interface railo.runtime.type.ForEachIteratorable
getIterator
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from interface railo.runtime.type.Sizeable
sizeOf
 
Methods inherited from interface railo.runtime.type.Objects
call, callWithNamedValues, get, get, set, setEL
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 
Methods inherited from interface railo.runtime.op.Castable
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo
 

Method Detail

lastVisit

long lastVisit()
Returns:
time when the Scope last time was visited

getStorageType

String getStorageType()

getLastAccess

long getLastAccess()

touch

void touch()

isExpired

boolean isExpired()

getTimeSpan

long getTimeSpan()

store

void store(Config config)
store content on persistent layer


unstore

void unstore(Config config)
remove stored data from persistent layer


setStorage

void setStorage(String storage)
sets the name of the storage used, this is not the storage type!

Parameters:
storage -

getStorage

String getStorage()
return the name of the storage used, this is not the storage type!

Returns:

setMaxInactiveInterval

void setMaxInactiveInterval(int interval)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A negative time indicates the session should never timeout.

Parameters:
interval - - An integer specifying the number of seconds

getMaxInactiveInterval

int getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.

Returns:
an integer specifying the number of seconds this session remains open between client requests

getCreated

long getCreated()

generateToken

String generateToken(String key,
                     boolean forceNew)

verifyToken

boolean verifyToken(String token,
                    String key)


Copyright © 2012 Railo