org.aselect.server.attributes.requestors
Interface IAttributeRequestor

All Known Implementing Classes:
APIAttributeRequestor, FlatFileAttributeRequestor, GenericAttributeRequestor, JDBCAttributeRequestor, JNDIAttributeRequestor, OpaqueAttributeRequestor, TGTAttributeRequestor

public interface IAttributeRequestor

The interface for Attribute Requestors.

Description:
An Attribute Requestor's job is to obtain attributes associated with a certain user id (UID).

They are used as follows:
The AttributeGatherer instantiates each configured Attribute Requestor, invokes its getAttributes() method, and processes the result. Therefore, an Attribute Requestor object does not have to be reusable. They are destroyed once they have done their job.

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 void destroy()
          Clean up used resources.
 java.util.Hashtable getAttributes(java.util.Hashtable htTGTContext, java.util.Vector vAttributes)
          Retrieve the specified attributes.
 void init(java.lang.Object oConfig)
          Initialize the IAttributeRequestor implementation.
 

Method Detail

init

void init(java.lang.Object oConfig)
          throws ASelectException
Initialize the IAttributeRequestor implementation.

Parameters:
oConfig - The configuration section to use.
Throws:
ASelectException - If configuration fails.

getAttributes

java.util.Hashtable getAttributes(java.util.Hashtable htTGTContext,
                                  java.util.Vector vAttributes)
                                  throws ASelectAttributesException
Retrieve the specified attributes.

Description:
Retrieve all known attributes or attributes that are specified in vAttributes.

Concurrency issues:
Must be a threadsafe implementation.

Preconditions:
Postconditions:
-

Parameters:
htTGTContext - the TGT context.
vAttributes - The attributes to gather.
Returns:
The retrieved attributes.
Throws:
ASelectAttributesException - If gathering fails.

destroy

void destroy()
Clean up used resources.

Description:
Close all resources and stop running threads if applicable.

Concurrency issues:
-

Preconditions:
-

Postconditions:
The IAttributeRequestor implementation is stopped.



Copyright © 2008 SURFnet BV. All Rights Reserved.