Package com.evolveum.midpoint.model.common.expression.functions

Class BasicExpressionFunctions

java.lang.Object

com.evolveum.midpoint.model.common.expression.functions.BasicExpressionFunctions

public class BasicExpressionFunctions
extends Object

Library of standard midPoint functions. These functions are made available to all midPoint expressions.

The functions should be written to support scripting-like comfort. It means that they all needs to be null-safe, automatically convert data types as necessary and so on.

Author:

Radovan Semancik

Field Summary

Fields

Modifier and Type	Field	Description
static final Trace	LOGGER
static final XMLGregorianCalendar	LONG_AGO	Special value that is too far in the past.
static final String	NAME_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
BasicExpressionFunctions(PrismContext prismContext, Protector protector, Clock clock)

Method Summary

Modifier and Type	Method	Description
XMLGregorianCalendar	addDuration(XMLGregorianCalendar now, String duration)
XMLGregorianCalendar	addDuration(XMLGregorianCalendar now, Duration duration)
XMLGregorianCalendar	addMillis(XMLGregorianCalendar now, long duration)
static String	composeDn(Object... components)	Creates a valid LDAP distinguished name from the wide range of components.
static String	composeDnWithSuffix(Object... components)	Creates a valid LDAP distinguished name from the wide range of components assuming that the last component is a suffix.
String	concatName(Object... components)	Concatenates the arguments to create a name.
boolean	contains(Object object, Object search)
boolean	containsIgnoreCase(Object object, Object search)
XMLGregorianCalendar	currentDateTime()
static String	debugDump(Object o)
static String	debugDump(Object o, int indent)
String	decrypt(ProtectedStringType protectedString)
String	determineLdapSingleAttributeValue(String dn, String attributeName, Collection<?> values)
String	determineLdapSingleAttributeValue(Collection<String> dns, String attributeName, PrismProperty attribute)
String	determineLdapSingleAttributeValue(Collection<String> dns, String attributeName, Collection<String> values)
ProtectedStringType	encrypt(String string)
boolean	endsWith(PolyString polyString, String value)	Checks whether the given normalized string ends with the specified value
boolean	endsWith(String string, String value)	Checks whether the given normalized string ends with the specified value by first normalizing it.
String	formatDateTime(String format, Long millis)
String	formatDateTime(String format, XMLGregorianCalendar xmlCal)
XMLGregorianCalendar	fromNow(String timeSpec)
Collection<String>	getAttributeStringValues(ShadowType shadow, groovy.namespace.QName attributeQname)
Collection<String>	getAttributeStringValues(ShadowType shadow, String attributeNamespace, String attributeLocalPart)
Collection<String>	getAttributeStringValues(ShadowType shadow, QName attributeQname)
<T> T	getAttributeValue(ShadowType shadow, groovy.namespace.QName attributeQname)
<T> T	getAttributeValue(ShadowType shadow, String attributeLocalPart)	The namespace of the attribute is assumed to be "ri:"
<T> T	getAttributeValue(ShadowType shadow, String attributeNamespace, String attributeLocalPart)
<T> T	getAttributeValue(ShadowType shadow, QName attributeQname)
<T> Collection<T>	getAttributeValues(ShadowType shadow, groovy.namespace.QName attributeQname)
<T> Collection<T>	getAttributeValues(ShadowType shadow, String attributeLocalPart)
<T> Collection<T>	getAttributeValues(ShadowType shadow, String attributeNamespace, String attributeLocalPart)
<T> Collection<T>	getAttributeValues(ShadowType shadow, QName attributeQname)
<T> T	getExtensionPropertyValue(Containerable containerable, @NotNull String localPart)
<T> T	getExtensionPropertyValue(Containerable containerable, groovy.namespace.QName propertyQname)
<T> T	getExtensionPropertyValue(Containerable containerable, String namespace, @NotNull String localPart)
<T> T	getExtensionPropertyValue(Containerable containerable, QName propertyQname)	Returns the real value of an extension property (of an object, assignment, or similar structure), or null if no value exists.
<T> @NotNull Collection<T>	getExtensionPropertyValues(Containerable object, groovy.namespace.QName propertyQname)
<T> @NotNull Collection<T>	getExtensionPropertyValues(Containerable containerable, String namespace, @NotNull String localPart)	Returns real values of an extension property (of an object, assignment, or similar structure).
<T> @NotNull Collection<T>	getExtensionPropertyValues(Containerable object, QName propertyQname)
@Nullable Referencable	getExtensionReferenceValue(Containerable containerable, String namespace, @NotNull String localPart)
@Nullable Referencable	getExtensionReferenceValue(Containerable containerable, QName itemQName)	Returns the value of an extension reference item (of an object, assignment, or similar structure), or null if no value exists.
<T> T	getIdentifierValue(ShadowType shadow)
@NotNull Collection<?>	getMetadataExtensionValues(PrismValue value, String itemLocalPart)	Simplified version of getMetadataValue aimed at fetching single-segment extension paths.
@NotNull Collection<?>	getMetadataValues(PrismValue value, Object... pathSegments)	Generic method to extract all metadata values pointed-to by given item path (specified as segments).
@NotNull Collection<?>	getMetadataValues(PrismValue value, String path)
Collection<String>	getOids(ObjectReferenceType refs)
Collection<String>	getOids(ObjectType refs)
Collection<String>	getOids(Collection<ObjectReferenceType> refs)
PrismContext	getPrismContext()
<T> T	getPropertyValue(Containerable c, ItemPathType path)
<T> T	getPropertyValue(Containerable c, String path)
<T> T	getPropertyValue(PrismContainerValue<?> pcv, ItemPathType path)
<T> T	getPropertyValue(PrismContainerValue<?> pcv, String path)
<T> Collection<T>	getPropertyValues(Containerable c, ItemPathType path)
<T> Collection<T>	getPropertyValues(Containerable c, String path)
<T> Collection<T>	getPropertyValues(PrismContainerValue<?> pcv, ItemPathType path)
<T> Collection<T>	getPropertyValues(PrismContainerValue<?> pcv, String path)
<T> T	getResourceIcfConfigurationPropertyValue(ResourceType resource, String propertyLocalPart)
<T> T	getResourceIcfConfigurationPropertyValue(ResourceType resource, QName propertyQname)
<T> T	getSecondaryIdentifierValue(ShadowType shadow)	Beware, the shadow may legally have more than one secondary identifier.
String	hashLdapPassword(byte[] clearBytes, String alg)	Hashes cleartext password in an (unofficial) LDAP password format.
String	hashLdapPassword(ProtectedStringType protectedString, String alg)	Hashes cleartext password in an (unofficial) LDAP password format.
String	hashLdapPassword(String clearString, String alg)	Hashes cleartext password in an (unofficial) LDAP password format.
boolean	isEmpty(Object whatever)
static String	lc(String orig)	Convert string to lower case.
XMLGregorianCalendar	longAgo()
String	norm(PolyString orig)	Normalize a PolyString value.
String	norm(PolyStringType orig)	Normalize a PolyStringType value.
String	norm(String orig)	Normalize a string value.
String	parseAdditionalName(Object fullName)
XMLGregorianCalendar	parseDateTime(String format, String stringDate)
String	parseFamilyName(Object fullName)
String	parseGivenName(Object fullName)
String	parseHonorificPrefix(Object fullName)
String	parseHonorificSuffix(Object fullName)
String	parseNickName(Object fullName)
static String	readFile(String filename)
ByteBuffer	resolveSecretBinary(@NotNull String provider, @NotNull String key)
String	resolveSecretString(@NotNull String provider, @NotNull String key)
XMLGregorianCalendar	roundDownToMidnight(XMLGregorianCalendar in)
XMLGregorianCalendar	roundUpToEndOfDay(XMLGregorianCalendar in)
void	setExtensionPropertyValues(@NotNull Containerable parent, @NotNull String propertyName, Object... values)
void	setExtensionPropertyValues(@NotNull Containerable parent, @NotNull QName propertyName, Object... values)	Sets the real values of a given extension property (of an object, assignment, or similar structure).
void	setExtensionRealValues(PrismContainerValue<?> containerValue, Map<String,Object> map)	Deprecated.
void	setTaskWorkerThreads(@NotNull TaskType task, Integer value)	Sets "worker threads" distribution parameter for the root task activity.
boolean	startsWith(PolyString polyString, String value)	Checks whether the given normalized string begins with the specified value.
boolean	startsWith(String string, String value)	Checks whether the given normalized string begins with the specified value by first normalizing it.
String	stringify(Object whatever)	Converts whatever it gets to a string.
String	toAscii(Object input)
<T> T	toSingle(Collection<T> values)
static String	trim(String orig)	Remove whitespaces at the beginning and at the end of the string.
static String	uc(String orig)	Convert string to upper case.

Methods inherited from class java.lang.Object

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

Field Details

NAME_SEPARATOR

public static final String NAME_SEPARATOR

See Also:

• Constant Field Values

LOGGER

public static final Trace LOGGER

LONG_AGO

public static final XMLGregorianCalendar LONG_AGO

Special value that is too far in the past. It can be returned from time-based expressions to make sure that the expression is always executed.

Constructor Details

BasicExpressionFunctions

public BasicExpressionFunctions(PrismContext prismContext,
 Protector protector,
 Clock clock)

Method Details

lc

public static String lc(String orig)

Convert string to lower case.

uc

public static String uc(String orig)

Convert string to upper case.

contains

public boolean contains(Object object,
 Object search)

containsIgnoreCase

public boolean containsIgnoreCase(Object object,
 Object search)

trim

public static String trim(String orig)

Remove whitespaces at the beginning and at the end of the string.

concatName

public String concatName(Object... components)

Concatenates the arguments to create a name. Each argument is stringified, trimmed and the result is concatenated by spaces.

startsWith

public boolean startsWith(String string,
 String value)

Checks whether the given normalized string begins with the specified value by first normalizing it.

Parameters:

string - the string

value - the value

Returns:

true/false

startsWith

public boolean startsWith(PolyString polyString,
 String value)

