com.rli.util.djava

Class VDSFunction

java.lang.Object

com.rli.util.djava.VDSFunction

public abstract class VDSFunction
extends java.lang.Object

VDSFunction: supports script functions.

  Some of the functions:
  rdn(param) //rdn a=1
  rdnval(param) //rdnval 1
  parent(param) //dn parent
  left(param,nbchar) //left substring
  leftsubstring(param,'string') //left substring + trim()
  right(param,nbchar)//right substring
  rightsubstring(param,'string') //right substring + trim()
  upper(param) //to upper case
  lower(param) //to lower case

  Example:
  parent(refdn)
  left(middlename,1)
  left(name,"@")
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VDSFunction.FunctionAnnotation
static class	VDSFunction.TypeParameter

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	base
protected CompoundObject	compoundObject
javax.naming.directory.Attribute	dn
java.lang.String	dnstr
static java.lang.String	GETANCESTORATTR_METHODENAME
static java.lang.String	GETCACHE_OBJECTGUID
static java.lang.String	GETIDENTITYURL_METHODENAME
static java.lang.String	GETMETADN_METHODENAME
static java.lang.String	GETPRIMARYIDENTITYURL_METHODENAME
static java.lang.String	GETURL_METHODENAME
protected static int	one
protected javax.naming.directory.Attribute	sharedAttribute
protected javax.naming.directory.SearchResult	sr
protected static int	sub

Constructor Summary

Constructors

