Update LDAP config info in 4.5.1 release notes & ldap module doc.
-----------------------------------------------------------------
Key: DOCU-307
URL: http://jira.magnolia-cms.com/browse/DOCU-307
Project: Documentation
Issue Type: Installation and Migration
Security Level: Public
Reporter: Gavan Stockdale
Assignee: Antti Hietala
Update ldap config info in release notes 4.5.1 and in ldap module.
- Back story -
MGNLLDAP-71
Docu for the ldap connector tells me to configure a "jndi.ldap.config" property
in my magnolia.properties. I get the vague feeling this is vaguely new, as I
thought it used to be configured in jaas.properties. But OK, fair enough, I'll
change my config.
However, I have to point out inconsistencies in the code with regards to that:
info.magnolia.jaas.sp.ldap.LDAPUtils#getJNDIConfig throws an exception if the
jndi.ldap.config property (magnolia.properties) isn't defined.
info.magnolia.jaas.sp.ldap.LDAPAuthenticationModule#getJNDIConfig first tries
the jaas.config property, THEN falls back to the method above.
Both methods have a comment that says // for backword compatability, this use
to be in magnolia.properties as a relative path. Typos apart, this tells me the
opposite of the documentation, and that the current way of configuring would be
to use jaas.config ?
IF all calls would go to (2), then things would be consistent, and I'd believe
that it's just the code comment that's poorly written.
However, some calls go to (2), some to (1) - which essentially means that
a) docu is correct, and code-comment is wrong
b) most importantly, I guess, there is no backwards compatibility, and the code
is just misleading.
The issue is not so much where the calls go rather than the fact that the
methods are just behaving inconsistently.
So I would suggest the following:
have one single method to do this. Keep the one in LDAPAuthenticationModule but
have it strictly delegate to the LDAPUtils method.
arguably we already broke backwards compatibility, but I'd rather restore it
for people who have not upgraded yet ? (and fix the comment)
look at calls to LDAPUtils#getJNDIConfig and fix exception handling. I've seen
a few e.printStackTrace() - at the very least, log the exception in error, or
better yet, let it go up stack.
If we don't restore backwards compatibility, then
http://documentation.magnolia-cms.com/releases/4-5-1.html#IfyouareusingtheLDAPConnectormodule
should not say ".. is now configurable in .." but "must now be configured in
...".
While we're at it: docu says jndi.ldap.config should be relative to the
web-app. In fact, it looks it can also be an absolute path, or use
{{\${magnolia.home}}} like other path properties. This should be verified and
documented.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details, see: http://www.magnolia-cms.com/community/mailing-lists.html
Alternatively, use our forums: http://forum.magnolia-cms.com/
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