Checks whether the given normalized string begins with the specified value.

Parameters:

polyString - the string

value - the value

Returns:

true/false

endsWith

public boolean endsWith(String string,
 String value)

Checks whether the given normalized string ends with the specified value by first normalizing it.

Parameters:

string - the string

value - the value

Returns:

true/false

endsWith

public boolean endsWith(PolyString polyString,
 String value)

Checks whether the given normalized string ends with the specified value

Parameters:

polyString - the string

value - the value

Returns:

true/false

norm

public String norm(String orig)

Normalize a string value. It follows the default normalization algorithm used for PolyString values.

Parameters:

orig - original value to normalize

Returns:

normalized value

norm

public String norm(PolyString orig)

Normalize a PolyString value.

Parameters:

orig - original value to normalize

Returns:

normalized value

norm

public String norm(PolyStringType orig)

Normalize a PolyStringType value.

Parameters:

orig - original value to normalize

Returns:

normalized value

toAscii

public String toAscii(Object input)

stringify

public String stringify(Object whatever)

Converts whatever it gets to a string. But it does it in a sensitive way. E.g. it tries to detect collections and returns the first element (if there is only one). Never returns null. Returns empty string instead.

getOids

public Collection<String> getOids(Collection<ObjectReferenceType> refs)

getOids

public Collection<String> getOids(ObjectReferenceType refs)

getOids

public Collection<String> getOids(ObjectType refs)

isEmpty

public boolean isEmpty(Object whatever)

getPrismContext

public PrismContext getPrismContext()

getExtensionPropertyValues

@NotNull
public <T> @NotNull Collection<T> getExtensionPropertyValues(Containerable containerable,
 String namespace,
 @NotNull
 @NotNull String localPart)

Returns real values of an extension property (of an object, assignment, or similar structure). Do not modify the returned collection.

getExtensionPropertyValues

@NotNull
public <T> @NotNull Collection<T> getExtensionPropertyValues(Containerable object,
 @NotNull
 groovy.namespace.QName propertyQname)

See Also:

• getExtensionPropertyValue(Containerable, String, String)

getExtensionPropertyValues

@NotNull
public <T> @NotNull Collection<T> getExtensionPropertyValues(Containerable object,
 @NotNull
 QName propertyQname)

See Also:

• getExtensionPropertyValue(Containerable, String, String)

getExtensionPropertyValue

@Nullable
public <T> T getExtensionPropertyValue(Containerable containerable,
 @NotNull
 QName propertyQname)
                                throws SchemaException

Returns the real value of an extension property (of an object, assignment, or similar structure), or null if no value exists. Throws a SchemaException if the property has multiple values.

Throws:

SchemaException

getExtensionPropertyValue

@Nullable
public <T> T getExtensionPropertyValue(Containerable containerable,
 @NotNull
 @NotNull String localPart)
                                throws SchemaException

Throws:

SchemaException

See Also:

• getExtensionPropertyValue(Containerable, QName)

getExtensionPropertyValue

@Nullable
public <T> T getExtensionPropertyValue(Containerable containerable,
 String namespace,
 @NotNull
 @NotNull String localPart)
                                throws SchemaException

Throws:

SchemaException

See Also:

• getExtensionPropertyValue(Containerable, QName)

getExtensionPropertyValue

@Nullable
public <T> T getExtensionPropertyValue(Containerable containerable,
 @NotNull
 groovy.namespace.QName propertyQname)
                                throws SchemaException

Throws:

SchemaException

See Also:

• getExtensionPropertyValue(Containerable, QName)

getExtensionReferenceValue

@Nullable
public @Nullable Referencable getExtensionReferenceValue(Containerable containerable,
 @NotNull
 QName itemQName)
                                                  throws SchemaException

Returns the value of an extension reference item (of an object, assignment, or similar structure), or null if no value exists. Throws a SchemaException if the item has multiple values.

Throws:

SchemaException

getExtensionReferenceValue

@Nullable
public @Nullable Referencable getExtensionReferenceValue(Containerable containerable,
 String namespace,
 @NotNull
 @NotNull String localPart)
                                                  throws SchemaException

Throws:

SchemaException

See Also:

• getExtensionReferenceValue(Containerable, QName)

setExtensionPropertyValues

public void setExtensionPropertyValues(@NotNull
 @NotNull Containerable parent,
 @NotNull
 @NotNull QName propertyName,
 Object... values)
                                throws SchemaException

Sets the real values of a given extension property (of an object, assignment, or similar structure). Removes any existing values.

Throws:

SchemaException

setExtensionPropertyValues

public void setExtensionPropertyValues(@NotNull
 @NotNull Containerable parent,
 @NotNull
 @NotNull String propertyName,
 Object... values)
                                throws SchemaException

Throws:

SchemaException

See Also:

• setExtensionPropertyValues(Containerable, QName, Object...)

setExtensionRealValues

@Deprecated
public void setExtensionRealValues(PrismContainerValue<?> containerValue,
 Map<String,Object> map)
                            throws SchemaException

Deprecated.

Throws:

SchemaException

getPropertyValue

public <T> T getPropertyValue(Containerable c,
 String path)
                       throws SchemaException

Throws:

SchemaException

getPropertyValues

public <T> Collection<T> getPropertyValues(Containerable c,
 String path)

getPropertyValue

public <T> T getPropertyValue(Containerable c,
 ItemPathType path)
                       throws SchemaException

Throws:

SchemaException

getPropertyValues

public <T> Collection<T> getPropertyValues(Containerable c,
 ItemPathType path)

getPropertyValue

public <T> T getPropertyValue(PrismContainerValue<?> pcv,
 String path)
                       throws SchemaException

Throws:

SchemaException

getPropertyValue

public <T> T getPropertyValue(PrismContainerValue<?> pcv,
 ItemPathType path)
                       throws SchemaException

Throws:

SchemaException

getPropertyValues

public <T> Collection<T> getPropertyValues(PrismContainerValue<?> pcv,
 String path)

getPropertyValues

public <T> Collection<T> getPropertyValues(PrismContainerValue<?> pcv,
 ItemPathType path)