Constructor and Description
VDSFunction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addMultiValues(java.lang.String values, java.lang.String separator) add a set of values to the computed attribute
java.lang.String	addValue(java.lang.Object value) add a value to the computed attribute e.g., addValue(val1);addValue(val2);addValue(attr1)
java.lang.String	addValues(javax.naming.directory.Attribute attribute) add all the attribute values to the computed attribute addValues(attr1);
static java.lang.String	avg(javax.naming.directory.Attribute attr) Return average from attribute values.
static java.lang.String	caverphone1(java.lang.String attribute) Encodes a string into a Caverphone 1.0 value.
static java.lang.String	caverphone2(java.lang.String attribute) Encodes a string into a Caverphone 2.0 value.
java.lang.String	checkQuote(VDSFunction.TypeParameter typeP, java.lang.String value) Add or remove quote for value to be valid regarding is type.
static java.lang.String	colognePhonetic(java.lang.String attribute) Encodes a string into a Cologne Phonetic value.
static VDSFunction	createDefaultInstance(CompoundObject co) basic implementation for GUI, to be able to access VDSFunction method
java.lang.String	DNremapLookup(javax.naming.directory.Attribute attr, java.lang.String baseDN1, java.lang.String baseDN2, java.lang.String dnAttr)
java.lang.String	DNremapLookupForeign(javax.naming.directory.Attribute attr, java.lang.String baseDN1, java.lang.String baseDN2)
java.lang.String	DNremapLookupUnnest(javax.naming.directory.Attribute Groupattr, java.lang.String UserbaseDN, java.lang.String GroupbaseDN, java.lang.String dnAttr)
static java.lang.String	doubleMetaphone(java.lang.String attribute) Encodes a string into a double metaphone value.
boolean	filtermatch(java.lang.String attrValue) Help Support of conditional expressions (if then else) .
static java.lang.String	firstValue(javax.naming.directory.Attribute attr) Returns first value from the attribute values.
java.lang.String	getactualDN() Get the actualDN
java.lang.String	getADPassword() Get the AD password (defaults to ORGID) from the compound object source and the entry's through websocket server saMAccountname
java.lang.String	getADPasswordHistory() Get the AD password History (defaults to ORGID) from the compound object source and the entry's through websocket server saMAccountname
java.lang.String	getADPasswordMD4() Get the AD password (MD4) from the compound object source and the entry's through websocket server saMAccountname
java.lang.String	getAncestorAttributeValues(java.lang.String attributeName, java.lang.String dn)
java.lang.String	getBinary(javax.naming.directory.Attribute AttrName) Return the values of an attribute in binary .
java.lang.String	getCacheObjectGUID(java.lang.String guidAttrName)
java.lang.String	getDateFromADTimestamp(javax.naming.directory.Attribute attribute, java.lang.String OutputFormat) Translate a Microsoft AD timestamp into a formatted date/time
java.lang.String	getHexGUIDForDn(java.lang.String datasourceName, java.lang.String dnValue)
java.lang.String	getIdentityUrls()
static java.util.Map<java.lang.String,java.lang.String>	getMapFromDictionaryFile(java.lang.String fileName) Get a map of all key and values of a dictionary.
java.lang.String	getMetaDN() Get the meta DN
java.lang.String	getParentRdnValues(java.lang.String rdnAttrName) Extract parent rdn values from entry DN.
java.lang.String	getPrimaryIdentityUrl()
java.lang.String	getStringGUIDForDn(java.lang.String datasourceName, java.lang.String dnValue)
java.lang.String	getTypeParameterDefaultValue(VDSFunction.TypeParameter typeP)
java.lang.String	getTypeParameterDescription(VDSFunction.TypeParameter typeP) return description for type parameter.
java.lang.String[]	getTypeParameterValues(VDSFunction.TypeParameter typeP) Return values allowed for parameter.
java.lang.String	getUrl() get the instance URL of the virtualized backend
java.lang.String	getUUIDfromDN() Creates UUID from DN value.
boolean	has(java.lang.String attrValue) Help Support of conditional expressions (if then else) .
static boolean	isTypeParameterOptional(VDSFunction.TypeParameter typeP) Return true if parameter is optional in function.
boolean	isTypeParameterValid(VDSFunction.TypeParameter typeP, java.lang.String value) Return true if value is valid for current parameter type.
static java.lang.String	lastValue(javax.naming.directory.Attribute attr) Returns last value from the attribute values.
static java.lang.String	left(java.lang.String value, int size) Leftmost characters of the replace string are returned.
static java.lang.String	left(java.lang.String value, java.lang.String separ) Leftmost characters of the replace string are returned before the separator string.
java.lang.String	lookup(java.lang.String vdQuery) Execute a LDAP lookup and store value(s) in attribute returned.
java.lang.String	lookup(java.lang.String dataSourceID, java.lang.String baseDn, int scope, java.lang.String filter, java.lang.String attrName, int sizeLimit) execute a LDAP lookup and store value(s) in attribute returned.
java.lang.String	lookup(VDQuery vdQuery) Execute a LDAP lookup and store value(s) in attribute returned.
static java.lang.String	lower(java.lang.String value) Converts all of the characters in the replace string to lower case.
static java.lang.String	max(javax.naming.directory.Attribute attr) Return maximum value from attribute values.
static java.lang.String	metaphone(java.lang.String attribute) Encodes a string into a Metaphone value.
static java.lang.String	min(javax.naming.directory.Attribute attr) Return minimum value from attribute values.
static java.lang.String	normalizeAttribute(java.lang.String attribute, java.lang.String normalizedFileName) Normalizes the non-standard attribute into standard attribute using normalization file normalizedFileName which must be located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normalizeFirstName(java.lang.String attribute) Normalizes the non-standard first name attribute into standard first name using normalization file firstname.dat which located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normalizeGeneration(java.lang.String attribute) Normalizes the non-standard generation attribute into standard generation using normalization file generation.dat which located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normalizeLastName(java.lang.String attribute) Normalizes the non-standard last name attribute into standard first name using normalization file lastname.dat which located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normalizePhoneNumber(java.lang.String s) Normalizies phone number by removing all non-digit characters
static java.lang.String	normalizeSalutation(java.lang.String attribute) Normalizes the non-standard salutation attribute into standard salutation using normalization file salutation.dat which located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normalizeSpace(java.lang.String attribute) Removes leading and trailing white space from the attribute and changes multiple spaces in the middle of the attribute to a single space.
static java.lang.String	normalizeString(java.lang.String attribute) 1.
static java.lang.String	normalizeTitle(java.lang.String attribute) Normalizes the non-standard title attribute into standard title using normalization file title.dat which located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	normilizePhone(java.lang.String s) Normalizies phone number by removing all non-digit characters
static java.lang.String	parent(java.lang.String value) Returns the parent DN of a given dnAttribute.
static java.lang.String	randomAlpanumeric(int count) Creates a random string whose length is the number of characters specified.
static java.lang.String	randomAlphabetic(int count) Creates a random string whose length is the number of characters specified.
static java.lang.String	randomAscii(int count) Creates a random string whose length is the number of characters specified.
static java.lang.String	randomNumeric(int count) Creates a random string whose length is the number of characters specified.
static java.lang.String	randomUUID() Creates a random UUID.
static java.lang.String	rdn(java.lang.String value) Returns the RDN part of a given dnAttribute.
static java.lang.String	rdnval(java.lang.String value) Returns the RDN value of a given dnAttribute.
static java.lang.String	refinedSoundex(java.lang.String attribute) Encodes a string into a Refined Soundex value.
static java.lang.String	remapDN(java.lang.String dn, java.lang.String dnTemplate) Re-map original DN attribute using a DN template.
static java.lang.String	remapDN(java.lang.String dn, java.lang.String srcSuffix, java.lang.String destSuffix) Replace in the dn the old suffix (if present) to the new suffix.
java.lang.String	remapDN(java.lang.String attr2remap, java.lang.String dataSourceID, java.lang.String externalBaseDN, int scope, java.lang.String externalIdAttr) The function will extract the rdn Value of the DN to remap, and will issue a lookup.
static java.lang.String	replace(java.lang.String replace, java.lang.String pattern, java.lang.String replacement) Replaces the first substring of the replace string that matches the given regular expression pattern with the given replacement.
static java.lang.String	replaceAll(java.lang.String replace, java.lang.String pattern, java.lang.String replacement) Replaces each substring of the replace string that matches the given regular expression pattern with the given replacement.
static java.lang.String	replaceChars(java.lang.String str, java.lang.String searchChars, java.lang.String replaceChars) This method is wrapper of org.apache.commons.lang.StringUtils.replaceChars with one change: A null string input returns an empty ("") string.
static java.lang.String	replaceEmpty(java.lang.String attribute, java.lang.String replacement) If attribute is empty string ("") or null, returns replacement string; otherwise, returns attribute.
static java.lang.String	replaceFromDictionary(java.lang.String attribute, java.lang.String dictionaryFileName, java.lang.String defaultValue) Normalizes the non-standard attribute into standard attribute using normalization file normalizedFileName which must be located in RLI_HOME/vds/ontology/normalization directory.
static java.lang.String	replaceFromDictionary(java.lang.String attribute, java.lang.String dictionaryFileName, java.lang.String defaultValue, boolean caseSensitive)
static java.lang.String	replaceNull(java.lang.String attribute) If attribute is null, returns empty string (""); otherwise, returns attribute.
static java.lang.String	replaceNull(java.lang.String attribute, java.lang.String defaultValue) If attribute is null, returns the replacement string; otherwise, returns attribute.
static java.lang.String	replaceX(java.lang.String toreplace, java.lang.String rules) Replaces each substring of the attribute values that matches the given regular expression pattern with the given replacement.
static java.lang.String	replaceXnull(java.lang.String toreplace, java.lang.String rules) Replaces each substring of the attribute values that matches the given regular expression pattern with the given replacement.
static java.lang.String	right(java.lang.String value, int size) Rightmost characters of the replace string are returned.
static java.lang.String	right(java.lang.String value, java.lang.String separ) Rightmost characters of the replace string are returned after the separator string.
static java.lang.String	sortAsc(javax.naming.directory.Attribute attr) Sort the specified attribute values in ascending order.
static java.lang.String	sortDesc(javax.naming.directory.Attribute attr) Sort the specified attribute values in descending order.
static java.lang.String	soundex(java.lang.String attribute) Encodes a string into a Soundex value.
java.lang.String	StringFromGUID(javax.naming.directory.Attribute guidAttrName) Return the ascii 'formatted' representation of a GUID (internally represented by a byte array )Example: StringFromGUID(objectGUID) returns "ac642e6e-6ab5-425a-bcc9-9f5067d46e3f".
java.lang.String	StringFromSID(javax.naming.directory.Attribute sidAttrName) Return the ascii 'formatted' representation of a SID (internally represented by a byte array )Example: StringFromSID(objectSID) returns "S-1-5-21-1698188384-1693678267-1543859470-6637".
static java.lang.String	sum(javax.naming.directory.Attribute attr) Return total sum from attribute values.
static java.lang.String	upper(java.lang.String value) Converts all of the characters in the replace string to upper case.
static java.lang.String	upperTrim(java.lang.String attribute) Applies normalizeSpace() and upper() functions; if string is null, returns empty string.

