HS.HC.RESTBase.ServicesHandler
abstract class HS.HC.RESTBase.ServicesHandler extends HS.REST.Handler
Base dispatch class for external services.Method Inventory
- AuthenticationStrategy()
- CheckHCResourcePermitted()
- CheckResourcePermitted()
- GetUserResource()
- Supports()
Methods
final classmethod AuthenticationStrategy() as %Dictionary.Classname
Lock down as final to enforce this strategy.
abstract classmethod CheckHCResourcePermitted(resourceClass As %Dictionary.Classname) as %Boolean
Subclasses MUST override this method to specify which resource classes are allowed
as part of the API.
final classmethod CheckResourcePermitted(resourceClass As %Dictionary.Classname) as %Boolean
Includes base REST resources for EVERY UI to include.
Lock down as final to ensure these resources are always included.
final classmethod GetUserResource(pFullUserInfo As %DynamicObject) as %pkg.isc.rest.authentication.platformUser
Lock down as final to enforce this user context.
final classmethod Supports(pEndpoint As %String, pHTTPVerb As %String, pRequest As %CSP.Request = $$$NULLOREF) as %Boolean
Lock down to only support endpoints needed.
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- AcceptsContentType()
- AccessCheck()
- BuildDocumentationEndpoint()
- CheckAllPermissions()
- CheckPermission()
- CollectionQuery()
- ConsoleBuildOpenAPIDocumentation()
- Construct()
- ConvertParameter()
- Create()
- Decrypt()
- Delete()
- DispatchClassAction()
- DispatchInstanceAction()
- DispatchRequest()
- DrawCSS3STYLE()
- DrawHEAD()
- DrawSTHEAD()
- DrawSTTitle()
- DrawSTYLE()
- DrawTitle()
- DrawTitleSection()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- GetAuthChallenge()
- GetDocumentationBuildStatus()
- GetOpenAPISpecification()
- GetUserContext()
- GetUserInfo()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- IsPublic()
- Link()
- LogErrorStatus()
- LogOut()
- Login()
- ModifyOpenAPISpecification()
- OnErrorSetup()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnLoginPage()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreDispatch()
- OnPreHTTP()
- OnPreHyperEvent()
- OnSecurityTokenPage()
- Page()
- QuoteJS()
- Retrieve()
- RewriteURL()
- SetLogLevel()
- SetResponseHeaderIfEmpty()
- ShowError()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- Update()