Package wt.federation

Class FederatedDirectoryService

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.fc._Item

wt.fc.Item

wt.federation._FederatedDirectoryService

wt.federation.FederatedDirectoryService

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, _FederatedService, FederatedService, DisplayIdentification, RemoteAccess

@GenAsPersistable(superClass=Item.class,interfaces={RemoteAccess.class,FederatedService.class},versions=-7204037224265375139L,properties={@GeneratedProperty(name="translationTableName",type=java.lang.String.class),@GeneratedProperty(name="initialContextFactory",type=java.lang.String.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="searchBase",type=java.lang.String.class),@GeneratedProperty(name="searchScope",type=java.lang.String.class),@GeneratedProperty(name="directoryAccessDN",type=java.lang.String.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="directoryAccessCredentials",type=java.lang.Object.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(columnType=BLOB)),@GeneratedProperty(name="entryCacheTTL",type=long.class),@GeneratedProperty(name="entryCacheSize",type=int.class),@GeneratedProperty(name="searchResultsCacheTTL",type=long.class),@GeneratedProperty(name="searchResultsCacheSize",type=int.class)})
public class FederatedDirectoryService
extends _FederatedDirectoryService

This class implements a Federated interface to directory services such as LDAP-accessible directory services.

Use the newFederatedDirectoryService static factory method(s), not the FederatedDirectoryService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.federation._FederatedDirectoryService

DIRECTORY_ACCESS_CREDENTIALS, DIRECTORY_ACCESS_DN, INITIAL_CONTEXT_FACTORY

Fields inherited from interface wt.federation._FederatedService

SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
QueryResult	findDirectoryObjects(String url)	Search the directory service for entries matching the criteria specified in the given LDAP url, and return a QueryResult containing objects corresponding to the matching entries.
QueryResult	findDirectoryObjects(String filterName, Hashtable filterArguments)	Search the directory service for entries matching the specified filter, and return a QueryResult containing objects corresponding to the matching entries.
DirectoryTranslationTable	getTranslationTable()	Return an instance of the attribute translation table referenced by this directory service.
protected void	initialize()	Supports initialization, following construction of an instance.
protected void	initialize(String serviceName)	Supports initialization, following construction of an instance.
protected void	initialize(String serviceName, String serviceURL, String searchBase, String translationTableName)	Supports initialization, following construction of an instance.
protected void	initialize(String serviceName, String serviceURL, String searchBase, String translationTableName, String initialContextFactory)	Supports initialization, following construction of an instance.
static FederatedDirectoryService	newFederatedDirectoryService()	Constructor returning an instance initialized with default property values.
static FederatedDirectoryService	newFederatedDirectoryService(String serviceName)	Constructor returning an instance initialized with a specified service name, default initial context factory, and no directory attribute translation table.
static FederatedDirectoryService	newFederatedDirectoryService(String serviceName, String serviceURL, String searchBase, String translationTableName)	Constructor returning an instance initialized with a specified service name, base service URL, directory search base, and translation table name.
static FederatedDirectoryService	newFederatedDirectoryService(String serviceName, String serviceURL, String searchBase, String translationTableName, String initialContextFactory)	Constructor returning an instance initialized with a specified service name, base service URL, directory search base, translation table name, and initial directory context factory value.
void	refreshDirectoryObject(Federated proxy)	Refreshes the derived properties of a specified proxy object.
Hashtable	retrieveDirectoryAttributes(String distinguishedName)	Return a Hashtable containing all of the directory attributes read from the specified directory entry.
Object	retrieveDirectoryObject(String distinguishedName)	Returns a Federated instance of the directory object identified by the specified distinguished name.

Methods inherited from class wt.federation._FederatedDirectoryService

getDirectoryAccessCredentials, getDirectoryAccessDN, getInitialContextFactory, getServiceName, setDirectoryAccessCredentials, setDirectoryAccessDN, setInitialContextFactory, setServiceName

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newFederatedDirectoryService