Methods inherited from class java.lang.Object

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

Field Detail

sr

protected javax.naming.directory.SearchResult sr

compoundObject

protected CompoundObject compoundObject

sharedAttribute

protected javax.naming.directory.Attribute sharedAttribute

base

protected static final int base

See Also:

Constant Field Values

one

protected static final int one

See Also:

Constant Field Values

sub

protected static final int sub

See Also:

Constant Field Values

dn

public javax.naming.directory.Attribute dn

dnstr

public java.lang.String dnstr

GETPRIMARYIDENTITYURL_METHODENAME

public static final java.lang.String GETPRIMARYIDENTITYURL_METHODENAME

See Also:

Constant Field Values

GETIDENTITYURL_METHODENAME

public static final java.lang.String GETIDENTITYURL_METHODENAME

See Also:

Constant Field Values

GETMETADN_METHODENAME

public static final java.lang.String GETMETADN_METHODENAME

See Also:

Constant Field Values

GETURL_METHODENAME

public static final java.lang.String GETURL_METHODENAME

See Also:

Constant Field Values

GETCACHE_OBJECTGUID

public static final java.lang.String GETCACHE_OBJECTGUID

See Also:

Constant Field Values

GETANCESTORATTR_METHODENAME

public static final java.lang.String GETANCESTORATTR_METHODENAME

See Also:

Constant Field Values

Constructor Detail

VDSFunction

public VDSFunction()

Method Detail

getTypeParameterDescription

public java.lang.String getTypeParameterDescription(VDSFunction.TypeParameter typeP)

return description for type parameter.

Parameters:

typeP - type parameter

Returns:

The description of type parameter as String.

getTypeParameterValues

public java.lang.String[] getTypeParameterValues(VDSFunction.TypeParameter typeP)

Return values allowed for parameter. If scope of values is not known, then return null.

Parameters:

typeP - type parameter

Returns:

The description of type parameter as String[].

getTypeParameterDefaultValue

public java.lang.String getTypeParameterDefaultValue(VDSFunction.TypeParameter typeP)

getCacheObjectGUID

public java.lang.String getCacheObjectGUID(java.lang.String guidAttrName)

checkQuote

public java.lang.String checkQuote(VDSFunction.TypeParameter typeP,
                                   java.lang.String value)

Add or remove quote for value to be valid regarding is type.

Parameters:

typeP - type parameter

value - input value

Returns:

The resulting String.

isTypeParameterValid

public boolean isTypeParameterValid(VDSFunction.TypeParameter typeP,
                                    java.lang.String value)

Return true if value is valid for current parameter type.

Parameters:

typeP - type parameter

value - value for checking

Returns:

true if value is valid for current parameter type; false otherwise

isTypeParameterOptional

public static boolean isTypeParameterOptional(VDSFunction.TypeParameter typeP)

Return true if parameter is optional in function. (if optional accept null value)

Parameters:

typeP - type parameter

Returns:

true if parameter is optional in function; false otherwise

rdn

public static java.lang.String rdn(java.lang.String value)

Returns the RDN part of a given dnAttribute.

Example: rdn("uid=me,ou=myorg,o=companydirectory") returns "uid=me"

Parameters:

value - value of DN

Returns:

The resulting String

rdnval

public static java.lang.String rdnval(java.lang.String value)

Returns the RDN value of a given dnAttribute.

Example: rdnval("uid=me") returns "me"

Parameters:

value - value of DN

Returns:

The resulting String

parent

public static java.lang.String parent(java.lang.String value)

Returns the parent DN of a given dnAttribute.

Example: parent("uid=me,ou=myorg,o=companydirectory") returns "ou=myorg,o=companydirectory"

Parameters:

value - value of DN

Returns:

The resulting String

left

public static java.lang.String left(java.lang.String value,
                                    int size)

Leftmost characters of the replace string are returned.

Example:

 left("123456789",5) returns "12345"
 left("123456789",15) returns "123456789"
 

Parameters:

value - the replace string

size - how many leftmost characters should be returned. If size bigger than the size of the replace string, the replace string is returned.

Returns:

The resulting String.

right

public static java.lang.String right(java.lang.String value,
                                     int size)

Rightmost characters of the replace string are returned.

Example:

 right("123456789",5) returns "56789"
 right("123456789",15) returns "123456789"
 

Parameters:

value - the replace string

size - how many rightmost characters should be returned. If size bigger than the size of the replace string, the replace string is returned.

Returns:

The resulting String.

right

public static java.lang.String right(java.lang.String value,
                                     java.lang.String separ)

