org.jboss.security.xacml.locators.attrib

Class LDAPAttributeLocator

java.lang.Object

org.jboss.security.xacml.sunxacml.finder.AttributeFinderModule

org.jboss.security.xacml.locators.AttributeLocator

org.jboss.security.xacml.locators.attrib.StorageAttributeLocator

org.jboss.security.xacml.locators.attrib.LDAPAttributeLocator

All Implemented Interfaces:

AbstractLocator, ContextMapOp

Direct Known Subclasses:

LDAPActionAttributeLocator, LDAPEnvAttributeLocator, LDAPResourceAttributeLocator, LDAPSubjectAttributeLocator

public abstract class LDAPAttributeLocator
extends StorageAttributeLocator

An attribute locator getting attribute values from an LDAP Configuration: url - The LDAP server URL to connect to.
factory - The JNDI factory that is JDK specific such as "com.sun.jndi.ldap.LdapCtxFactory" which is the default.
username - The username to connect to the LDAP server. This user must have search privileges
password - The password of the user to connect to the LDAP server
filter - The search filter to be used to find the entries that have a policy
attribute - The name of the entry's attribute
searchScope - Scope of the search for entries. Default is SUBTREE
searchTimeLimit - Search time limit. Default is 10000 (10 seconds)
attributeSupportedId : Attribute that is supported by this locator for retrieval.
substituteValue : This is the URI of the attribute available from the request that will be plugged into the ldap filter wildcard.
valueDataType: The data type of the attribute that is being plugged into the filter of the wildcard.
name : the fully qualified name (FQN) of the class.
Masking the LDAP Password
Additionally, The password value can be masked using PBE.
To create a masked password invoke org.jboss.security.xacml.util.PBEUtils salt iterationCount password
When using a masked password add also the options
salt - the 8 character String
iterationCount - an integer
NOTE: Those options must have the same value used for encryption.

Since:

Aug 25, 2010

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected LDAPCommon	ldapCommon

Fields inherited from class org.jboss.security.xacml.locators.attrib.StorageAttributeLocator

attributeValue, dataTypeOfSubstituteValue, substituteValue

Fields inherited from class org.jboss.security.xacml.locators.AttributeLocator

attributeDesignatorSupported, attributeSelectorSupported, designatorTypes, identifier, ids, map, options

Fields inherited from interface org.jboss.security.xacml.interfaces.AbstractLocator

ATTRIBUTE_DESIGNATOR_INTEGER_TAG, ATTRIBUTE_DESIGNATOR_SUPPORT_TAG, ATTRIBUTE_SELECTOR_SUPPORT_TAG, ATTRIBUTE_SUPPORTED_ID_TAG, IDENTIFIER_TAG, RESOURCE_CHILD_SUPPORTED_TAG, RESOURCE_DESCENDANT_SUPPORTED_TAG

Constructor Summary

Constructors

Constructor and Description
LDAPAttributeLocator()

Method Summary

Methods

Modifier and Type	Method and Description
EvaluationResult	findAttribute(URI attributeType, URI attributeId, URI issuer, URI subjectCategory, EvaluationCtx context, int designatorType) Tries to find attribute values based on the given designator data.
void	setOptions(List<Option> theoptions) Set a list of options on the locator
protected void	usePassedOption(String optionTag, String optionValue) An opportunity for sub-classes to process the passed option tag and value

Methods inherited from class org.jboss.security.xacml.locators.attrib.StorageAttributeLocator

getSubstituteValue

Methods inherited from class org.jboss.security.xacml.locators.AttributeLocator

get, getAttributeValue, getIdentifier, getOptionValue, getSupportedDesignatorTypes, getSupportedIds, isDesignatorSupported, isSelectorSupported, set

Methods inherited from class org.jboss.security.xacml.sunxacml.finder.AttributeFinderModule

findAttribute, invalidateCache

Methods inherited from class java.lang.Object

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

Field Detail

ldapCommon

protected LDAPCommon ldapCommon

Constructor Detail

LDAPAttributeLocator

public LDAPAttributeLocator()

Method Detail

setOptions

public void setOptions(List<Option> theoptions)

Description copied from interface: AbstractLocator

Set a list of options on the locator

Specified by:

setOptions in interface AbstractLocator

Overrides:

setOptions in class AttributeLocator

findAttribute

public EvaluationResult findAttribute(URI attributeType,
                             URI attributeId,
                             URI issuer,
                             URI subjectCategory,
                             EvaluationCtx context,
                             int designatorType)

Description copied from class: AttributeFinderModule

Tries to find attribute values based on the given designator data. The result, if successful, must always contain a BagAttribute, even if only one value was found. If no values were found, but no other error occurred, an empty bag is returned. This method may need to invoke the context data to look for other attribute values, so a module writer must take care not to create a scenario that loops forever.

Overrides:

findAttribute in class AttributeFinderModule

Parameters:

attributeType - the datatype of the attributes to find

attributeId - the identifier of the attributes to find

issuer - the issuer of the attributes, or null if unspecified

subjectCategory - the category of the attribute if the designatorType is SUBJECT_TARGET, otherwise null

context - the representation of the request data

designatorType - the type of designator as named by the *_TARGET fields in AttributeDesignator

Returns:

the result of attribute retrieval, which will be a bag of attributes or an error

usePassedOption

protected void usePassedOption(String optionTag,
                   String optionValue)

Description copied from class: AttributeLocator

An opportunity for sub-classes to process the passed option tag and value

NOTE: Subclasses should override this method and allow super class processing before their own processing in the method via the super.usePassedOption() call.

Overrides:

usePassedOption in class AttributeLocator