Home > Class Reference > %SYS namespace > %SYS.OpenAM.IdentityServices

%SYS.OpenAM.IdentityServices

persistent class %SYS.OpenAM.IdentityServices extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %SYS_OpenAM.IdentityServices

This class represents an interface to an instance of OpenAM Enterprise Identity Web Services hosted by an application server.

Property Inventory

Method Inventory

Properties

property Name as %String [ Required ];
Name of this instance.
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Path as %String [ InitialExpression = "/opensso/identityservices" , Required ];
Path to OpenAM Identity Services on the application server hosting OpenAM Enterprise Identity Web Services.
Property methods: PathDisplayToLogical(), PathGet(), PathGetStored(), PathIsValid(), PathLogicalToDisplay(), PathLogicalToOdbc(), PathNormalize(), PathSet()
property Port as %Integer [ InitialExpression = 8080 , Required ];
TCP port that the application server hosting OpenAM Enterprise Identity Web Services is listening on.
Property methods: PortDisplayToLogical(), PortGet(), PortGetStored(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet(), PortXSDToLogical()
property SSLConfiguration as %String;
SSL client configuration to use when connecting to the application server hosting OpenAM Enterprise Identity Web Services. (optional)
Property methods: SSLConfigurationDisplayToLogical(), SSLConfigurationGet(), SSLConfigurationGetStored(), SSLConfigurationIsValid(), SSLConfigurationLogicalToDisplay(), SSLConfigurationLogicalToOdbc(), SSLConfigurationNormalize(), SSLConfigurationSet()
property Server as %String [ InitialExpression = "localhost" , Required ];
DNS name of the application server hosting OpenAM Enterprise Identity Web Services.
Property methods: ServerDisplayToLogical(), ServerGet(), ServerGetStored(), ServerIsValid(), ServerLogicalToDisplay(), ServerLogicalToOdbc(), ServerNormalize(), ServerSet()

Methods

method Authenticate(Username As %String, Password As %String) as %Boolean [ Language = objectscript ]
Authenticate the Username and Password, obtaining an internal transient security token if successful.
classmethod DeleteId(Name As %String) as %Status [ Language = objectscript ]
Allow a process with %Admin_Secure:U, but not %DB_IRISSYS:RW, to delete an OpenAMIdentityServices object. (A process with %DB_IRISSYS:RW can use %Save.)
classmethod Exists(Name As %String, ByRef OpenAMIdentityService As %ObjectHandle, ByRef Status As %Status) as %Boolean [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
Allow a process with %Admin_Secure:U, but not %DB_IRISSYS:RW, to save an OpenAMIdentityServices object. (A process with %DB_IRISSYS:RW can use %Save.)
method Test() as %Boolean [ Language = objectscript ]
Test whether this instance is correctly configured to use OpenAM Identity Web Services.

Queries

query List()
SQL Query:
SELECT Name,Server,Port,Path,SSLConfiguration FROM IdentityServices ORDER BY Name

Indexes

index (NameIndex on Name) [IdKey, Type = key];
Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (%SYS.OpenAM.IdentityServices)

^|$$$SecurityMapOpenAMIdentityServices|SYS("Security","OpenAMIdentityServicesD")(ID)
=
%%CLASSNAME
Server
Port
Path
SSLConfiguration
FeedbackOpens in a new window