persistent class %SYS.OpenAM.IdentityServices
extends %Persistent, %XML.Adaptor
This class represents an interface to an instance of OpenAM Enterprise
Identity Web Services hosted by an application server.
• property Name
as %String [ Required ];
Name of this instance.
• property Path
as %String [ InitialExpression = "/opensso/identityservices",Required ];
Path to OpenAM Identity Services on
the application server hosting OpenAM Enterprise Identity Web Services.
• property Port
as %Integer [ InitialExpression = 8080,Required ];
TCP port that
the application server hosting OpenAM Enterprise Identity Web Services
is listening on.
• property SSLConfiguration
as %String;
SSL client configuration to use when connecting to
the application server hosting OpenAM Enterprise Identity Web Services.
(optional)
• property Server
as %String [ InitialExpression = "localhost",Required ];
DNS name of
the application server hosting OpenAM Enterprise Identity Web Services.
• method Authenticate(Username As %String, Password As %String)
as %Boolean
Authenticate the Username and Password, obtaining an internal transient security token if successful.
• classmethod DeleteId(Name As %String)
as %Status
Allow a process with %Admin_Secure:U, but not %DB_CACHESYS:RW, to delete an OpenAMIdentityServices object.
(A process with %DB_CACHESYS:RW can use %Save.)
• classmethod Exists(Name As %String, ByRef OpenAMIdentityService As %ObjectHandle, ByRef Status As %Status)
as %Boolean
OpenAMIdentityService exists.
This method checks for the existence of a OpenAMIdentityService in the security database.
Parameters:
Name - Name of the OpenAMIdentityService to check existence of
Return values:
If Value of the method = 0 (OpenAMIdentityService does not exist, or some error occured)
OpenAMIdentityService = Null
Status = OpenAMIdentityService "x" does not exist, or other error message
If Value of the method = 1 (OpenAMIdentityService exists)
OpenAMIdentityService = Object handle to OpenAMIdentityService
Status = $$$OK
• classmethod Export(FileName As %String = "OpenAMIdentityServicesExport.xml", ByRef NumExported As %Integer, OpenAMIdentityServices As %String = "*")
as %Status
This method exports OpenAMIdentityService records to a file in xml format.
Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
OpenAMIdentityServices - Comma separated list of OpenAMIdentityServices to export, "*" = All
• classmethod GetProperties(OpenAMIdentityService As %ObjectHandle, ByRef Properties As %String)
as %Status
Get a OpenAMIdentityService's properties.
Gets a OpenAMIdentityServices's properties from the security database.
Parameters:
OpenAMIdentityService - Object handle to a OpenAMIdentityServices record
Return values:
Properties - See the Get method for more information on properties returned
• classmethod Import(FileName As %String = "OpenAMIdentityServicesExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0)
as %Status
Import OpenAMIdentityService records from an xml file.
Parameters:
FileName - Filename to import OpenAMIdentityService records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported
• classmethod Modify(Name As %String, ByRef Properties As %String)
as %Status
Modify a OpenAMIdentityService.
Modify an existing OpenAMIdentityService's properties in the security database.
Parameters:
Name - Name of the OpenAMIdentityService to modify
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array,
the value is not modified.
• method Save()
as %Status
Allow a process with %Admin_Secure:U, but not $DB_CACHESYS:RW, to save an OpenAMIdentityServices object.
(A process with %DB_CACHESYS:RW can use %Save.)
• method Test()
as %Boolean
Test whether this instance is correctly configured to use OpenAM Identity Web Services.
• query List()
SQL Query
:
SELECT Name,Server,Port,Path,SSLConfiguration FROM IdentityServices
ORDER BY Name
• index (NameIndex on Name) [IdKey];
