Bug 1252699 - [QE] InitialContext properties listed in LDAP login modules
Summary: [QE] InitialContext properties listed in LDAP login modules
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: post-GA
: ---
Assignee: Zach Rhoads
QA Contact: Josef Cacek
URL: https://access.stage.redhat.com/docum...
Whiteboard:
Depends On:
Blocks: 1233012
TreeView+ depends on / blocked
 
Reported: 2015-08-12 06:23 UTC by Josef Cacek
Modified: 2015-10-20 12:58 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2015-10-20 12:58:04 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Josef Cacek 2015-08-12 06:23:23 UTC
Book: Login Module Reference
Revision: n_1575841_login-module-reference_version_6.4_edition_1.0_release_0-revision_6701191
Section: LDAP login modules (Ldap, LdapExtended, AdvancedLdap, AdvancedADLdap)

Issue description:
The guide describes (some) LDAP context environment properties as module options for (some) LDAP login modules.

The description of LDAP context related properties should be unified across all the LDAP login modules. The LDAP context related properties (provided as module options for LDAP login modules) should not be described in the LDAP login module descriptions. It should only be mentioned that they are related to LDAP Context implementation used. The default and most common options can be referrenced by a link to the javax.naming.Context interface JavaDoc.

What's important to know about the LDAP context and the related logic in the login modules is:
- all login modules options are provided as environment properties when creating instance of javax.naming.ldap.InitialLdapContext object
- the initial context implementation used depends on the initial context factory method configured. The initial context factory classname itself is also configured by environment property and therefore also by login module option with the same name.  Property name is "java.naming.factory.initial" and it is defined and described in INITIAL_CONTEXT_FACTORY constant of javax.naming.Context interface.
- the initial context factory gets its configuration from environment properties provided. So there can be arbitrary properties (and related login module options) for custom initial context factories.

Suggestions for improvement:
Put description of handling the InitialLdapContext environment properties as LDAP login module options to one common place. Put there a note that it's related to LDAP login modules - Ldap, LdapExtended, AdvancedLdap, AdvancedADLdap.
Remove from LDAP login modules descriptions the login module options comming from javax.naming.Context interface.

Comment 3 Josef Cacek 2015-08-25 09:02:15 UTC
Verified in Login Module Reference. Thanks for the fix.

Revision: n_1601531_login-module-reference_version_6.4_edition_1.0_release_0-revision_6840221


Note You need to log in before you can comment on or make changes to this bug.