wt.federation
Class DirectoryTranslationTable

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.federation.DirectoryTranslationTable

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification

public class DirectoryTranslationTable
extends Item
implements Externalizable

Use the newDirectoryTranslationTable static factory method(s), not the DirectoryTranslationTable 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

Method Summary

String	getAttributeForField(Class javaClass, String fieldName) Return the directory attribute name associated with a specified field name of a specified class.
String	getClassFilter(Class javaClass) Return the directory search filter that can be used to find all entries corresponding to the specified Java class.
Hashtable	getClassTable(Class javaClass) Return the Hashtable defining translations between the field names of a specified class and directory attribute names.
Hashtable	getClassTemplate(Class javaClass) Return the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.
Enumeration	getDefinedJavaClasses() Return the enumeration of Java class names for which there are translations to directory object classes.
Class	getJavaClass(String directoryClass) Get the Java class corresponding to a specified directory object class name.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(String name) Supports initialization, following construction of an instance.
static DirectoryTranslationTable	newDirectoryTranslationTable() Constructor returning an instance initialized with default property values.
static DirectoryTranslationTable	newDirectoryTranslationTable(String name) Constructor returning an instance initialized with a specified name and default property values.
void	setAttributeForField(Class javaClass, String fieldName, String attributeName) Set the directory attribute name associated with a specified field name of a specified class.
void	setClassFilter(Class javaClass, String directoryFilter) Set the directory search filter that can be used to find all entries corresponding to the specified Java class.
void	setClassTable(Class javaClass, Hashtable translations) Set the Hashtable defining translations between the field names of a specified class and directory attribute names.
void	setClassTemplate(Class javaClass, Hashtable template) Set the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.
void	setJavaClass(String directoryClass, Class javaClass) Set the Java class associated with a specified directory object class name.

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 Detail

newDirectoryTranslationTable

public static DirectoryTranslationTable newDirectoryTranslationTable()
                                                              throws wt.federation.FederationServicesException

Constructor returning an instance initialized with default property values.

Supported API: true

Returns:

DirectoryTranslationTable

Throws:

wt.federation.FederationServicesException

newDirectoryTranslationTable

public static DirectoryTranslationTable newDirectoryTranslationTable(String name)
                                                              throws wt.federation.FederationServicesException

Constructor returning an instance initialized with a specified name and default property values.

Supported API: true

Parameters:

name -

Returns:

DirectoryTranslationTable

Throws:

wt.federation.FederationServicesException

initialize

protected void initialize(String name)
                   throws wt.federation.FederationServicesException

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

Supported API: true

Parameters:

name -

Throws:

wt.federation.FederationServicesException

getClassFilter

public String getClassFilter(Class javaClass)

Return the directory search filter that can be used to find all entries corresponding to the specified Java class.

Supported API: true

Parameters:

javaClass -

Returns:

String

setClassFilter

public void setClassFilter(Class javaClass,
                           String directoryFilter)

Set the directory search filter that can be used to find all entries corresponding to the specified Java class.

Supported API: true

Parameters:

javaClass -

directoryFilter -

getDefinedJavaClasses

public Enumeration getDefinedJavaClasses()

Return the enumeration of Java class names for which there are translations to directory object classes.

Supported API: true

Returns:

Enumeration

getClassTable

public Hashtable getClassTable(Class javaClass)

Return the Hashtable defining translations between the field names of a specified class and directory attribute names.

Supported API: true

Parameters:

javaClass -

Returns:

Hashtable

setClassTable

public void setClassTable(Class javaClass,
                          Hashtable translations)

Set the Hashtable defining translations between the field names of a specified class and directory attribute names.

Supported API: true

Parameters:

javaClass -

translations -

getJavaClass

public Class getJavaClass(String directoryClass)

Get the Java class corresponding to a specified directory object class name.

Supported API: true

Parameters:

directoryClass -

Returns:

Class

setJavaClass

public void setJavaClass(String directoryClass,
                         Class javaClass)

Set the Java class associated with a specified directory object class name.

Supported API: true

Parameters:

directoryClass -

javaClass -

getAttributeForField

public String getAttributeForField(Class javaClass,
                                   String fieldName)

Return the directory attribute name associated with a specified field name of a specified class.

Supported API: true

Parameters:

javaClass -

fieldName -

Returns:

String

setAttributeForField

public void setAttributeForField(Class javaClass,
                                 String fieldName,
                                 String attributeName)

Set the directory attribute name associated with a specified field name of a specified class.

Supported API: true

Parameters:

javaClass -

fieldName -

attributeName -

getClassTemplate

public Hashtable getClassTemplate(Class javaClass)

Return the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.

Supported API: true

Parameters:

javaClass -

Returns:

Hashtable

setClassTemplate

public void setClassTemplate(Class javaClass,
                             Hashtable template)

Set the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.

Supported API: true

Parameters:

javaClass -

template -

initialize

protected void initialize()
                   throws wt.federation.FederationServicesException

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

Supported API: true

Throws:

wt.federation.FederationServicesException