|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.plugin.ldap.XWikiLDAPConfig
public final class XWikiLDAPConfig
Access to LDAP configurations.
Field Summary | |
---|---|
static String |
CFG_LDAP_PORT
LDAP port property name in xwiki.cfg. |
static String |
CFG_LDAP_SUFFIX
LDAP properties names suffix in xwiki.cfg. |
static Set<String> |
DEFAULT_GROUP_CLASSES
Different LDAP implementations groups classes name. |
static Set<String> |
DEFAULT_GROUP_MEMBERFIELDS
Different LDAP implementations groups member property name. |
static String |
DEFAULT_SEPARATOR
Mapping fields separator. |
static String |
PREF_LDAP_PORT
LDAP port property name in XWikiPreferences. |
static String |
PREF_LDAP_SUFFIX
LDAP properties names suffix in XWikiPreferences. |
static String |
PREF_LDAP_UID
LDAP port property name in XWikiPreferences. |
static String |
USERMAPPING_SEP
Mapping fields separator. |
static String |
USERMAPPING_XWIKI_LDAP_LINK
Character user to link XWiki field name and LDAP field name in user mappings property. |
Method Summary | |
---|---|
int |
getCacheExpiration(XWikiContext context)
|
Collection<String> |
getGroupClasses(XWikiContext context)
|
Map<String,Set<String>> |
getGroupMappings(XWikiContext context)
Get mapping between XWiki groups names and LDAP groups names. |
Collection<String> |
getGroupMemberFields(XWikiContext context)
|
static XWikiLDAPConfig |
getInstance()
|
String |
getLDAPBindDN(String login,
String password,
XWikiContext context)
|
String |
getLDAPBindDN(XWikiContext context)
|
String |
getLDAPBindPassword(String login,
String password,
XWikiContext context)
|
String |
getLDAPBindPassword(XWikiContext context)
|
String |
getLDAPParam(String prefName,
String cfgName,
String def,
XWikiContext context)
First try to retrieve value from XWiki Preferences and then from xwiki.cfg Syntax ldap_*name* (for XWiki Preferences) will be changed to ldap.*name* for xwiki.cfg. |
String |
getLDAPParam(String name,
String def,
XWikiContext context)
First try to retrieve value from XWiki Preferences and then from xwiki.cfg Syntax ldap_*name* (for XWiki Preferences) will be changed to ldap.*name* for xwiki.cfg. |
long |
getLDAPParamAsLong(String name,
long def,
XWikiContext context)
First try to retrieve value from XWiki Preferences and then from xwiki.cfg Syntax ldap_*name* (for XWiki Preferences) will be changed to ldap.*name* for xwiki.cfg. |
int |
getLDAPPort(XWikiContext context)
Get LDAP port from configuration. |
int |
getLDAPTimeout(XWikiContext context)
|
Provider |
getSecureProvider(XWikiContext context)
|
Map<String,String> |
getUserMappings(List<String> attrListToFill,
XWikiContext context)
Get mapping between XWiki users attributes and LDAP users attributes. |
boolean |
isLDAPEnabled(XWikiContext context)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_SEPARATOR
public static final String CFG_LDAP_SUFFIX
public static final String CFG_LDAP_PORT
public static final String PREF_LDAP_SUFFIX
public static final String PREF_LDAP_PORT
public static final String PREF_LDAP_UID
public static final String USERMAPPING_SEP
public static final String USERMAPPING_XWIKI_LDAP_LINK
public static final Set<String> DEFAULT_GROUP_CLASSES
public static final Set<String> DEFAULT_GROUP_MEMBERFIELDS
Method Detail |
---|
public static XWikiLDAPConfig getInstance()
XWikiLDAPConfig
.public String getLDAPParam(String prefName, String cfgName, String def, XWikiContext context)
prefName
- the name of the property in XWikiPreferences.cfgName
- the name of the property in xwiki.cfg.def
- default value.context
- the XWiki context.
public String getLDAPParam(String name, String def, XWikiContext context)
name
- the name of the property in XWikiPreferences.def
- default value.context
- the XWiki context.
public long getLDAPParamAsLong(String name, long def, XWikiContext context)
name
- the name of the property in XWikiPreferences.def
- default value.context
- the XWiki context.
public Collection<String> getGroupClasses(XWikiContext context)
context
- the XWiki context.
public Collection<String> getGroupMemberFields(XWikiContext context)
context
- the XWiki context.
public Provider getSecureProvider(XWikiContext context) throws XWikiLDAPException
context
- the XWiki context.
XWikiLDAPException
- error when trying to instantiate secure provider.public boolean isLDAPEnabled(XWikiContext context)
context
- the XWiki context.
public int getLDAPPort(XWikiContext context)
context
- the XWiki context.
public Map<String,Set<String>> getGroupMappings(XWikiContext context)
context
- the XWiki context.
public Map<String,String> getUserMappings(List<String> attrListToFill, XWikiContext context)
attrListToFill
- the list to fill with extracted LDAP fields to use in LDAP search.context
- the XWiki context.
public int getCacheExpiration(XWikiContext context)
context
- the XWiki context.
public String getLDAPBindDN(XWikiContext context)
context
- the XWiki context.
MessageFormat
.MessageFormat.format(String, Object...)
,
getLDAPBindDN(String, String, XWikiContext)
public String getLDAPBindDN(String login, String password, XWikiContext context)
login
- the login provided by the userpassword
- the password provided by the usercontext
- the XWiki context.
public String getLDAPBindPassword(XWikiContext context)
context
- the XWiki context.
MessageFormat.format(String, Object...)
,
getLDAPBindPassword(String, String, XWikiContext)
public String getLDAPBindPassword(String login, String password, XWikiContext context)
login
- the login provided by the userpassword
- the password provided by the usercontext
- the XWiki context.
public int getLDAPTimeout(XWikiContext context)
context
- the XWiki context.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |