org.nuxeo.ecm.automation.features

Class PlatformFunctions

java.lang.Object

org.nuxeo.ecm.automation.core.scripting.CoreFunctions

org.nuxeo.ecm.automation.features.PlatformFunctions

public class PlatformFunctions
extends CoreFunctions

Author:

Bogdan Stefanescu

Constructor Summary

Constructors

Constructor and Description
PlatformFunctions()

Method Summary

Modifier and Type	Method and Description
<T> List<T>	concatenateIntoList(List<T> list, Object... values) Concatenate into the list given as first argument other arguments.
<T> List<T>	concatenateValuesAsNewList(Object... values) Idem than concatenateInto except that a new list is created.
DirectoryService	getDirService()
protected String	getEmail(NuxeoPrincipal principal, String userSchemaName, String userEmailFieldName)
String	getEmail(String username)
StringList	getEmails(List<String> usernames)
StringList	getEmails(List<String> usernames, boolean usePrefix) Returns user emails
StringList	getEmailsFromGroup(String group)
StringList	getEmailsFromGroup(String group, boolean ignoreGroups)
String	getNextId(String key)
NuxeoPrincipal	getPrincipal(String username)
StringList	getPrincipalEmails(List<NuxeoPrincipal> principals)
Set<NuxeoPrincipal>	getPrincipalsFromGroup(String group)
Set<NuxeoPrincipal>	getPrincipalsFromGroup(String group, boolean ignoreGroups)
UserManager	getUserManager()
String	getVocabularyLabel(String voc, String key)
static String	htmlEscape(String str)
static String	nxqlEscape(String str) Escapes a string according to NXQL escaping rules.

Methods inherited from class org.nuxeo.ecm.automation.core.scripting.CoreFunctions

calendar, date, escapeHtml

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformFunctions

public PlatformFunctions()

Method Detail

getUserManager

public UserManager getUserManager()
                           throws Exception

Throws:

Exception

getDirService

public DirectoryService getDirService()
                               throws Exception

Throws:

Exception

getVocabularyLabel

public String getVocabularyLabel(String voc,
                                 String key)
                          throws Exception

Throws:

Exception

getPrincipal

public NuxeoPrincipal getPrincipal(String username)
                            throws Exception

Throws:

Exception

getEmail

protected String getEmail(NuxeoPrincipal principal,
                          String userSchemaName,
                          String userEmailFieldName)
                   throws ClientException

Throws:

ClientException

getEmail

public String getEmail(String username)
                throws Exception

Throws:

Exception

getPrincipalsFromGroup

public Set<NuxeoPrincipal> getPrincipalsFromGroup(String group)
                                           throws Exception

Throws:

Exception

getPrincipalsFromGroup

public Set<NuxeoPrincipal> getPrincipalsFromGroup(String group,
                                                  boolean ignoreGroups)
                                           throws Exception

Throws:

Exception

getEmailsFromGroup

public StringList getEmailsFromGroup(String group)
                              throws Exception

Throws:

Exception

getEmailsFromGroup

public StringList getEmailsFromGroup(String group,
                                     boolean ignoreGroups)
                              throws Exception

Throws:

Exception

getPrincipalEmails

public StringList getPrincipalEmails(List<NuxeoPrincipal> principals)
                              throws Exception

Throws:

Exception

getEmails

public StringList getEmails(List<String> usernames)
                     throws Exception

Throws:

Exception

getEmails

public StringList getEmails(List<String> usernames,
                            boolean usePrefix)
                     throws Exception

Returns user emails

Parameters:

usernames - list of user names

usePrefix - indicates if user resolution takes into account nuxeo prefix user:

Throws:

Exception

Since:

5.5

getNextId

public String getNextId(String key)
                 throws Exception

Throws:

Exception

htmlEscape

public static String htmlEscape(String str)

nxqlEscape

public static String nxqlEscape(String str)

Escapes a string according to NXQL escaping rules.

The resulting string is safe to include between single quotes in a NXQL expression.

Parameters:

str - the input string

Returns:

the escaped string

Since:

6.0-HF21, 7.10

concatenateIntoList

public <T> List<T> concatenateIntoList(List<T> list,
                                       Object... values)
                                throws ClientException

Concatenate into the list given as first argument other arguments. Other arguments will be explosed if it is a list of object. ex: concatenateInto(myList, a, anotherList) with a is scalar object and anotherList is a list of object will produced myList.add(a) and the same for each object contained into the anotherList list.

Type Parameters:

T -

Parameters:

list - List of values of type A

value - Value can be instance of java.util.Collection