org.ballerinalang.auth.ldap.util

Class LdapUtils

java.lang.Object

org.ballerinalang.auth.ldap.util.LdapUtils

public class LdapUtils
extends Object

Utility class for LDAP related common operations.

Since:

0.983.0

Constructor Summary

Constructors

Constructor and Description
LdapUtils()

Method Summary

Modifier and Type	Method and Description
static void	closeContext(DirContext dirContext) Closes the directory context.
static void	closeNamingEnumeration(NamingEnumeration<?> namingEnumeration) Closes the used NamingEnumerations to free up resources.
static Name	escapeDNForSearch(String dn) This method performs the additional level escaping for ldap search.
static String	escapeSpecialCharactersForFilter(String dnPartial) Escaping ldap search filter special characters in a string.
static String	getInstanceIdFromThreadLocal() Takes instance id of the service from the thread local.
static String	getNameInSpaceForUserName(String userName, String searchBase, String searchFilter, DirContext dirContext) Searches the corresponding name for a given username from LDAP.
static String	getNameInSpaceForUsernameFromLDAP(String userName, CommonLdapConfiguration ldapConfiguration, DirContext dirContext) This is to search user and retrieve ldap name directly from ldap.
static boolean	isLdapsUrl(String url) Check whether provided url is ldaps or not.
static boolean	isNullOrEmptyAfterTrim(String str) Checks whether a given string is null or empty after the trim.
static void	removeServiceName()
static void	setServiceName(String serviceName)
static String	substituteVariables(String value) Replace system property holders in the property values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LdapUtils

public LdapUtils()

Method Detail

isNullOrEmptyAfterTrim

public static boolean isNullOrEmptyAfterTrim(String str)

Checks whether a given string is null or empty after the trim.

Parameters:

str - String which needs to be check for null or empty

Returns:

true if the string is null or empty else false

getNameInSpaceForUsernameFromLDAP

public static String getNameInSpaceForUsernameFromLDAP(String userName,
                                                       CommonLdapConfiguration ldapConfiguration,
                                                       DirContext dirContext)
                                                throws UserStoreException,
                                                       NamingException

This is to search user and retrieve ldap name directly from ldap.

Parameters:

userName - Given username

ldapConfiguration - LDAP user store configurations

dirContext - Directory naming context

Returns:

Associated name for the given username

Throws:

UserStoreException - if there is any exception occurs during the process

NamingException - if there is any exception occurs during the process

getNameInSpaceForUserName

public static String getNameInSpaceForUserName(String userName,
                                               String searchBase,
                                               String searchFilter,
                                               DirContext dirContext)
                                        throws UserStoreException,
                                               NamingException

Searches the corresponding name for a given username from LDAP.

Parameters:

userName - Given username

searchBase - LDAP search base

searchFilter - LDAP search filter

dirContext - Directory naming context

Returns:

Associated name for the given username

Throws:

UserStoreException - if there is any exception occurs during the process

NamingException - if there is any exception occurs during the process

escapeDNForSearch

public static Name escapeDNForSearch(String dn)
                              throws InvalidNameException

This method performs the additional level escaping for ldap search. In ldap search / and " characters have to be escaped again.

Parameters:

dn - DN

Returns:

composite name

Throws:

InvalidNameException - failed to build composite name

closeContext

public static void closeContext(DirContext dirContext)
                         throws NamingException

Closes the directory context.

Parameters:

dirContext - directory context needs be closed

Throws:

NamingException - if a naming exception is encountered

closeNamingEnumeration

public static void closeNamingEnumeration(NamingEnumeration<?> namingEnumeration)
                                   throws NamingException

Closes the used NamingEnumerations to free up resources.

Parameters:

namingEnumeration - enumeration needs to be closed

Throws:

NamingException - if a naming exception is encountered

escapeSpecialCharactersForFilter

public static String escapeSpecialCharactersForFilter(String dnPartial)

Escaping ldap search filter special characters in a string.

Parameters:

dnPartial - String to replace special characters of

Returns:

String by replacing the special characters

isLdapsUrl

public static boolean isLdapsUrl(String url)

Check whether provided url is ldaps or not.

Parameters:

url - LDAP server url

Returns:

true if the url is an ldaps: url.

substituteVariables

public static String substituteVariables(String value)

Replace system property holders in the property values. e.g. Replace ${ballerina.home} with value of the ballerina.home system property.

Parameters:

value - string value to substitute

Returns:

String substituted string

getInstanceIdFromThreadLocal

public static String getInstanceIdFromThreadLocal()

Takes instance id of the service from the thread local.

Returns:

service instance id.

setServiceName

public static void setServiceName(String serviceName)

removeServiceName

public static void removeServiceName()