HS.Util.RESTCSPConfig
persistent class HS.Util.RESTCSPConfig extends %Library.Persistent, %XML.Adaptor
SQL Table Name: HS_Util.RESTCSPConfig
Defines settings that control some REST CSP application behaviors that otherwise are only configurable via %CSP.REST class parameter overrides and/or method overrides. These generally apply to FHIR APIs, but may be used for other REST services as well. In non-FHIR cases, CallbackClass and OAuthClientName are more relevant than the other settings.Property Inventory
- AllowUnauthenticatedAccess
- AppData
- CallbackClass
- DisableCORS
- InitialNamespace
- OAuthClientName
- ServiceClassName
- ServiceConfigName
- URL
Method Inventory
Properties
property AllowUnauthenticatedAccess as %Boolean [ InitialExpression = 0 ];
Indicates whether to accept requests with no user authentication. If false, then
any request without an HTTP Authorization header is rejected with HTTP 401)
Property methods: AllowUnauthenticatedAccessDisplayToLogical(), AllowUnauthenticatedAccessGet(), AllowUnauthenticatedAccessGetStored(), AllowUnauthenticatedAccessIsValid(), AllowUnauthenticatedAccessLogicalToDisplay(), AllowUnauthenticatedAccessLogicalToXSD(), AllowUnauthenticatedAccessNormalize(), AllowUnauthenticatedAccessSet(), AllowUnauthenticatedAccessXSDToLogical()
property AppData as array of %String;
Property Bag for Application-Specific properties.
Property methods: AppDataBuildValueArray(), AppDataCollectionToDisplay(), AppDataCollectionToOdbc(), AppDataDisplayToCollection(), AppDataDisplayToLogical(), AppDataGet(), AppDataGetObject(), AppDataGetObjectId(), AppDataGetStored(), AppDataGetSwizzled(), AppDataIsValid(), AppDataLogicalToDisplay(), AppDataLogicalToOdbc(), AppDataNormalize(), AppDataOdbcToCollection(), AppDataSet(), AppDataSetObject(), AppDataSetObjectId()
property CallbackClass as %Dictionary.Classname [ InitialExpression = "HS.Util.RESTHandlerBase" ];
Callback class for ZAUTHENTICATE-related entry points.
Expected to implement HS.Util.IAuthenticate.
Commonly: HS.Util.RESTHandlerBase for OAuth 2.0 bearer token authentication; HSMOD.SAML.SP.AuthCallback for SAML responses.
Expected to implement HS.Util.IAuthenticate.
Commonly: HS.Util.RESTHandlerBase for OAuth 2.0 bearer token authentication; HSMOD.SAML.SP.AuthCallback for SAML responses.
Property methods: CallbackClassGet(), CallbackClassGetStored(), CallbackClassIsValid(), CallbackClassSet()
property DisableCORS as %Boolean [ InitialExpression = 0 ];
Disable any handling of CORS headers for this URL. By default, FHIR end points have CORS processing ON.
Property methods: DisableCORSDisplayToLogical(), DisableCORSGet(), DisableCORSGetStored(), DisableCORSIsValid(), DisableCORSLogicalToDisplay(), DisableCORSLogicalToXSD(), DisableCORSNormalize(), DisableCORSSet(), DisableCORSXSDToLogical()
property InitialNamespace as %String [ InitialExpression = $Namespace , Transient ];
Namespace in which this instance was created
Property methods: InitialNamespaceDisplayToLogical(), InitialNamespaceGet(), InitialNamespaceIsValid(), InitialNamespaceLogicalToDisplay(), InitialNamespaceLogicalToOdbc(), InitialNamespaceNormalize(), InitialNamespaceSet()
property OAuthClientName as %String (MAXLEN = 512);
When using OAuth 2.0, this is OAuth 2.0 Client name to be used by the resource server.
Property methods: OAuthClientNameDisplayToLogical(), OAuthClientNameGet(), OAuthClientNameGetStored(), OAuthClientNameIsValid(), OAuthClientNameLogicalToDisplay(), OAuthClientNameLogicalToOdbc(), OAuthClientNameNormalize(), OAuthClientNameSet()
property ServiceClassName as %String (MAXLEN = 512);
Class name of the FHIR business service to which to dispatch all incoming requests.
Property methods: ServiceClassNameDisplayToLogical(), ServiceClassNameGet(), ServiceClassNameGetStored(), ServiceClassNameIsValid(), ServiceClassNameLogicalToDisplay(), ServiceClassNameLogicalToOdbc(), ServiceClassNameNormalize(), ServiceClassNameSet()
property ServiceConfigName as %String (MAXLEN = 512);
Config item name of the FHIR business service to which to dispatch all incoming requests.
Property methods: ServiceConfigNameDisplayToLogical(), ServiceConfigNameGet(), ServiceConfigNameGetStored(), ServiceConfigNameIsValid(), ServiceConfigNameLogicalToDisplay(), ServiceConfigNameLogicalToOdbc(), ServiceConfigNameNormalize(), ServiceConfigNameSet()
property URL as %String (MAXLEN = 1024) [ Required ];
URL of the REST end point, should represent the name of an existing CSP application.
Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()
Methods
classmethod GetConfigForContext() as HS.Util.RESTCSPConfig
Gets the correct instance of HS.Util.RESTCSPConfig for the current %request context.
Returns $$$NULLOREF if there is no REST configuration for the current context.
Returns $$$NULLOREF if there is no REST configuration for the current context.
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (URLIndex on URL) [Unique];
Index methods: URLIndexCheck(), URLIndexCheckUnique(), URLIndexDelete(), URLIndexExists(), URLIndexOpen(), URLIndexSQLCheckUnique(), URLIndexSQLExists(), URLIndexSQLFindPKeyByConstraint(), URLIndexSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (HS.Util.RESTCSPConfig)
^HS.Util.RESTCSPConfigD(ID,"AppData",n) |
= | AppData(n) |
Storage Model: Storage (HS.Util.RESTCSPConfig)
^HS.Util.RESTCSPConfigD(ID) |
= | %%CLASSNAME
URL
ServiceConfigName
ServiceClassName
OAuthClientName
AllowUnauthenticatedAccess
DisableCORS
CallbackClass
|