The RESTSecurityInvoker type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | RESTSecurityInvoker |
Methods
| Name | Description | |
|---|---|---|
| AddBindingParameters |
Not needed, remains empty, does nothing.
|
| AllocateInputs |
Calls AllocateInputs on the invoker.
|
| ApplyClientBehavior |
Not needed, remains empty, does nothing.
|
| ApplyDispatchBehavior |
Initializes the invoker.
|
| AuthenticateUser |
Authenticates the user according to authentication type setting.
|
 | AuthenticateUser(String) |
Authenticates the user according to authentication type setting.
|
| AuthenticateUserBasic |
Authenticates the user using basic authentication.
|
| AuthenticateUserForms |
Authenticates the user from the authentication cookie. If everything is ok returns name of the authenticated user. Otherwise returns null;
|
|  Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAuthenticationType |
Returns authentication type from settings.
|
| GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| HandleRESTAuthentication |
Handles necessary actions to provide proper REST authentication response
|
| CheckHash |
Checks hash parameter. Returns true if the parameter matches the requested URL. For request different from GET returns alsways false.
|
| Invoke |
Invokes the operation only when authentication went well.
|
| InvokeBegin |
Not implemented method.
|
| InvokeEnd |
Not implemented method.
|
| IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
| Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Validate |
Not needed, remains empty, does nothing.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | HASH_AUTHENTICATED_USERNAME |
Constant to identify the hash authentication requirement
|
Properties
| Name | Description | |
|---|---|---|
 | AuthenticationType |
Gets the type of authentication which should be used to authenticate REST service. Default value is basic authentication ("basic" constant). Other option is forms authentication ("forms" constant).
|
| DocumentAccessReadOnly |
Indicates whether the access to the documents is read-only. If true, only GET reguests are allowed.
|
| IsSynchronous |
Always true - we need synchronous behaviour for authentication.
|
| IsTranslation |
Indicates whether the qeury is translation query.
|
| ObjectAccessReadOnly |
Indicates whether the access to the objects is read-only. If true, only GET reguests are allowed.
|
| RESTServiceEnabled |
Indicates whether the REST service is enabled (in settings).
|
| ServiceTypeEnabled |
Gets the type of the service which is enabled (0 = Everything, 1 = Only objects, 2 = Only documents).
|
| TypeId | When implemented in a derived class, gets a unique identifier for this (Inherited from Attribute.Attribute.) |
See Also