Rightmost characters of the replace string are returned after the separator string. If separator is not found in the the replace string, the replace string is returned.

Example:

 right("name@domain.com","@") returns "domain.com";
 right("name@domain.com","#") returns "name@domain.com";
 

Parameters:

value - the replace string

separ - separator

Returns:

The resulting String.

left

public static java.lang.String left(java.lang.String value,
                                    java.lang.String separ)

Leftmost characters of the replace string are returned before the separator string. If separator is not found in the the replace string, the replace string is returned.

Example:

 left("name@domain.com","@") returns "name";
 left("name@domain.com","#") returns "name@domain.com";
 

Parameters:

value - the replace string

separ - separator

Returns:

The resulting String.

upper

public static java.lang.String upper(java.lang.String value)

Converts all of the characters in the replace string to upper case.

Example: upper("abCD") returns "ABCD"

Parameters:

value - the replace string

Returns:

The resulting String.

lower

public static java.lang.String lower(java.lang.String value)

Converts all of the characters in the replace string to lower case.

Example: upper("abCD") returns "abcd"

Parameters:

value - the replace string

Returns:

The resulting String.

lookup

public java.lang.String lookup(java.lang.String dataSourceID,
                               java.lang.String baseDn,
                               int scope,
                               java.lang.String filter,
                               java.lang.String attrName,
                               int sizeLimit)
                        throws javax.naming.NamingException,
                               java.io.IOException,
                               LDAPException

execute a LDAP lookup and store value(s) in attribute returned.

Parameters:

dataSourceID - Data Source Name as defined in "Data Sources" configuration

baseDn - Base DN to use, could be an attribute or a static DN value

scope - 0:base, 1:one or 2:sub

filter - filter to apply on external source, could be a combination of attributes and static string values

attrName - attrName to return from external entries, if not specified (null), then will store DN in result

sizeLimit - number of external entries returned

Returns:

The resulting String.

Throws:

LDAPException

java.io.IOException

javax.naming.NamingException

lookup

public java.lang.String lookup(java.lang.String vdQuery)
                        throws javax.naming.NamingException,
                               java.io.IOException,
                               LDAPException

Execute a LDAP lookup and store value(s) in attribute returned.

Parameters:

vdQuery -

Returns:

The resulting String.

Throws:

javax.naming.NamingException

java.io.IOException

LDAPException

getMetaDN

public java.lang.String getMetaDN()

Get the meta DN

Returns:

meta DN as String.

Throws:

javax.naming.NamingException

java.io.IOException

LDAPException

getactualDN

public java.lang.String getactualDN()

Get the actualDN

Returns:

actualDN as String.

getPrimaryIdentityUrl

public java.lang.String getPrimaryIdentityUrl()

getIdentityUrls

public java.lang.String getIdentityUrls()

getUrl

public java.lang.String getUrl()

get the instance URL of the virtualized backend

Returns:

url as String.

getAncestorAttributeValues

public java.lang.String getAncestorAttributeValues(java.lang.String attributeName,
                                                   java.lang.String dn)
                                            throws java.lang.Exception

Parameters:

attributeName -

dn -

Returns:

The resulting String.

Throws:

java.lang.Exception

addValue

public java.lang.String addValue(java.lang.Object value)

add a value to the computed attribute
e.g., addValue(val1);addValue(val2);addValue(attr1)

Parameters:

value - String with all the values ,

addMultiValues

public java.lang.String addMultiValues(java.lang.String values,
                                       java.lang.String separator)

add a set of values to the computed attribute

e.g., addMultiValues("v1 # v2 #v3"," # ");

Parameters:

values - : string representing the values, separated with 'separator'

separator -

addValues

public java.lang.String addValues(javax.naming.directory.Attribute attribute)

add all the attribute values to the computed attribute
addValues(attr1);

Parameters:

attribute -

DNremapLookup

public java.lang.String DNremapLookup(javax.naming.directory.Attribute attr,
                                      java.lang.String baseDN1,
                                      java.lang.String baseDN2,
                                      java.lang.String dnAttr)
                               throws LDAPException

Throws:

LDAPException

DNremapLookupUnnest

public java.lang.String DNremapLookupUnnest(javax.naming.directory.Attribute Groupattr,
                                            java.lang.String UserbaseDN,
                                            java.lang.String GroupbaseDN,
                                            java.lang.String dnAttr)
                                     throws LDAPException

Throws:

LDAPException

DNremapLookupForeign

public java.lang.String DNremapLookupForeign(javax.naming.directory.Attribute attr,
                                             java.lang.String baseDN1,
                                             java.lang.String baseDN2)
                                      throws LDAPException

Throws:

LDAPException

lookup

public java.lang.String lookup(VDQuery vdQuery)
                        throws javax.naming.NamingException,
                               java.io.IOException,
                               LDAPException

Execute a LDAP lookup and store value(s) in attribute returned.

Parameters:

vdQuery -

Returns:

The resulting String.

Throws:

javax.naming.NamingException

java.io.IOException

LDAPException

remapDN

public static java.lang.String remapDN(java.lang.String dn,
                                       java.lang.String dnTemplate)

Re-map original DN attribute using a DN template. DN template is a representation of re-mapped pattern, it can use with place holders %rdn and %dn. %rdn is the rdn value of the original DN. %dn is the value of original DN.

Example: remapDN(memberOf,"uid=%rdn,dc=my_users"). %rdn will be replaced with the rdn value extracted from the memberof attribute.

Example: remapDN(memberOf,"%dn,dc=my_users") will add a suffix to the original dn

Parameters:

dn - DN type attribute. Example: cn=test,ou=mycompany,dc=com

dnTemplate - DN Template representation of re-mapped value. Example: uid=%rdn,dv=ad_10_11_12_203_389_users

Returns:

The resulting String

remapDN

