RESTSecurityInvoker MembersKentico 8.1 API Reference
The RESTSecurityInvoker type exposes the following members.
Constructors

  NameDescription
Public methodRESTSecurityInvoker
Back to 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.
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.
Public methodStatic memberAuthenticateUserForms
Authenticates the user from the authentication cookie. If everything is ok returns name of the authenticated user. Otherwise returns null;
Public methodOnlineEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodStatic memberGetAuthenticationType
Returns authentication type from settings.
Public methodOnlineGetHashCode
Returns the hash code for this instance.
(Inherited from OnlineAttribute.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
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.
Public methodInvoke
Invokes the operation only when authentication went well.
Public methodInvokeBegin
Not implemented method.
Public methodInvokeEnd
Not implemented method.
Public methodOnlineIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from OnlineAttribute.)
Public methodOnlineMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodValidate
Not needed, remains empty, does nothing.
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberHASH_AUTHENTICATED_USERNAME
Constant to identify the hash authentication requirement
Back to 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).
Public propertyOnlineTypeId
When implemented in a derived class, gets a unique identifier for this OnlineAttribute.
(Inherited from OnlineAttribute.)
Back to Top
See Also