IdentityServices Class Reference

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

Inheritance diagram for IdentityServices:

Collaboration diagram for IdentityServices:

Public Member Functions
_.Library.Boolean	Authenticate (_.Library.String Username, _.Library.String Password)
	Authenticate the Username and Password, obtaining an internal transient security token if successful.
_.Library.Status	Save ()
	Allow a process with Admin_Secure:U, but not DB_IRISSYS:RW, to save an OpenAMIdentityServices object. More...
_.Library.Boolean	Test ()
	Test whether this instance is correctly configured to use OpenAM Identity Web Services.

Static Public Member Functions
_.Library.Status	DeleteId (_.Library.String Name)
	Allow a process with Admin_Secure:U, but not DB_IRISSYS:RW, to delete an OpenAMIdentityServices object. More...
_.Library.Boolean	Exists (_.Library.String Name, _.Library.ObjectHandle OpenAMIdentityService, _.Library.Status Status)
	OpenAMIdentityService exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String OpenAMIdentityServices)
	This method exports OpenAMIdentityService records to a file in xml format. More...
_.Library.Status	GetProperties (_.Library.ObjectHandle OpenAMIdentityService, _.Library.String Properties)
	Get a OpenAMIdentityService's properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import OpenAMIdentityService records from an xml file. More...
_.Library.Status	Modify (_.Library.String Name, _.Library.String Properties)
	Modify a OpenAMIdentityService. More...

Public Attributes
	Name
	Name of this instance. More...
	Path
	Path to OpenAM Identity Services on. More...
	Port
	TCP port that. More...
	SSLConfiguration
	SSL client configuration to use when connecting to. More...
	Server
	DNS name of. More...

Detailed Description

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

Member Function Documentation

DeleteId()

_.Library.Status DeleteId ( _.Library.String  Name )

static

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.)

Exists()

_.Library.Boolean Exists ( _.Library.String  Name, _.Library.ObjectHandle  OpenAMIdentityService, _.Library.Status  Status  )

static

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<br>
If Value of the method = 1 (OpenAMIdentityService exists)
OpenAMIdentityService = Object handle to OpenAMIdentityService
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  OpenAMIdentityServices  )

static

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

GetProperties()

_.Library.Status GetProperties ( _.Library.ObjectHandle  OpenAMIdentityService, _.Library.String  Properties  )

static

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

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

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

Modify()

_.Library.Status Modify ( _.Library.String  Name, _.Library.String  Properties  )

static

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.

Save()

_.Library.Status Save

(

)

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.)

Member Data Documentation

Name

Name

Name of this instance.

 

Path

Path

Path to OpenAM Identity Services on.

the application server hosting OpenAM Enterprise Identity Web Services.  

Port

Port

TCP port that.

the application server hosting OpenAM Enterprise Identity Web Services is listening on.  

SSLConfiguration

SSLConfiguration

SSL client configuration to use when connecting to.

the application server hosting OpenAM Enterprise Identity Web Services. (optional)  

Server

Server

DNS name of.

the application server hosting OpenAM Enterprise Identity Web Services.