OAuth2.ResourceServer.Mapping
persistent class OAuth2.ResourceServer.Mapping extends %Library.Persistent
SQL Table Name: OAuth2_ResourceServer.Mapping
The OAuth2.ResourceServer.Mapping class is used to determine which OAuth2.ResourceServer definition to use for a given connection. Each instance represents a mapping of the specified Service and Key with the specified Resource (instance of OAuth2.ResourceServer). Service can be either "%Service_WebGateway" for Web Gateway connection or "%Service_Bindings" for xDBC connections. For Web Gateway connections Key specifies the Web Application name, and for xDBC connection it specifies the Namespace. In either case it can be "*", which indicates that this is the default mapping for the given Service.Property Inventory
Method Inventory
Parameters
parameter RESOURCEREQUIRED;
Properties
property Key as %String (MAXLEN = 64) [ Required ];
Key to use for this mapping. This can be "*" to indicate that this is the default mapping
for this Service. Otherwise, for Web Gateway mappings this will be
the Web Application name and for xDBC mappings it will be the namespace.
Property methods: KeyDisplayToLogical(), KeyGet(), KeyGetStored(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property Resource as OAuth2.ResourceServer [ Required ];
The OAuth2.ResourceServer to use for this Service and
Key combination.
Property methods: ResourceGet(), ResourceGetObject(), ResourceGetObjectId(), ResourceGetStored(), ResourceGetSwizzled(), ResourceIsValid(), ResourceNewObject(), ResourceSet(), ResourceSetObject(), ResourceSetObjectId(), ResourceUnSwizzle()
property Service as %String [ Required ];
The Service for this mapping. Valid values are "%Service_WebGateway" and "%Service_Bindings".
Property methods: ServiceDisplayToLogical(), ServiceGet(), ServiceGetStored(), ServiceIsValid(), ServiceLogicalToDisplay(), ServiceLogicalToOdbc(), ServiceNormalize(), ServiceSet()
Methods
classmethod Create(service As %String, key As %String, resource As OAuth2.ResourceServer) as %Status
Create a new mapping with the given service, key and resource values.
Delete the mapping with the given service and key values.
classmethod Exists(service As %String, key As %String, ByRef mapping As OAuth2.ResourceServer.Mapping, ByRef status As %Status) as %Boolean
Check if a mapping with the given service and key values exists. If it does, the object instance will be returned in mapping.
If the mapping does not exist, an error will be returned in status.
Returns true if the mapping exists, and false if it does not.
Returns true if the mapping exists, and false if it does not.
classmethod Modify(service As %String, key As %String, resource As OAuth2.ResourceServer) as %Status
Modify an existing mapping with the given service, key and resource values.
Queries
query List()
SQL Query:
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping ORDER BY Service, Key
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping ORDER BY Service, Key
query ListByResource(resource As %String)
SQL Query:
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping WHERE Resource=:resource ORDER BY Key
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping WHERE Resource=:resource ORDER BY Key
query ListByService(service As %String)
SQL Query:
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping WHERE Service=:service ORDER BY Key
SELECT Service, Key, Resource FROM OAuth2_ResourceServer.Mapping WHERE Service=:service ORDER BY Key
Indexes
index (ServiceKey on Service,Key) [IdKey, Type = key];
Index methods: ServiceKeyCheck(), ServiceKeyDelete(), ServiceKeyExists(), ServiceKeyOpen(), ServiceKeySQLCheckUnique(), ServiceKeySQLExists(), ServiceKeySQLFindPKeyByConstraint(), ServiceKeySQLFindRowIDByConstraint()
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()