getAttributeValues

public <T> Collection<T> getAttributeValues(ShadowType shadow,
 String attributeNamespace,
 String attributeLocalPart)

getAttributeValues

public <T> Collection<T> getAttributeValues(ShadowType shadow,
 String attributeLocalPart)

getAttributeValues

public <T> Collection<T> getAttributeValues(ShadowType shadow,
 groovy.namespace.QName attributeQname)

getAttributeValues

public <T> Collection<T> getAttributeValues(ShadowType shadow,
 QName attributeQname)

getAttributeValue

public <T> T getAttributeValue(ShadowType shadow,
 String attributeNamespace,
 String attributeLocalPart)
                        throws SchemaException

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(ShadowType shadow,
 String attributeLocalPart)
                        throws SchemaException

The namespace of the attribute is assumed to be "ri:"

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(ShadowType shadow,
 groovy.namespace.QName attributeQname)
                        throws SchemaException

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(ShadowType shadow,
 QName attributeQname)
                        throws SchemaException

Throws:

SchemaException

getAttributeStringValues

public Collection<String> getAttributeStringValues(ShadowType shadow,
 String attributeNamespace,
 String attributeLocalPart)

getAttributeStringValues

public Collection<String> getAttributeStringValues(ShadowType shadow,
 groovy.namespace.QName attributeQname)

getAttributeStringValues

public Collection<String> getAttributeStringValues(ShadowType shadow,
 QName attributeQname)

getMetadataValues

@Experimental
@NotNull
public @NotNull Collection<?> getMetadataValues(PrismValue value,
 Object... pathSegments)

Generic method to extract all metadata values pointed-to by given item path (specified as segments). Note: does not support multivalued containers withing the path (e.g. collecting transformation/source/name, where transformation/source is a multivalued container).

getMetadataValues

@Experimental
@NotNull
public @NotNull Collection<?> getMetadataValues(PrismValue value,
 String path)

getMetadataExtensionValues

@Experimental
@NotNull
public @NotNull Collection<?> getMetadataExtensionValues(PrismValue value,
 String itemLocalPart)

Simplified version of getMetadataValue aimed at fetching single-segment extension paths.

getIdentifierValue

public <T> T getIdentifierValue(ShadowType shadow)
                         throws SchemaException

Throws:

SchemaException

getSecondaryIdentifierValue

public <T> T getSecondaryIdentifierValue(ShadowType shadow)
                                  throws SchemaException

Beware, the shadow may legally have more than one secondary identifier.

Throws:

SchemaException

determineLdapSingleAttributeValue

public String determineLdapSingleAttributeValue(Collection<String> dns,
 String attributeName,
 PrismProperty attribute)
                                         throws NamingException

Throws:

NamingException

getResourceIcfConfigurationPropertyValue

public <T> T getResourceIcfConfigurationPropertyValue(ResourceType resource,
 QName propertyQname)

getResourceIcfConfigurationPropertyValue

public <T> T getResourceIcfConfigurationPropertyValue(ResourceType resource,
 String propertyLocalPart)

determineLdapSingleAttributeValue

public String determineLdapSingleAttributeValue(Collection<String> dns,
 String attributeName,
 Collection<String> values)
                                         throws NamingException

Throws:

NamingException

determineLdapSingleAttributeValue

public String determineLdapSingleAttributeValue(String dn,
 String attributeName,
 Collection<?> values)
                                         throws NamingException

Throws:

NamingException

toSingle

public <T> T toSingle(Collection<T> values)
               throws SchemaException

Throws:

SchemaException

readFile

public static String readFile(String filename)
                       throws IOException

Throws:

IOException

formatDateTime

public String formatDateTime(String format,
 XMLGregorianCalendar xmlCal)

formatDateTime

public String formatDateTime(String format,
 Long millis)

parseDateTime

public XMLGregorianCalendar parseDateTime(String format,
 String stringDate)
                                   throws ParseException

Throws:

ParseException

currentDateTime

public XMLGregorianCalendar currentDateTime()

fromNow

public XMLGregorianCalendar fromNow(String timeSpec)

