com.bea.security.providers.authorization.asi
Interface AttributeRetriever

public interface AttributeRetriever

Interface for performing attribute retrieval, an implementation of an AttributeRetriever may be used to get embedded data from complex data objects. For instance if the ContextHandler included a address element, the zipcode portion could be made individually available using an AttributeRetriever. It is generally not necessary to write retrievers for objects which appear directly in the ContextHandler, retrievers are used to extract embedded, or otherwise unaccessible data. Multiple retrievers may be registered for the same attribute name, they will be called in order until one returns a non-null result.

Author:

Copyright © 2006 BEA Systems, Inc. All Rights Reserved.

Method Summary

java.lang.Object	getAttributeValue(java.lang.String name, javax.security.auth.Subject subject, java.util.Map roles, weblogic.security.spi.Resource resource, weblogic.security.service.ContextHandler contextHandler) retrieve the value of the named attribute.
java.lang.String[]	getHandledAttributeNames() Returns the names of attributes handled by this object.

Method Detail

getHandledAttributeNames

public java.lang.String[] getHandledAttributeNames()

Returns the names of attributes handled by this object. An empty or null value indicates that the retriever will be considered capable of handling any attribute name.

Returns:

the names associated with this object

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String name,
                                          javax.security.auth.Subject subject,
                                          java.util.Map roles,
                                          weblogic.security.spi.Resource resource,
                                          weblogic.security.service.ContextHandler contextHandler)

retrieve the value of the named attribute. Additional authorization request data is made available to allow for more complex attribute retrieval.

Parameters:

name - the name of the needed attribute

subject - the subject associated with the request

roles - the role membership of the subject, or null if this is a role mapping call

resource - the resource associated with the request

contextHandler - the context associated with the request, may be null if non-existant

Returns:

the attributes value, or null if not found