[This is preliminary documentation and is subject to change.]
The SessionFilter type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | SessionFilter(WorkDispatcher, IConfigSectionNode) | Initializes a new instance of the SessionFilter class |
![]() | SessionFilter(WorkHandler, IConfigSectionNode) | Initializes a new instance of the SessionFilter class |
![]() | SessionFilter(WorkDispatcher, String, Int32) | Initializes a new instance of the SessionFilter class |
![]() | SessionFilter(WorkHandler, String, Int32) | Initializes a new instance of the SessionFilter class |
Methods
Name | Description | |
---|---|---|
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | DecodeSessionID |
Override to decode session ID GUID from string representation. Return null if conversion not possible
|
![]() | Destructor | (Inherited from ApplicationComponent.) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoFilterWork | (Overrides WorkFilter DoFilterWork(WorkContext, IList WorkFilter , Int32).) |
![]() | EncodeSessionID |
Override to encode session ID GUID into string representation
|
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ExtractSessionID |
Extracts session ID from work request. The default implementation uses cookie
|
![]() | FetchExistingOrMakeNewSession |
Override to get session object using whatever parameters are available in response context (i.e. a cookie),
or create a new one if 'onlyExisting'=false(default)
|
![]() | FilterWork |
Override to filter the work - i.e. extract some security name from cookies and check access, turn exception in error page etc.
Note: This method is re-entrant by multiple threads
(Inherited from WorkFilter.) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | InvokeNextWorker |
Invokes next processing body be it the next filter or handler (when all filters are iterated through).
The filter implementors must call this method to pass WorkContext processing along the line.
Does nothing if work is Aborted or Handled
(Inherited from WorkFilter.) |
![]() | MakeNewSession |
Called to create a new session
|
![]() | MakeNewSessionInstance |
Override to create a new session instance
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | StowSession |
Override to put session object back into whatever storage medium is provided (i.e. DB) and
respond with appropriate session identifying token(i.e. a cookie)
|
![]() | ToString | (Inherited from WorkFilter.) |
![]() | TryMakeSessionFromExistingLongTermToken |
Override in session filters that support long-term tokens.
This method tries to re-create "existing" session from a valid long-term token, otherwise
null should be returned (the base implementation)
|
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONF_COOKIE_NAME_ATTR | |
![]() ![]() | CONF_SESSION_TIMEOUT_MS_ATTR | |
![]() ![]() | DEFAULT_COOKIE_NAME | |
![]() ![]() | DEFAULT_SESSION_TIMEOUT_MS | |
![]() ![]() | NETGATE_NEWSESSION_VAR_NAME |
Use this name in access deny rule in NetGate setup to block user who create too many sessions
|
Properties
Name | Description | |
---|---|---|
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | CookieName |
Specifies session cookie name
|
![]() | Dispatcher |
Returns the dispatcher that this filter works under
(Inherited from WorkFilter.) |
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | Handler |
Returns the handler that this filter works under. May be null if the filter works under dispatcher
(Inherited from WorkFilter.) |
![]() | Name |
Returns the filter instance name
(Inherited from WorkFilter.) |
![]() | NetGate |
Returns network gate that filter implementation may use to set business variables or null
(Inherited from WorkFilter.) |
![]() | Order |
Returns the filter order in filter registry. Order is used for URI pattern matching
(Inherited from WorkFilter.) |
![]() | Server |
Returns the server that this filter works under
(Inherited from WorkFilter.) |
![]() | SessionTimeoutMs |
Specifies session inactivity timeout in milliseconds.
For default implementation: assign 0 to use App.ObjectStore default object timeout value
|
See Also