SessionFilter MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The SessionFilter type exposes the following members.
Constructors

  NameDescription
Public methodSessionFilter(WorkDispatcher, IConfigSectionNode)
Initializes a new instance of the SessionFilter class
Public methodSessionFilter(WorkHandler, IConfigSectionNode)
Initializes a new instance of the SessionFilter class
Public methodSessionFilter(WorkDispatcher, String, Int32)
Initializes a new instance of the SessionFilter class
Public methodSessionFilter(WorkHandler, String, Int32)
Initializes a new instance of the SessionFilter class
Back to Top
Methods

  NameDescription
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected methodDecodeSessionID
Override to decode session ID GUID from string representation. Return null if conversion not possible
Protected methodDestructor (Inherited from ApplicationComponent.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoFilterWork (Overrides WorkFilter DoFilterWork(WorkContext, IList WorkFilter , Int32).)
Protected methodEncodeSessionID
Override to encode session ID GUID into string representation
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Protected methodExtractSessionID
Extracts session ID from work request. The default implementation uses cookie
Protected methodFetchExistingOrMakeNewSession
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)
Public methodFilterWork
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.)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodInvokeNextWorker
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.)
Protected methodMakeNewSession
Called to create a new session
Protected methodMakeNewSessionInstance
Override to create a new session instance
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodStowSession
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)
Public methodToString (Inherited from WorkFilter.)
Protected methodTryMakeSessionFromExistingLongTermToken
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)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberCONF_COOKIE_NAME_ATTR
Public fieldStatic memberCONF_SESSION_TIMEOUT_MS_ATTR
Public fieldStatic memberDEFAULT_COOKIE_NAME
Public fieldStatic memberDEFAULT_SESSION_TIMEOUT_MS
Public fieldStatic memberNETGATE_NEWSESSION_VAR_NAME
Use this name in access deny rule in NetGate setup to block user who create too many sessions
Back to Top
Properties

  NameDescription
Public propertyComponentCommonName
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.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Public propertyCookieName
Specifies session cookie name
Public propertyDispatcher
Returns the dispatcher that this filter works under
(Inherited from WorkFilter.)
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyHandler
Returns the handler that this filter works under. May be null if the filter works under dispatcher
(Inherited from WorkFilter.)
Public propertyName
Returns the filter instance name
(Inherited from WorkFilter.)
Public propertyNetGate
Returns network gate that filter implementation may use to set business variables or null
(Inherited from WorkFilter.)
Public propertyOrder
Returns the filter order in filter registry. Order is used for URI pattern matching
(Inherited from WorkFilter.)
Public propertyServer
Returns the server that this filter works under
(Inherited from WorkFilter.)
Public propertySessionTimeoutMs
Specifies session inactivity timeout in milliseconds. For default implementation: assign 0 to use App.ObjectStore default object timeout value
Back to Top
See Also