build
String  build

Returns the current version (major, minor, build)

Returns
String  build String

Supported Clients
SmartClient

buildDate
Date  buildDate

Returns date release date

Returns
Date  date Date

Supported Clients
SmartClient

component
String  component

Returns the component name

Returns
String  name String

Supported Clients
SmartClient

licensee
String  licensee

Returns the licensee

Returns
String  licensee String

Supported Clients
SmartClient

typeLicensed
String  typeLicensed

Returns the type that is valid for this license

Returns
String  type String

Supported Clients
SmartClient

version
Number  version

Returns the current version (major, minor)

Returns
Number  version Double

Supported Clients
SmartClient

versionLicensed
String  versionLicensed

Returns the version that is valid for this license

Returns
String  license String

Supported Clients
SmartClient

getConnection
ILConnection  getConnection( String, String, String, Object, Object )

Get a connection map with the correct parameters to connect to a LDAP server.

Parameters
String  host  the host
String  login  the login
String  password  the password
Object  port  the port
Object  version  the version

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getConnection
ILConnection  getConnection( String )

Get a connection map with the correct parameters to connect to a LDAP server.

Parameters
String  host  the host

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getConnection
ILConnection  getConnection( String, Object )

Get a connection map with the correct parameters to connect to a LDAP server.

Parameters
String  host  the host
Object  port  the port

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getConnection
ILConnection  getConnection( String, String, String, Object )

Get a connection map with the correct parameters to connect to a LDAP server.

Parameters
String  host  the host
String  login  the login
String  password  the password
Object  port  the port

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getConnection
ILConnection  getConnection( String, String, String )

Get a connection map with the correct parameters to connect to a LDAP server.

Parameters
String  host  the host
String  login  the login
String  password  the password

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getDataSet
JSDataSet  getDataSet( String, String, ILConnection, Number, Array<String> )

Get the complete or filtered BEDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Number  scope  the search scope
Array<String>  arguments  the return arguments

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, ILConnection, Number )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Number  scope  the search scope

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, String, ILConnection )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, ILConnection )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, String, ILConnection, Array<String> )

Get the complete or filtered BEDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Array<String>  arguments  the return arguments

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, ILConnection, Number, Array<String> )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Number  scope  the search scope
Array<String>  arguments  the return arguments

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, ILConnection, Array<String> )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Array<String>  arguments  the return arguments

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getDataSet
JSDataSet  getDataSet( String, String, ILConnection, Number )

Get the complete or filtered JSDataSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Number  scope  the search scope

Returns
JSDataSet  set JSDataSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered JSDataSet for the given baseDN.
// This is an example of how to find a group and its members in an Active Directory
// The group we search in is the group Manager
var set = plugins.it2be_ldapclient.getDataSet(
"cn=Users,dc=office,dc=it2be,dc=com",
connection);

// When something went wrong with the search the LDAPSet will be returned empty
if (set != null) {
var output = set.getAsText(",", "\n", "", true);

application.output(set.getAsText(",", "\n", "", true));
} else {
output = "No connection possible.";
}

globals.contact = output;

getLDAPSet
ILSet  getLDAPSet( String, ILConnection, Number, Array<String> )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Number  scope  the search scope
Array<String>  arguments  the return arguments

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, String, ILConnection, Number, Array<String> )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Number  scope  the search scope
Array<String>  arguments  the return arguments

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, String, ILConnection )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, ILConnection, Array<String> )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Array<String>  arguments  the return arguments

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, String, ILConnection, Number )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Number  scope  the search scope

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, String, ILConnection, Array<String> )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
String  filter  the filter
ILConnection  connection  the connection
Array<String>  arguments  the return arguments

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, ILConnection, Number )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection
Number  scope  the search scope

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getLDAPSet
ILSet  getLDAPSet( String, ILConnection )

Get the complete or filtered LDAPSet for the given baseDN.

Parameters
String  baseDN  the base dn
ILConnection  connection  the connection

Returns
ILSet  set ILSet

Supported Clients
SmartClient

Sample

// Get the complete or filtered LDAPSet for the given baseDN.
// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");
//
// var connection = plugins.it2be_ldapclient.getSSLConnection("xxx.xxx.xxx.xxx");
// Retrieve a set of contacts in the chosen base directory
// Usage:   plugin.getLDAPSet(
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
        
         
         
           ) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(objectclass=*)" connection) // Example: plugin.getLDAPSet("ou=sales,o=it2be" "(uid=*)" connection) // REMARK: Many more options are available. For more information on search filters the next link might be a // good source of information: http:// confluence.atlassian.com/display/DEV/How+to+write+a+LDAP+search+filter // var set = plugins.it2be_ldapclient.getLDAPSet("cn=users,dc=server,dc=ldap,dc=it2be,dc=com", connection); // Search using a filter var set = plugins.it2be_ldapclient.getLDAPSet( "cn=users,dc=server,dc=ldap,dc=it2be,dc=com", "(uid=*)", connection); // When something went wrong with the search the LDAPSet will be returned empty if (set != null) { var output = "" // Loop through the LDAPSet for (var i = 1 ; i < set.getSize() ; i++) { // Set the selected index of the found LDAPSet set.setSelectedIndex(i); if (i == 1) { // Proof of what a raw output results to application.output(set.getRaw()); } // Retrieve the contact record var contact = set.getContact(); // Output entries by name output += "UID: " + contact.getUID() + "\n"; output += "Full name: " + contact.getFullName() + "\n"; output += "Password: " + contact.getUserPassword() + "\n"; // Output entries by variable name output += "Home directory: " + contact.getValue("homeDirectory") + "\n"; output += "-----" + "\n"; } } else { output = "No connection possible."; } application.output(output); 
          
         
       