public static FederatedDirectoryService newFederatedDirectoryService(String serviceName,
 String serviceURL,
 String searchBase,
 String translationTableName)
                                                              throws FederationServicesException

Constructor returning an instance initialized with a specified service name, base service URL, directory search base, and translation table name.

Supported API: true

Parameters:

serviceName -

serviceURL -

searchBase -

translationTableName -

Returns:

FederatedDirectoryService

Throws:

FederationServicesException

initialize

protected void initialize(String serviceName,
 String serviceURL,
 String searchBase,
 String translationTableName)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

serviceName -

serviceURL -

searchBase -

translationTableName -

Throws:

FederationServicesException

newFederatedDirectoryService

public static FederatedDirectoryService newFederatedDirectoryService(String serviceName,
 String serviceURL,
 String searchBase,
 String translationTableName,
 String initialContextFactory)
                                                              throws FederationServicesException

Constructor returning an instance initialized with a specified service name, base service URL, directory search base, translation table name, and initial directory context factory value.

Supported API: true

Parameters:

serviceName -

serviceURL -

searchBase -

translationTableName -

initialContextFactory -

Returns:

FederatedDirectoryService

Throws:

FederationServicesException

initialize

protected void initialize(String serviceName,
 String serviceURL,
 String searchBase,
 String translationTableName,
 String initialContextFactory)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

serviceName -

serviceURL -

searchBase -

translationTableName -

initialContextFactory -

Throws:

FederationServicesException

newFederatedDirectoryService

public static FederatedDirectoryService newFederatedDirectoryService(String serviceName)
                                                              throws FederationServicesException

Constructor returning an instance initialized with a specified service name, default initial context factory, and no directory attribute translation table.

Supported API: true

Parameters:

serviceName -

Returns:

FederatedDirectoryService

Throws:

FederationServicesException

initialize

protected void initialize(String serviceName)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

serviceName -

Throws:

FederationServicesException

newFederatedDirectoryService

public static FederatedDirectoryService newFederatedDirectoryService()
                                                              throws FederationServicesException,
WTException

Constructor returning an instance initialized with default property values.

Supported API: true

Returns:

FederatedDirectoryService

Throws:

FederationServicesException

WTException

retrieveDirectoryObject

public Object retrieveDirectoryObject(String distinguishedName)
                               throws FederationServicesException,
WTException

Returns a Federated instance of the directory object identified by the specified distinguished name.

Supported API: true

Parameters:

distinguishedName -

Returns:

Object

Throws:

FederationServicesException

WTException

refreshDirectoryObject

public void refreshDirectoryObject(Federated proxy)
                            throws FederationServicesException,
WTException

Refreshes the derived properties of a specified proxy object.

Supported API: true

Parameters:

proxy -

Throws:

FederationServicesException

WTException

findDirectoryObjects

public QueryResult findDirectoryObjects(String filterName,
 Hashtable filterArguments)
                                 throws FederationServicesException,
WTException

Search the directory service for entries matching the specified filter, and return a QueryResult containing objects corresponding to the matching entries.

Supported API: true

Parameters:

filterName -

filterArguments -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

findDirectoryObjects

public QueryResult findDirectoryObjects(String url)
                                 throws FederationServicesException,
WTException

Search the directory service for entries matching the criteria specified in the given LDAP url, and return a QueryResult containing objects corresponding to the matching entries.

Supported API: true

Parameters:

url -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

getTranslationTable

public DirectoryTranslationTable getTranslationTable()
                                              throws FederationServicesException

Return an instance of the attribute translation table referenced by this directory service.

Supported API: true

Returns:

DirectoryTranslationTable

Throws:

FederationServicesException

retrieveDirectoryAttributes

public Hashtable retrieveDirectoryAttributes(String distinguishedName)
                                      throws FederationServicesException,
WTException

Return a Hashtable containing all of the directory attributes read from the specified directory entry.

Supported API: true

Parameters:

distinguishedName -

Returns:

Hashtable

Throws:

FederationServicesException

WTException

initialize

protected void initialize()
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Overrides:

initialize in class Item

Throws:

FederationServicesException