public static java.lang.String remapDN(java.lang.String dn,
                                       java.lang.String srcSuffix,
                                       java.lang.String destSuffix)

Replace in the dn the old suffix (if present) to the new suffix.

Example: remapDN(originalDNattribute,"o=mycompany","dc=mycomp")

Parameters:

dn - DN type attribute

srcSuffix - old suffix to be updated

destSuffix - new suffix value

Returns:

remapDN

public java.lang.String remapDN(java.lang.String attr2remap,
                                java.lang.String dataSourceID,
                                java.lang.String externalBaseDN,
                                int scope,
                                java.lang.String externalIdAttr)
                         throws javax.naming.NamingException,
                                java.io.IOException,
                                LDAPException

The function will extract the rdn Value of the DN to remap, and will issue a lookup. using the specified server / base/scope . The filter will be : (externalIdAttr= )

Parameters:

attr2remap - Name of the Attribute containing the DN to remap.

dataSourceID - Data Source Name as defined in \"Data Sources\" configuration

externalBaseDN - Base DN to use for lookup.

scope - 0:base, 1:one or 2:sub

externalIdAttr - Name of the attribute to look for.

Returns:

Throws:

javax.naming.NamingException

java.io.IOException

LDAPException

max

public static java.lang.String max(javax.naming.directory.Attribute attr)

Return maximum value from attribute values.

Example: max(this.uid), uid with values = [1,2,3] returns 3

Parameters:

attr - Attribute

Returns:

maximum value from attribute values

min

public static java.lang.String min(javax.naming.directory.Attribute attr)

Return minimum value from attribute values.

Example: min(this.uid), uid with values = [1,2,3] returns 1

Parameters:

attr - Attribute

Returns:

minimum value from attribute values

avg

public static java.lang.String avg(javax.naming.directory.Attribute attr)

Return average from attribute values.

Example: avg(this.uid), uid with values = [1,2,3] returns 2

Parameters:

attr - Attribute

Returns:

average from attribute values

sum

public static java.lang.String sum(javax.naming.directory.Attribute attr)

Return total sum from attribute values.

Example: sum(this.uid), uid with values=[1,2,3] returns 6

Parameters:

attr - Attribute

Returns:

total sum from attribute values.

sortAsc

public static java.lang.String sortAsc(javax.naming.directory.Attribute attr)

Sort the specified attribute values in ascending order.

Example: sortAsc(this.uid), uid with values = [1,3,2] returns [1,2,3]

Parameters:

attr - Attribute

Returns:

sorted (in ascending order) attribute values as String[]

sortDesc

public static java.lang.String sortDesc(javax.naming.directory.Attribute attr)

Sort the specified attribute values in descending order.

Example: sortDesc(this.uid), uid with values = [1,3,2] returns [3,2,1]

Parameters:

attr - Attribute

Returns:

sorted (in descending order) attribute values as String[]

firstValue

public static java.lang.String firstValue(javax.naming.directory.Attribute attr)

Returns first value from the attribute values.

Example: firstValue(this.uid), uid with values = [1,2,3] returns 1

Parameters:

attr - Attribute

Returns:

first value from attribute values

lastValue

public static java.lang.String lastValue(javax.naming.directory.Attribute attr)

Returns last value from the attribute values.

Example: lastValue(this.uid), uid with values = [1,2,3] returns 3

Parameters:

attr - Attribute

Returns:

first value from attribute values

getParentRdnValues

public java.lang.String getParentRdnValues(java.lang.String rdnAttrName)

Extract parent rdn values from entry DN.

Example: getParentRdnValues("ou") with values = [uid=1,ou=hr,ou=mycompany] returns [hr,mycompany]

Parameters:

rdnAttrName - rdnAttrName

Returns:

replace

public static java.lang.String replace(java.lang.String replace,
                                       java.lang.String pattern,
                                       java.lang.String replacement)

Replaces the first substring of the replace string that matches the given regular expression pattern with the given replacement. If the regular expression pattern is not correct, the replace string is returned unchanged.

Example: replace("abCDab","ab","AB") returns "ABCDab"

Parameters:

replace - the replace string

pattern - the regular expression to which the replace string is to be matched

replacement - the string to be substituted for the first match

Returns:

The resulting String. If the regular expression pattern is not correct, the attribute is returned unchanged.

replaceAll

public static java.lang.String replaceAll(java.lang.String replace,
                                          java.lang.String pattern,
                                          java.lang.String replacement)

Replaces each substring of the replace string that matches the given regular expression pattern with the given replacement. If the regular expression pattern is not correct, the replace string is returned unchanged.

Example: replace("abCDab","ab","AB") returns "ABCDAB"

Parameters:

replace - the replace string

pattern - the regular expression to which the replace string is to be matched

replacement - the string to be substituted for each match

Returns:

The resulting String. If the regular expression pattern is not correct, the attribute is returned unchanged.

replaceX

public static java.lang.String replaceX(java.lang.String toreplace,
                                        java.lang.String rules)

Replaces each substring of the attribute values that matches the given regular expression pattern with the given replacement. If the regular expression pattern is not correct, the original value is returned unchanged.

Example: replaceX("San Francisco",{"San"} --> {"SAN"}) returns "SAN Francisco"

Parameters:

toreplace - the string to be replaced

rules - rules: regular expressions to which the string to replace is to be matched with . regular expression1-->replacement1 ##regular expression2-->replacement2" the replacement pattern can be an ldap url , that is evaluated for lookup "(.+) --> ldap://[vds]/o=companydirectory?dn?sub?(l=$1)" simplified form : o=companydirectory?dn?sub?(l=$1)

Returns:

The resulting String. If the regular expression pattern is not correct,or no regex matches, the attribute is returned unchanged.

replaceXnull

public static java.lang.String replaceXnull(java.lang.String toreplace,
                                            java.lang.String rules)

