de.espirit.firstspirit.service.permission.scripting
Interface PermissionServiceScriptContext

All Superinterfaces:

BaseContext, ScriptContext, SpecialistsBroker

public interface PermissionServiceScriptContext
extends ScriptContext

This script context is available via variable 'context' in serverside scripts executed in the permission service. It provides methods to access and modify the group and users definitions.

Since:

3.1.170

Method Summary

DirContext	getLdapContext() Returns the dir context specified in the belonging section in the service.ini of the permission service or null if no ldap.URL is specified in the service.ini.
GroupRoot	getRoot() Returns the group root model representing the belonging groups.xml file specified by the param "DOCUMENT_NAME.path" in service.ini.
Users	getUsers() Returns the users model representing the belonging users.xml file specified by the param "DOCUMENT_NAME.users" in service.ini or null if no users xml file is specified.

Methods inherited from interface de.espirit.firstspirit.access.ScriptContext

getConnection, getProperties, getProperty, getServiceLocator, logDebug, logError, logError, logInfo, logWarning, removeProperty, setProperty

Methods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker

requestSpecialist, requireSpecialist

Method Detail

getRoot

GroupRoot getRoot()

Returns the group root model representing the belonging groups.xml file specified by the param "DOCUMENT_NAME.path" in service.ini.

Since:

3.1.170

getUsers

@Nullable
Users getUsers()

Returns the users model representing the belonging users.xml file specified by the param "DOCUMENT_NAME.users" in service.ini or null if no users xml file is specified.

Returns:

the object representing the users xml file or null if no users xml is specified in service.ini

Since:

3.1.170

getLdapContext

@Nullable
DirContext getLdapContext()
                          throws IOException

Returns the dir context specified in the belonging section in the service.ini of the permission service or null if no ldap.URL is specified in the service.ini.

Returns:

dir context or null if ldap.URL is missing in belonging section of service.ini

Throws:

IOException

Since:

3.1.170