getSSLConnection
ILConnection  getSSLConnection( String )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getSSLConnection
ILConnection  getSSLConnection( String, String )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host
String  login  the login

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getSSLConnection
ILConnection  getSSLConnection( String, String, String, String, Object, Object )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host
String  login  the login
String  password  the password
String  keystorePath  the keystore path
Object  port  the port
Object  version  the version

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getSSLConnection
ILConnection  getSSLConnection( String, String, String, String, Object )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host
String  login  the login
String  password  the password
String  keystorePath  the keystore path
Object  port  the port

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getSSLConnection
ILConnection  getSSLConnection( String, String, String )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host
String  login  the login
String  password  the password

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

getSSLConnection
ILConnection  getSSLConnection( String, String, String, String )

Get a connection map with the correct parameters to connect to a LDAP server over SSL.

Parameters
String  host  the host
String  login  the login
String  password  the password
String  keystorePath  the keystore path

Returns
ILConnection  connection ILConnection

Supported Clients
SmartClient

Sample

// Get a connection map with the correct parameters to connect to a LDAP server over SSL.
// The LDAPclient Plug-in was tested against Open Ldap, MS Active Directory and Novell eDirectory

// First create your connection Object
// The connection is not an actual connection but more a collection of definitions to connect to the LDAP server.
// Options are a 'simple' connection and a secure connection over SSL
// Parameters simple: host,login,password,port,version
// Parameters secure: host,login,password,port,keystore,version

// IMPORTANT: especially the login and keystore need special attention.
// A login often includes the attribute name like 'uid='name'. You may also need to append the complete base DN
// The KeyStore is a full path to a KeyStore file nescessary to make a 'trusted connection over SSL
// A Keystore file is normally pushed to a connecting machine when you use a program like jxplorer or ldapbrowser
// Both applications are free and are excellent to test your settings.

// Create the settings for a simple and anonymous connection
var connection = plugins.it2be_ldapclient.getConnection(
"000.000.000.000");

// Create the settings for a connection
var connection = plugins.it2be_ldapclient.getSSLConnection(
"000.000.000.000",
"cn=sysop,o=sys",
"password",
"/Path/To/KeyStore/File");

isAuthorizedUser
Boolean  isAuthorizedUser( ILConnection, ILConnection )

Check that the user is Authorized. Parameters: (admin)connection, optional userconnection (simplebind).

Parameters
ILConnection  connection  the connection
ILConnection  userConnection  the user connection

Returns
Boolean  authorized boolean

Supported Clients
SmartClient

Sample

// Check that the user is Authorized. Parameters: (admin)connection, optional userconnection (simplebind).
// Example of secure login to an OpenLDAP Server
var host = "000.000.000.000";
// The baseDN format for openSSL
var login = "uid=" + globals.login + ",cn=users,dc=server,dc=ldap,dc=it2be,dc=com";
// The password
var password = globals.password;
// The keystore (full path)
var keyStorePath = "/Path/To/KeyStore/File";

// Create the settings for a secure connection
var connection = plugins.it2be_ldapclient.getConnection(
host,
login,
password,
keyStorePath);

var result = plugins.it2be_ldapclient.isAuthorizedUser(connection);

if (result) {
globals.result = "
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       This person is allowed to log in!"; } else { globals.result = " 
         
         
           This person is not allowed to log in!"; } 
          
        
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      

isAuthorizedUser
Boolean  isAuthorizedUser( ILConnection )

Check that the user is Authorized. Parameters: (admin)connection, optional userconnection (simplebind).

Parameters
ILConnection  connection  the connection

Returns
Boolean  authorized boolean

Supported Clients
SmartClient

Sample

// Check that the user is Authorized. Parameters: (admin)connection, optional userconnection (simplebind).
// Example of secure login to an OpenLDAP Server
var host = "000.000.000.000";
// The baseDN format for openSSL
var login = "uid=" + globals.login + ",cn=users,dc=server,dc=ldap,dc=it2be,dc=com";
// The password
var password = globals.password;
// The keystore (full path)
var keyStorePath = "/Path/To/KeyStore/File";

// Create the settings for a secure connection
var connection = plugins.it2be_ldapclient.getConnection(
host,
login,
password,
keyStorePath);

var result = plugins.it2be_ldapclient.isAuthorizedUser(connection);

if (result) {
globals.result = "
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       This person is allowed to log in!"; } else { globals.result = " 
         
         
           This person is not allowed to log in!"; } 
          
        
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      

register
Boolean  register( String )

Register your runtime license (use the Components Manager to request your license string)

Parameters
String  license  the license

Returns
Boolean  result boolean

Supported Clients
SmartClient

Sample

// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_ldapclient.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");