Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [LDAP] >  [OutboundAdapter]
Private  Storage   

class EnsLib.LDAP.OutboundAdapter extends Ens.OutboundAdapter

Deprecated. For new development use EnsLib.LDAP.Adapter.Outbound

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10 17


Summary

Properties
%CredentialsObj %Session %WarnedLatest BusinessHost
ConnectTimeout Connected Credentials DN
KeepaliveInterval LDAPPort LDAPServer RegistryID
SearchTimeout StayConnected UseSSL

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AddNewEntry AddNewEntryParmArray AssignOneSetting ClearAllAppData
ClearRuntimeAppData ClearStaticAppData Connect ConnectedSet
CredentialsSet DeleteEntry Disconnect EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GetEntryEditObj GetSettings
LDAPPortSet LDAPServerSet OnInit OnKeepalive
OnTearDown RenameEntry Search TestConnection
UseSSLSet isNetErr


Parameters

• parameter SETTINGS = "LDAPServer:Basic,LDAPPort:Basic,UseSSL,DN,Credentials:Basic:credentialsSelector,StayConnected,ConnectTimeout,SearchTimeout";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property %Session as %Net.LDAP.Client.Session;
This holds the LDAP Session connection
• property ConnectTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds to wait on each connection attempt
• property Connected as %Boolean [ InitialExpression = 0 ];
True if currently connected to LDAP server
• property Credentials as %String;
This is the ID name of the set of credentials values to be used to access the LDAP server.

The Username defined in your Credentials item may be either a fully qualified username, e.g. 'CUser@subdomain.mydomain.com', or an LDAP RDN (Relatively Distinguished Name) path to the user identity in the LDAP directory, e.g. 'CN=Carl User,OU=Users,OU=My Division,DC=subdomain,DC=mydomain,DC=com'

• property DN as %String(MAXLEN=1000);
Distinguished Name to use a a base for operations on the directory such as searches, updates and deletes.
• property LDAPPort as %Integer [ InitialExpression = 389 ];
• property LDAPServer as %String;
• property SearchTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds to wait on each Search attempt
• property StayConnected as %Numeric(MINVAL=-1) [ InitialExpression = -1 ];
If non-zero, stay connected to the remote system between handling Requests until idle for this number of seconds. A value of -1 means never disconnect.
• property UseSSL as %Boolean [ InitialExpression = 0 ];
Use SSL to connect to the LDAP server

Methods

• method AddNewEntry(pObjectClass As %String, pCN As %String, pBase As %String, pProps...) as %Status
• method AddNewEntryParmArray(pObjectClass As %String, pCN As %String, pBase As %String = ..DN, ByRef pProps=0) as %Status
• method Connect(pTimeout As %Numeric = 30) as %Status
Connect to the data source
• method ConnectedSet(pValue As %Boolean) as %Status
This is a Set accessor method for the Connected property.
• method DeleteEntry(pCN As %String, pBase As %String = ..DN) as %Status
• method Disconnect(pFinal As %Boolean = 0) as %Status
Disconnect from the datasource
• method GetEntryEditObj(Output pEditObj As %Net.LDAP.Client.EditEntry, pCN As %String, pBase As %String = ..DN) as %Status
• method LDAPPortSet(val As %Integer) as %Status
This is a Set accessor method for the LDAPPort property.
• method LDAPServerSet(val As %String) as %Status
This is a Set accessor method for the LDAPServer property.
• method OnInit() as %Status
This user callback method is called just after %OnNew()
• method OnKeepalive(pUnused As %Status) as %Status
This method is called from the Host.OnTask() method. It will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive().
• method OnTearDown() as %Status
This user callback method is called just before %OnClose()
• method RenameEntry(pCN As %String, pNewRDN As %String, pNewParent As %String = "", pDeleteOld As %Boolean = 1, pBase As %String = ..DN) as %Status
• method Search(Output pEntries As %Net.LDAP.Client.Entries, pScope As %Net.LDAP.Client.Search.Scope = 2, pFilter As %String = "", pAttrs As %String = "", pMaxItems As %Integer = 250, pBase As %String = ..DN) as %Status
pScope: 0=search base, 1=search one level, 2=search subtree pFilter: the search criteria (see RFC2254). pAttrs: comma-separated list of attributes to return per found entry.
• method TestConnection()
• method UseSSLSet(val As %Boolean) as %Status
This is a Set accessor method for the UseSSL property.
• classmethod isNetErr(tErrorText) as %Boolean
Decide whether an error code returned from the driver represents a disconnection implying the need to re-connect. Override this method in a subclass if you encounter errors with another server that ought to be in this list. Also please ask the InterSystems IRIS developers to add your new codes to the base version.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.