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 and Description
static Trace	LOGGER
static String	NAME_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BasicExpressionFunctions(PrismContext prismContext, Protector protector)

Method Summary

Methods

Modifier and Type	Method and Description
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.
XMLGregorianCalendar	currentDateTime()
String	decrypt(ProtectedStringType protectedString)
String	determineLdapSingleAttributeValue(Collection<String> dns, String attributeName, Collection<String> values)
String	determineLdapSingleAttributeValue(Collection<String> dns, String attributeName, PrismProperty attribute)
String	determineLdapSingleAttributeValue(String dn, String attributeName, Collection<?> values)
ProtectedStringType	encrypt(String string)
String	formatDateTime(String format, Long millis)
String	formatDateTime(String format, XMLGregorianCalendar xmlCal)
Collection<String>	getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, groovy.xml.QName attributeQname)
Collection<String>	getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, QName attributeQname)
Collection<String>	getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, String attributeNamespace, String attributeLocalPart)
<T> T	getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, groovy.xml.QName attributeQname)
<T> T	getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, QName attributeQname)
<T> T	getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, String attributeLocalPart)
<T> T	getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, String attributeNamespace, String attributeLocalPart)
<T> Collection<T>	getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, groovy.xml.QName attributeQname)
<T> Collection<T>	getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, QName attributeQname)
<T> Collection<T>	getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, String attributeLocalPart)
<T> Collection<T>	getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow, String attributeNamespace, String attributeLocalPart)
<T> T	getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, groovy.xml.QName propertyQname)
<T> T	getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, QName propertyQname)
<T> T	getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, String namespace, String localPart)
<T> Collection<T>	getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, groovy.xml.QName propertyQname)
<T> Collection<T>	getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, QName propertyQname)
<T> Collection<T>	getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, String namespace, String localPart)
Referencable	getExtensionReferenceValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, QName propertyQname)
Referencable	getExtensionReferenceValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, String namespace, String localPart)
<T> T	getIdentifierValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow)
Collection<String>	getOids(Collection<com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType> refs)
Collection<String>	getOids(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType refs)
Collection<String>	getOids(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType refs)
<T> T	getPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, String path)
<T> Collection<T>	getPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object, String path)
<T> T	getResourceIcfConfigurationPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource, QName propertyQname)
<T> T	getResourceIcfConfigurationPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource, String propertyLocalPart)
<T> T	getSecondaryIdentifierValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow)
boolean	isEmpty(Object whatever)
static String	lc(String orig) Convert string to lower case.
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)
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 Detail

NAME_SEPARATOR

public static final String NAME_SEPARATOR

See Also:

Constant Field Values

LOGGER

public static final Trace LOGGER

Constructor Detail

BasicExpressionFunctions

public BasicExpressionFunctions(PrismContext prismContext,
                        Protector protector)

Method Detail

lc

public static String lc(String orig)

Convert string to lower case.

uc

public static String uc(String orig)

Convert string to upper case.

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.

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<com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType> refs)

getOids

public Collection<String> getOids(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType refs)

getOids

public Collection<String> getOids(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType refs)

isEmpty

public boolean isEmpty(Object whatever)

getExtensionPropertyValues

public <T> Collection<T> getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                           String namespace,
                                           String localPart)

getExtensionPropertyValues

public <T> Collection<T> getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                           groovy.xml.QName propertyQname)

getExtensionPropertyValues

public <T> Collection<T> getExtensionPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                           QName propertyQname)

getExtensionPropertyValue

public <T> T getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                              String namespace,
                              String localPart)
                            throws SchemaException

Throws:

SchemaException

getExtensionReferenceValue

public Referencable getExtensionReferenceValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                      String namespace,
                                      String localPart)
                                        throws SchemaException

Throws:

SchemaException

getExtensionPropertyValue

public <T> T getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                              groovy.xml.QName propertyQname)
                            throws SchemaException

Throws:

SchemaException

getExtensionPropertyValue

public <T> T getExtensionPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                              QName propertyQname)
                            throws SchemaException

Throws:

SchemaException

getExtensionReferenceValue

public Referencable getExtensionReferenceValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                      QName propertyQname)
                                        throws SchemaException

Throws:

SchemaException

getPropertyValue

public <T> T getPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                     String path)
                   throws SchemaException

Throws:

SchemaException

getPropertyValues

public <T> Collection<T> getPropertyValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType object,
                                  String path)

getAttributeValues

public <T> Collection<T> getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                   String attributeNamespace,
                                   String attributeLocalPart)

getAttributeValues

public <T> Collection<T> getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                   String attributeLocalPart)

getAttributeValues

public <T> Collection<T> getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                   groovy.xml.QName attributeQname)

getAttributeValues

public <T> Collection<T> getAttributeValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                   QName attributeQname)

getAttributeValue

public <T> T getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                      String attributeNamespace,
                      String attributeLocalPart)
                    throws SchemaException

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                      String attributeLocalPart)
                    throws SchemaException

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                      groovy.xml.QName attributeQname)
                    throws SchemaException

Throws:

SchemaException

getAttributeValue

public <T> T getAttributeValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                      QName attributeQname)
                    throws SchemaException

Throws:

SchemaException

getAttributeStringValues

public Collection<String> getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                          String attributeNamespace,
                                          String attributeLocalPart)

getAttributeStringValues

public Collection<String> getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                          groovy.xml.QName attributeQname)

getAttributeStringValues

public Collection<String> getAttributeStringValues(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow,
                                          QName attributeQname)

getIdentifierValue

public <T> T getIdentifierValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow)
                     throws SchemaException

Throws:

SchemaException

getSecondaryIdentifierValue

public <T> T getSecondaryIdentifierValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType shadow)
                              throws SchemaException

Throws:

SchemaException

determineLdapSingleAttributeValue

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

Throws:

NamingException

getResourceIcfConfigurationPropertyValue

public <T> T getResourceIcfConfigurationPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource,
                                             QName propertyQname)
                                           throws SchemaException

Throws:

SchemaException

getResourceIcfConfigurationPropertyValue

public <T> T getResourceIcfConfigurationPropertyValue(com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource,
                                             String propertyLocalPart)
                                           throws SchemaException

Throws:

SchemaException

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()

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)

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