HSMOD.Authentication.RESTSession.API
class HSMOD.Authentication.RESTSession.API extends HSMOD.REST.Base
base class for applications to derive a REST authentication API. If there are any additions to the UrlMap, the UrlMap XData block should be copied into the subclass and added to.
@API.ExtensibleMethod Inventory
Parameters
default behavior is to disallow unknown users. Subclasses can override this.
@API.Parameter @API.OverrideableMethods
callback for instantiating the response object to be returned by UserStatus(). Can be overridden if an extension class needs to return a subclass of HSMOD.Authentication.RESTSession.Auxil.UserStatus.
@API.OverrideableCallback method for subclasses to override if any extra handling needs to be applied to the output status object for UserStatus(). This is called by the UserStatus method after populating standard properties of the response object, but before serializing to JSON.
@API.Overrideable/login
resource. Note that reaching this method implies that the user is already logged in.Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %Identity()
- %IsA()
- %Namespace()
- %New()
- %OriginalNamespace()
- %PackageName()
- %Ping()
- %SetModified()
- %Version()
- AcceptsContentType()
- AccessCheck()
- CheckSinglePermission()
- ConvertParameter()
- Decrypt()
- DispatchRequest()
- DrawCSS3STYLE()
- DrawHEAD()
- DrawSTHEAD()
- DrawSTTitle()
- DrawSTYLE()
- DrawTitle()
- DrawTitleSection()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- ExtractServerError()
- GenerateCsrfSessionToken()
- GetAuthChallenge()
- HandleRESTRequestResponseProblem()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- Login()
- ManageSessionVerification()
- OnErrorSetup()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnLoginPage()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreDispatch()
- OnPreHTTP()
- OnPreHyperEvent()
- OnSecurityTokenPage()
- OutputServerErrorToJSON()
- Page()
- QuoteJS()
- ReportHttpStatusCode()
- RewriteURL()
- SetResponseHeaderIfEmpty()
- ShowError()
- SimpleRESTRequestResponse()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- VerifySession()
- checkPermissions()
- httpStatusResponse()