addDuration

public XMLGregorianCalendar addDuration(XMLGregorianCalendar now,
 Duration duration)

addDuration

public XMLGregorianCalendar addDuration(XMLGregorianCalendar now,
 String duration)

addMillis

public XMLGregorianCalendar addMillis(XMLGregorianCalendar now,
 long duration)

roundDownToMidnight

public XMLGregorianCalendar roundDownToMidnight(XMLGregorianCalendar in)

roundUpToEndOfDay

public XMLGregorianCalendar roundUpToEndOfDay(XMLGregorianCalendar in)

longAgo

public XMLGregorianCalendar longAgo()

parseGivenName

public String parseGivenName(Object fullName)

parseFamilyName

public String parseFamilyName(Object fullName)

parseAdditionalName

public String parseAdditionalName(Object fullName)

parseNickName

public String parseNickName(Object fullName)

parseHonorificPrefix

public String parseHonorificPrefix(Object fullName)

parseHonorificSuffix

public String parseHonorificSuffix(Object fullName)

decrypt

public String decrypt(ProtectedStringType protectedString)

encrypt

public ProtectedStringType encrypt(String string)

resolveSecretString

public String resolveSecretString(@NotNull
 @NotNull String provider,
 @NotNull
 @NotNull String key)

resolveSecretBinary

public ByteBuffer resolveSecretBinary(@NotNull
 @NotNull String provider,
 @NotNull
 @NotNull String key)

composeDn

public static String composeDn(Object... components)
                        throws InvalidNameException

Creates a valid LDAP distinguished name from the wide range of components. The method can be invoked in many ways, e.g.:

composeDn("cn","foo","o","bar") composeDn("cn","foo",new Rdn("o","bar")) composeDn(new Rdn("cn","foo"),"ou","baz",new Rdn("o","bar")) composeDn(new Rdn("cn","foo"),"ou","baz","o","bar") composeDn(new Rdn("cn","foo"),new LdapName("ou=baz,o=bar")) composeDn("cn","foo",new LdapName("ou=baz,o=bar"))

Note: the DN is not normalized. The case of the attribute names and white spaces are preserved.

Throws:

InvalidNameException

composeDnWithSuffix

public static String composeDnWithSuffix(Object... components)
                                  throws InvalidNameException

Creates a valid LDAP distinguished name from the wide range of components assuming that the last component is a suffix. The method can be invoked in many ways, e.g.:

composeDn("cn","foo","o=bar") composeDn(new Rdn("cn","foo"),"ou=baz,o=bar") composeDn(new Rdn("cn","foo"),new LdapName("ou=baz,o=bar")) composeDn("cn","foo",new LdapName("ou=baz,o=bar"))

The last element is a complete suffix represented either as String or LdapName.

Note: the DN is not normalized. The case of the attribute names and white spaces are preserved.

Throws:

InvalidNameException

hashLdapPassword

public String hashLdapPassword(ProtectedStringType protectedString,
 String alg)
                        throws NoSuchAlgorithmException,
EncryptionException

Hashes cleartext password in an (unofficial) LDAP password format. Supported algorithms: SSHA, SHA and MD5.

Throws:

NoSuchAlgorithmException

EncryptionException

hashLdapPassword

public String hashLdapPassword(String clearString,
 String alg)
                        throws NoSuchAlgorithmException

Hashes cleartext password in an (unofficial) LDAP password format. Supported algorithms: SSHA, SHA and MD5.

Throws:

NoSuchAlgorithmException

hashLdapPassword

public String hashLdapPassword(byte[] clearBytes,
 String alg)
                        throws NoSuchAlgorithmException

Hashes cleartext password in an (unofficial) LDAP password format. Supported algorithms: SSHA, SHA and MD5.

Throws:

NoSuchAlgorithmException

debugDump

public static String debugDump(Object o)

debugDump

public static String debugDump(Object o,
 int indent)

setTaskWorkerThreads

public void setTaskWorkerThreads(@NotNull
 @NotNull TaskType task,
 Integer value)

Sets "worker threads" distribution parameter for the root task activity.