Replaces each substring of the attribute values that matches the given regular expression pattern with the given replacement. If the regular expression pattern is not correct, a 'null' value is returned

Example: replaceXnull("Francisco",{"San"} --> {"SAN"}) returns null

Parameters:

toreplace - the string to be replaced

rules - rules: regular expressions to which the string to replace is to be matched with . regular expression1-->replacement1 ##regular expression2-->replacement2" the replacement pattern can be an ldap url , that is evaluated for lookup "(.+) --> ldap://[vds]/o=companydirectory?dn?sub?(l=$1)" simplified form : o=companydirectory?dn?sub?(l=$1)

Returns:

The resulting String. If the regular expression pattern is not correct,or no regex matches, the value returned is null.

normalizeSpace

public static java.lang.String normalizeSpace(java.lang.String attribute)

Removes leading and trailing white space from the attribute and changes multiple spaces in the middle of the attribute to a single space. If attribute is null, returns empty string.

Example: normalizeSpace( " ab CDab ") returns "ab CDab"

Parameters:

attribute - the replaced string

Returns:

The resulting String

upperTrim

public static java.lang.String upperTrim(java.lang.String attribute)

Applies normalizeSpace() and upper() functions; if string is null, returns empty string. See description of normalizeSpace() and upper() methods.

Parameters:

attribute - the replaced string

Returns:

The resulting String

normalizeString

public static java.lang.String normalizeString(java.lang.String attribute)

1. Removes leading and trailing white space from the attribute and changes multiple spaces in the middle of the attribute to a single space. 2. Converts all characters to upper case 3. Replaces special characters by '_', and then replaces multiple consecutive '_' into one '_'. Special characters are: !\"#$%&'()*+,-./:;<=>?[\\]^`{|}~" 4. If attribute is null, returns empty string.

Parameters:

attribute - the replaced string

Returns:

normalized string

replaceChars

public static java.lang.String replaceChars(java.lang.String str,
                                            java.lang.String searchChars,
                                            java.lang.String replaceChars)

This method is wrapper of org.apache.commons.lang.StringUtils.replaceChars with one change: A null string input returns an empty ("") string.

Replaces multiple characters in a String in one go. This method can also be used to delete characters.

For example: replaceChars("hello", "ho", "jy") = jelly.

A null string input returns an empty ("") string. An empty ("") string input returns an empty string. A null or empty set of search characters returns the input string.

The length of the search characters should normally equal the length of the replace characters. If the search characters is longer, then the extra search characters are deleted. If the search characters is shorter, then the extra replace characters are ignored.

Parameters:

str - - String to replace characters in, may be null

searchChars - - a set of characters to search for, may be null

replaceChars - - a set of characters to replace, may be null

Returns:

modified String

normalizePhoneNumber

public static java.lang.String normalizePhoneNumber(java.lang.String s)

Normalizies phone number by removing all non-digit characters

Parameters:

s - input string

Returns:

normilized string containing only digits; if s is null, returns empty string.

normilizePhone

public static java.lang.String normilizePhone(java.lang.String s)

Normalizies phone number by removing all non-digit characters

Parameters:

s - input string

Returns:

normilized string containing only digits; if s is null, returns empty string.

replaceEmpty

public static java.lang.String replaceEmpty(java.lang.String attribute,
                                            java.lang.String replacement)

If attribute is empty string ("") or null, returns replacement string; otherwise, returns attribute.

Example: replaceEmpty(null,"ABC") ) returns "ABC"

Example: replaceEmpty("","ABC") ) returns "ABC"

Parameters:

attribute - input string

replacement - replacement string

Returns:

The resulting String.

replaceNull

public static java.lang.String replaceNull(java.lang.String attribute)

If attribute is null, returns empty string (""); otherwise, returns attribute.

Example: replaceNull(null) returns ""

Parameters:

attribute - input string

Returns:

The resulting String.

replaceNull

public static java.lang.String replaceNull(java.lang.String attribute,
                                           java.lang.String defaultValue)

If attribute is null, returns the replacement string; otherwise, returns attribute.

Example: replaceNull(null, "ABC") returns "ABC"

Parameters:

attribute - input string

Returns:

The resulting String.

getUUIDfromDN

public java.lang.String getUUIDfromDN()

Creates UUID from DN value.

This is a wrapper of java.util.UUID.method

Example of UUID: 7f5922e8-bb2f-4e97-841c-9bdd651b9705

Returns:

the UUID based on the dn value

randomUUID

public static java.lang.String randomUUID()

Creates a random UUID.

This is a wrapper of java.util.UUID.randomUUID().toString() method

Example of UUID: 7f5922e8-bb2f-4e97-841c-9bdd651b9705

Returns:

the random string

randomAscii

public static java.lang.String randomAscii(int count)

Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of characters whose ASCII value is between 32 and 126 (inclusive).

This is a wrapper of org.apache.commons.lang.RandomStringUtils.randomAscii(count) method with one change: if count<=0, a random string of length 1 is returned. ( Apache method throws an exception if count<0, or returns empty string if count=0. )

Example: randomAscii(10) returns random string of length 10.

Parameters:

count - the length of random string to create

Returns:

the random string

randomAlphabetic

public static java.lang.String randomAlphabetic(int count)

Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alphabetic characters.

This is a wrapper of org.apache.commons.lang.RandomStringUtils.randomAlphabetic(count) method with one change: if count<=0, a random string of length 1 is returned. ( Apache method throws an exception if count<0, or returns empty string if count=0. )

Example: randomAlphabetic(10) returns random string of length 10.

Parameters:

count - the length of random string to create

Returns:

the random string

randomAlpanumeric

public static java.lang.String randomAlpanumeric(int count)

Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alpha-numeric characters.

