Click or drag to resize
RESTSecurityInvoker Class
Security handler over the REST requests
Inheritance Hierarchy
SystemObject
  SystemAttribute
    CMS.WebServicesRESTSecurityInvoker

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 9.0.0
Syntax
C#
public class RESTSecurityInvoker : Attribute, 
	IOperationBehavior, IOperationInvoker

The RESTSecurityInvoker type exposes the following members.

Constructors
  NameDescription
Public methodRESTSecurityInvoker
Top
Fields
  NameDescription
Public fieldStatic memberBASIC_AUTHENTICATION_TYPE
Basic authentication
Public fieldStatic memberFORMS_AUTHENTICATION_TYPE
Forms authentication
Public fieldStatic memberHASH_AUTHENTICATED_USERNAME
Constant to identify the hash authentication requirement
Top
Properties
  NameDescription
Public propertyAuthenticationType
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).
Public propertyDocumentAccessReadOnly
Indicates whether the access to the documents is read-only. If true, only GET reguests are allowed.
Public propertyIsSynchronous
Always true - we need synchronous behaviour for authentication.
Public propertyIsTranslation
Indicates whether the qeury is translation query.
Public propertyObjectAccessReadOnly
Indicates whether the access to the objects is read-only. If true, only GET reguests are allowed.
Public propertyRESTServiceEnabled
Indicates whether the REST service is enabled (in settings).
Public propertyServiceTypeEnabled
Gets the type of the service which is enabled (0 = Everything, 1 = Only objects, 2 = Only documents).
Top
Methods
  NameDescription
Public methodAddBindingParameters
Not needed, remains empty, does nothing.
Public methodAllocateInputs
Calls AllocateInputs on the invoker.
Public methodApplyClientBehavior
Not needed, remains empty, does nothing.
Public methodApplyDispatchBehavior
Initializes the invoker.
Protected methodAuthenticateMembershipContextUserInternal
Authenticates the user from MembershipContext. If everything is ok returns name of the authenticated user. Otherwise returns null.
Public methodAuthenticateUser
Authenticates the user according to authentication type setting.
Public methodStatic memberAuthenticateUser(String)
Authenticates the user according to authentication type setting.
Public methodStatic memberAuthenticateUserBasic
Authenticates the user using basic authentication.
Protected methodAuthenticateUserBasicInternal
Authenticates the user using basic authentication.
Public methodStatic memberAuthenticateUserForms
Authenticates the user from the authentication cookie. If everything is ok returns name of the authenticated user. Otherwise returns null.
Protected methodAuthenticateUserFormsInternal
Authenticates the user from the authentication cookie. If everything is ok returns name of the authenticated user. Otherwise returns null.
Protected methodGetAuthenticatedUserNameInternal
Returns name of authenticated user.
Public methodStatic memberGetAuthenticationType
Returns authentication type from settings.
Public methodStatic memberHandleRESTAuthentication
Handles necessary actions to provide proper REST authentication response
Public methodStatic memberCheckHash
Checks hash parameter. Returns true if the parameter matches the requested URL. For request different from GET returns alsways false.
Protected methodCheckHashInternal
Checks hash parameter. Returns true if the parameter matches the requested URL. For request different from GET returns alsways false.
Public methodInvoke
Invokes the operation only when authentication went well.
Public methodInvokeBegin
Not implemented method.
Public methodInvokeEnd
Not implemented method.
Public methodValidate
Not needed, remains empty, does nothing.
Top
See Also