Show / Hide Table of Contents

Class AuthorizationState

Authorization state of the current SoPrincipal.
This replaces Authentication state of SoPrincipal which now is made obsolete.

Inheritance
Object
AuthorizationState
Namespace: SuperOffice.Security.Principal
Assembly: SoCore.dll
Syntax
public sealed class AuthorizationState : Enum
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Fields

AuthorizationFailed

The Authorization has failed.

Declaration
public const AuthorizationState AuthorizationFailed
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Authorized

The session is Authorized

Declaration
public const AuthorizationState Authorized
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Authorizing

The session is currently being Authorizing

Declaration
public const AuthorizationState Authorizing
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Closed

The session has closed

Declaration
public const AuthorizationState Closed
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Suspended

The session has been suspended.

Declaration
public const AuthorizationState Suspended
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Unauthorized

The process of Authorization has not been carried out.

Declaration
public const AuthorizationState Unauthorized
Field Value
Type Description
AuthorizationState
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

value__

Authorization state of the current SoPrincipal.
This replaces Authentication state of SoPrincipal which now is made obsolete.

Declaration
public int value__
Field Value
Type Description
Int32
Remarks

The initial state of SoPrincipal is allways Unauthorized.
When the Authorization starts, the state is set to Authorizing. The state is set to Authorized if the Authorization succeeded and AuthorizationFailed if the Authorization failed.

The Authorization state is set to Disconnected or Closed if such operations are performed on SoSession.

A value greater than Unauthorized means that the process of Authorization is either being carried out or has actually been successfull. CurrentPrincipal is available when the Authorization are in these states.

A value less than Unauthorized means that we don't have a valid session.

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top