This is a wrapper of org.apache.commons.lang.RandomStringUtils.randomAlphanumeric(count) method with one change: if count<=0, a random string of length 1 is returned. ( Apache method throws an exception if count<0, or returns empty string if count=0. )

Example: randomAlpanumeric(10) returns random string of length 10.

Parameters:

count - the length of random string to create

Returns:

the random string

randomNumeric

public static java.lang.String randomNumeric(int count)

Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of numeric characters.

This is a wrapper of org.apache.commons.lang.RandomStringUtils.randomNumeric(count) method with one change: if count<=0, a random string of length 1 is returned. ( Apache method throws an exception if count<0, or returns empty string if count=0. )

Example: randomNumeric(10) returns random string of length 10.

Parameters:

count - the length of random string to create

Returns:

the random string

soundex

public static java.lang.String soundex(java.lang.String attribute)

Encodes a string into a Soundex value. Example: soundex("Alyson") returns "A425". If an exception happens, the method returns the input attribute.

Parameters:

attribute - the input string

Returns:

The resulting String

refinedSoundex

public static java.lang.String refinedSoundex(java.lang.String attribute)

Encodes a string into a Refined Soundex value. Example: refinedSoundex("Alyson") returns "A070308".

Parameters:

attribute - the input string

Returns:

The resulting String

metaphone

public static java.lang.String metaphone(java.lang.String attribute)

Encodes a string into a Metaphone value. Example: metaphone("Alyson") returns "ALSN".

Parameters:

attribute - the input string

Returns:

The resulting String

doubleMetaphone

public static java.lang.String doubleMetaphone(java.lang.String attribute)

Encodes a string into a double metaphone value. Example: doubleMetaphone("Alyson") returns "ALSN".

Parameters:

attribute - the input string

Returns:

The resulting String

caverphone1

public static java.lang.String caverphone1(java.lang.String attribute)

Encodes a string into a Caverphone 1.0 value. Example: caverphone1("Alyson") returns "ALSN11".

Parameters:

attribute - the input string

Returns:

The resulting String

caverphone2

public static java.lang.String caverphone2(java.lang.String attribute)

Encodes a string into a Caverphone 2.0 value. Example: caverphone2("Alyson") returns "ALSN111111".

Parameters:

attribute - the input string

Returns:

The resulting String

colognePhonetic

public static java.lang.String colognePhonetic(java.lang.String attribute)

Encodes a string into a Cologne Phonetic value. Example: colognePhonetic("Alyson") returns "0586".

Parameters:

attribute - the input string

Returns:

The resulting String

normalizeFirstName

public static java.lang.String normalizeFirstName(java.lang.String attribute)

Normalizes the non-standard first name attribute into standard first name using normalization file firstname.dat which located in RLI_HOME/vds/ontology/normalization directory. All data in this file is in UPPERCASE, so in order to be matched the input attribute must be in UPPERCASE. If no match is found, the input attribute is returned.

Example: normalizeFirstName("BOB") ) returns "ROBERT"

Parameters:

attribute - first name attribute

Returns:

The resulting String. If no match is found, the input attribute is returned.

normalizeLastName

public static java.lang.String normalizeLastName(java.lang.String attribute)

Normalizes the non-standard last name attribute into standard first name using normalization file lastname.dat which located in RLI_HOME/vds/ontology/normalization directory. All data in this file is in UPPERCASE, so in order to be matched the input attribute must be in UPPERCASE. If no match is found, the input attribute is returned.

Example: normalizeLastName("ALLYSON") ) returns "ALLISON"

Parameters:

attribute - last name attribute

Returns:

The resulting String. If no match is found, the input attribute is returned.

normalizeSalutation

public static java.lang.String normalizeSalutation(java.lang.String attribute)

Normalizes the non-standard salutation attribute into standard salutation using normalization file salutation.dat which located in RLI_HOME/vds/ontology/normalization directory. All data in this file is in UPPERCASE, so in order to be matched the input attribute must be in UPPERCASE. If no match is found, the input attribute is returned.

Example: normalizeSalutation("DR") ) returns "DOCTOR"

Parameters:

attribute - salutation attribute

Returns:

The resulting String. If no match is found, the input attribute is returned.

normalizeTitle

public static java.lang.String normalizeTitle(java.lang.String attribute)

Normalizes the non-standard title attribute into standard title using normalization file title.dat which located in RLI_HOME/vds/ontology/normalization directory. All data in this file is in UPPERCASE, so in order to be matched the input attribute must be in UPPERCASE. If no match is found, the input attribute is returned.

Example: normalizeTitle("CEO") ) returns "CHIEF EXECUTIVE OFFICER"

Parameters:

attribute - title attribute

Returns:

The resulting String. If no match is found, the input attribute is returned.

normalizeGeneration

public static java.lang.String normalizeGeneration(java.lang.String attribute)

Normalizes the non-standard generation attribute into standard generation using normalization file generation.dat which located in RLI_HOME/vds/ontology/normalization directory. All data in this file is in UPPERCASE, so in order to be matched the input attribute must be in UPPERCASE. If no match is found, the input attribute is returned.

Example: normalizeGeneration("JR") ) returns "JUNIOR"

Parameters:

attribute - generation attribute

Returns:

The resulting String. If no match is found, the input attribute is returned.

normalizeAttribute

public static java.lang.String normalizeAttribute(java.lang.String attribute,
                                                  java.lang.String normalizedFileName)

Normalizes the non-standard attribute into standard attribute using normalization file normalizedFileName which must be located in RLI_HOME/vds/ontology/normalization directory. The format of this file is:

 NON_NORMALIZED_VALUE_1|NORMALIZED_VALUE_1
 NON_NORMALIZED_VALUE_2|NORMALIZED_VALUE_2
 NON_NORMALIZED_VALUE_3|NORMALIZED_VALUE_3
 ....
 

