com.actional.security.plugin

Interface ILdapSettings

public interface ILdapSettings

LDAP settings interface.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
IUsernamePasswordCredential	getAdminCredential() Returns the LDAP server administration credential.
java.lang.String[]	getAuthnAttribs() Returns the list of additional attributes to retrieve from LDAP for each user upon authentication.
java.lang.String	getBaseSearchDN() Returns the base DN where all the searches will start from.
int	getCacheTimeoutMin() Returns the time in minutes before SOAPstation should refreshed the cached data from LDAP.
ICertificateMapping[]	getCertificateMappings() Returns the LDAP certificate mappings for this server
java.lang.String	getDNAttributeName() Return the LDAP DistinguishName attribute name for the server
java.lang.String	getHost() Returns the LDAP server host name or IP address.
int	getMaxConnections() Retrieves the number of maxinum connections to the LDAP server
int	getPort() Returns the port on the host machine where the LDAP server is running on.
java.lang.String	getPseudoPasswordAttribute() Returns the LDAP attribute that contains the pseudo password to validate the user instead of the real user LDAP password.
int	getQueryTimeoutSec() Retrieves the query timeout.
java.lang.String	getSSLClientCertificateAlias() Returns the SSL client certificate alias to be used for SSL mutual authentication.
java.lang.String	getType() Returns the LDAP directory service type.
boolean	getUseLDAPCaching() Returns the status that indicates if the information from LDAP should be cached or not when using SOAPstation LDAP implementation.
boolean	getUsePseudoPassword() Returns the LDAP attribute that contains the pseudo password to validate the user instead of the real user LDAP password.
boolean	getUseSSL() Returns the flag determining if SSL is to be used to connect to the server

Method Detail

getType

java.lang.String getType()

Returns the LDAP directory service type. See IDirectoryServiceTypes for the supported types..

getHost

java.lang.String getHost()

Returns the LDAP server host name or IP address.

Returns:

The host machine name or IP where the LDAP server is running on.

getPort

int getPort()

Returns the port on the host machine where the LDAP server is running on.

Returns:

The port number of the LDAP server.

getAdminCredential

IUsernamePasswordCredential getAdminCredential()

Returns the LDAP server administration credential.

Returns:

Administrator credential

getBaseSearchDN

java.lang.String getBaseSearchDN()

Returns the base DN where all the searches will start from.

Returns:

Fully qualified search DN

getUseLDAPCaching

boolean getUseLDAPCaching()

Returns the status that indicates if the information from LDAP should be cached or not when using SOAPstation LDAP implementation. Caching LDAP information will improve performance but can introduce information inconsistency between LDAP and the cached information. The elapsed time where the cached information should be updated from LDAP is control by getCacheTimeoutMin().

Returns:

true if the data from LDAP should be cached.

getCacheTimeoutMin

int getCacheTimeoutMin()

Returns the time in minutes before SOAPstation should refreshed the cached data from LDAP. This field is only relevant when getUseLDAPCaching() is set to true.

Returns:

time in minutes

getMaxConnections

int getMaxConnections()

Retrieves the number of maxinum connections to the LDAP server

Returns:

number of maxinum connections

getQueryTimeoutSec

int getQueryTimeoutSec()

Retrieves the query timeout.

Returns:

timeout in seconds

getDNAttributeName

java.lang.String getDNAttributeName()

Return the LDAP DistinguishName attribute name for the server

Returns:

String of the LDAP DN attribute name

getUsePseudoPassword

boolean getUsePseudoPassword()

Returns the LDAP attribute that contains the pseudo password to validate the user instead of the real user LDAP password.

Returns:

String of the LDAP attribute of the user schema

getPseudoPasswordAttribute

java.lang.String getPseudoPasswordAttribute()

Returns the LDAP attribute that contains the pseudo password to validate the user instead of the real user LDAP password.

Returns:

String of the LDAP attribute of the user schema

getAuthnAttribs

java.lang.String[] getAuthnAttribs()

Returns the list of additional attributes to retrieve from LDAP for each user upon authentication.

Returns:

the LDAP attributes to retrieve.

getCertificateMappings

ICertificateMapping[] getCertificateMappings()

Returns the LDAP certificate mappings for this server

Returns:

instances of the certificate mappings

getUseSSL

boolean getUseSSL()

Returns the flag determining if SSL is to be used to connect to the server

Returns:

true if the connection to LDAP will use SSL.

getSSLClientCertificateAlias

java.lang.String getSSLClientCertificateAlias()

Returns the SSL client certificate alias to be used for SSL mutual authentication.

Returns:

SSL client certificate alias