I.e. each pair (non-normilized value and normalized value) should be on a separate line, non-normalized value goes first, then separator - |, then normilized value.

Example (from firstname.dat):

 ALAINA|ALANA
 ALAINE|ALANA
 ALANE|ALANA
 

If no match is found, the input attribute is returned.

Example: normalizeAttribute("BOB","firstname.dat") ) returns "ROBERT"

Parameters:

attribute - attribute that should be normalized

normalizedFileName - the name of the file where normalization data is described.

Returns:

The resulting String. If no match is found, the input attribute is returned.

replaceFromDictionary

public static java.lang.String replaceFromDictionary(java.lang.String attribute,
                                                     java.lang.String dictionaryFileName,
                                                     java.lang.String defaultValue)

Normalizes the non-standard attribute into standard attribute using normalization file normalizedFileName which must be located in RLI_HOME/vds/ontology/normalization directory. The format of this file is:

 NON_NORMALIZED_VALUE_1|NORMALIZED_VALUE_1
 NON_NORMALIZED_VALUE_2|NORMALIZED_VALUE_2
 NON_NORMALIZED_VALUE_3|NORMALIZED_VALUE_3
 ....
 

I.e. each pair (non-normalized value and normalized value) should be on a separate line, non-normalized value goes first, then separator - |, then normalized value.

Example (from firstname.dat):

 ALAINA|ALANA
 ALAINE|ALANA
 ALANE|ALANA
 

If no match is found, the default value is returned. If no default value is given, the original attribute value is returned.

Example: replaceFromDictionnary("BOB","firstname.dat") ) returns "ROBERT"

Parameters:

attribute - attribute that should be normalized.

dictionaryFileName - the name of the file where normalization data is described.

defaultValue - default value if the attribute is not found.

Returns:

The resulting String. If no match is found, the input defaultValue is returned.

replaceFromDictionary

public static java.lang.String replaceFromDictionary(java.lang.String attribute,
                                                     java.lang.String dictionaryFileName,
                                                     java.lang.String defaultValue,
                                                     boolean caseSensitive)

getMapFromDictionaryFile

public static java.util.Map<java.lang.String,java.lang.String> getMapFromDictionaryFile(java.lang.String fileName)

Get a map of all key and values of a dictionary.

Parameters:

fileName - Name of the dictionary.

Returns:

Map of all Key - Value fron the dictionary

has

public boolean has(java.lang.String attrValue)

Help Support of conditional expressions (if then else) . return true if attribute value is present

Parameters:

attrValue -

Returns:

filtermatch

public boolean filtermatch(java.lang.String attrValue)

Help Support of conditional expressions (if then else) . The filter is an ldapfilter syntax It will be applied on the current entry. will return 'true' or 'false' Usage in computed attribute ?: filtermatch("(objectclass=inetorgperson)")?"hello folks":"hola thing" can have multiple if then else .... filtermatch("objectclass=inetorgperson")?"hello folks" :filtermatch("(|(objectclass=group)(objectclass=groupofuniquenames))" )?"group_"+cn:null

Parameters:

filtercondition - - ldap filter

Returns:

true if condition is met, false otherwise .

getHexGUIDForDn

public java.lang.String getHexGUIDForDn(java.lang.String datasourceName,
                                        java.lang.String dnValue)

getStringGUIDForDn

public java.lang.String getStringGUIDForDn(java.lang.String datasourceName,
                                           java.lang.String dnValue)

StringFromGUID

public java.lang.String StringFromGUID(javax.naming.directory.Attribute guidAttrName)

Return the ascii 'formatted' representation of a GUID (internally represented by a byte array )Example: StringFromGUID(objectGUID) returns "ac642e6e-6ab5-425a-bcc9-9f5067d46e3f". returns always null as the data is in sharedAttribute

Parameters:

guidAttrName - the input attribute name

Returns:

The resulting set of formatted guid

StringFromSID

public java.lang.String StringFromSID(javax.naming.directory.Attribute sidAttrName)

Return the ascii 'formatted' representation of a SID (internally represented by a byte array )Example: StringFromSID(objectSID) returns "S-1-5-21-1698188384-1693678267-1543859470-6637". returns null. Actual values are in sharedAttribute

Parameters:

attributename - the input attribute name

Returns:

the set of formatted SID

getDateFromADTimestamp

public java.lang.String getDateFromADTimestamp(javax.naming.directory.Attribute attribute,
                                               java.lang.String OutputFormat)

Translate a Microsoft AD timestamp into a formatted date/time

Parameters:

ADattribute - - Attribute containing the timestamp - for instance : "131220409910000000"

OutputFormat - - string containing the template to format the date - for instance : "yyyy-MM-dd hh:mm:ss.SSS" - if null a default format is assumed

Returns:

the formatted date

getBinary

public java.lang.String getBinary(javax.naming.directory.Attribute AttrName)

Return the values of an attribute in binary .

getBinary(userCertificate) Actual values are in sharedAttribute

Parameters:

attributename - the input attribute name

getADPassword

public java.lang.String getADPassword()

Get the AD password (defaults to ORGID) from the compound object source and the entry's through websocket server saMAccountname

Returns:

AD Password {PBKDF2AD}xxxx

getADPasswordMD4

public java.lang.String getADPasswordMD4()

Get the AD password (MD4) from the compound object source and the entry's through websocket server saMAccountname

Returns:

AD Password {PBKDF2AD}xxxx

getADPasswordHistory

public java.lang.String getADPasswordHistory()

Get the AD password History (defaults to ORGID) from the compound object source and the entry's through websocket server saMAccountname

Returns:

AD Password History {PBKDF2AD}xxxx

createDefaultInstance

public static VDSFunction createDefaultInstance(CompoundObject co)

basic implementation for GUI, to be able to access VDSFunction method

Parameters:

co -

Returns: