wt.federation.admin
Class FederationAdminUtilities

java.lang.Object
  wt.federation.admin.FederationAdminUtilities

public class FederationAdminUtilities

extends Object

FederationAdminUtilities provides class methods that perform utility functions supporting the Federation Administrator.

Field Summary

private static Hashtable	attributeMappingTable
private static Hashtable	baseClassTable
private static String	DELIMITER
private static String	FEDERATION_RESOURCE
private static Hashtable	groupTable
private static Hashtable	labelKeyTable
private static Hashtable	prefixTable
private static Hashtable	proxyClassTable
private static String	RESOURCE
private static Hashtable	sourceObjectIdTable
private static Hashtable	sourceObjectUrlTable
private static boolean	VERBOSE

Constructor Summary

FederationAdminUtilities()

Method Summary

static String	getActionURLTemplate(String serviceType, String systemType, String actionName) Gets a URL template for a specified service type, system type, and action name.
static Hashtable	getAttributeMappings(String serviceType, String systemType, String classType) Gets a table of attribute mappings associated with a specified service type, system type, and class.
static String	getClassMappings(String serviceType, String systemType, String classType) Gets the Directory class names or Info*Engine group name for objects of the specified service type, system type, and object class.
static String	getFormVariablePrefix(String serviceType, String systemType, String classType) Gets the form variable prefix for objects of the specified service type, system type, and base object class.
static String	getLocalizedLabel(String serviceType, String systemType, String classType, Locale locale) Gets the localized label associated with the specified service type, system type, and class type.
static String	getLocalizedSystemType(String serviceType, String systemType, Locale locale) Gets the localized name associated with the specified service type and system type.
static String	getProxyClass(String serviceType, String systemType, String classType) Gets the Windchill proxy class name for objects of the specified service type, system type, and base object class.
static String	getSourceObjectIdPattern(String serviceType, String systemType, String classType) Gets a source object identifier pattern for a specified service type and system type.
static String	getSourceObjectURLPattern(String serviceType, String systemType, String classType) Gets a source object URL pattern for a specified service type and system type.
static Enumeration	getSupportedActions(String serviceType, String systemType) Returns the enumeration of action names supported by a specified service type and system type.
static Enumeration	getSupportedClasses(String serviceType, String systemType) Returns an enumeration of the classes supported by a specified service and system type.
static Enumeration	getSupportedSystemTypes(String serviceType) Returns an enumeration of the system types supported by a specified service type.
static String	getWindchillClass(String serviceType, String systemType, String classType) Gets the Windchill class name for objects of the specified service type, system type, and logical object class.
private static void	initializeMappingTables() Initializes the class mapping tables.
static String	parseClassFilter(String filter) Gets a string containing a class filter, parses the filter, and returns a comma separated list of objects classes.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

FEDERATION_RESOURCE

private static final String FEDERATION_RESOURCE

See Also:

Constant Field Values

DELIMITER

private static final String DELIMITER

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

attributeMappingTable

private static Hashtable attributeMappingTable

baseClassTable

private static Hashtable baseClassTable

groupTable

private static Hashtable groupTable

labelKeyTable

private static Hashtable labelKeyTable

prefixTable

private static Hashtable prefixTable

proxyClassTable

private static Hashtable proxyClassTable

sourceObjectIdTable

private static Hashtable sourceObjectIdTable

sourceObjectUrlTable

private static Hashtable sourceObjectUrlTable

Constructor Detail

FederationAdminUtilities

public FederationAdminUtilities()

Method Detail

getSupportedSystemTypes

public static Enumeration getSupportedSystemTypes(String serviceType)
                                           throws WTException

Returns an enumeration of the system types supported by a specified service type.

Supported API: false

Parameters:

serviceType - type of federated service

Returns:

Enumeration containing the logical class names supported

Throws:

WTException

getLocalizedSystemType

public static String getLocalizedSystemType(String serviceType,
                                            String systemType,
                                            Locale locale)
                                     throws WTException

Gets the localized name associated with the specified service type and system type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

locale - the locale for which to produce a localized name

Returns:

String containing the localized label

Throws:

WTException

getWindchillClass

public static String getWindchillClass(String serviceType,
                                       String systemType,
                                       String classType)
                                throws WTException

Gets the Windchill class name for objects of the specified service type, system type, and logical object class.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a base Windchill class is wanted

Returns:

String containing a Windchill class name

Throws:

WTException

getProxyClass

public static String getProxyClass(String serviceType,
                                   String systemType,
                                   String classType)
                            throws WTException

Gets the Windchill proxy class name for objects of the specified service type, system type, and base object class.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a proxy class is wanted

Returns:

String containing the name of a Windchill class that implements the Federated interface

Throws:

WTException

getLocalizedLabel

public static String getLocalizedLabel(String serviceType,
                                       String systemType,
                                       String classType,
                                       Locale locale)
                                throws WTException

Gets the localized label associated with the specified service type, system type, and class type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a label is wanted

locale - the locale for which to produce a localized label

Returns:

String containing the localized label

Throws:

WTException

getFormVariablePrefix

public static String getFormVariablePrefix(String serviceType,
                                           String systemType,
                                           String classType)
                                    throws WTException

Gets the form variable prefix for objects of the specified service type, system type, and base object class.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a form variable prefix is wanted

Returns:

String containing the form variable prefix

Throws:

WTException

getClassMappings

public static String getClassMappings(String serviceType,
                                      String systemType,
                                      String classType)
                               throws WTException

Gets the Directory class names or Info*Engine group name for objects of the specified service type, system type, and object class.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a mapping is wanted

Returns:

String containing a comma separated list of directory object classes or an Info*Engine group

Throws:

WTException

getSupportedClasses

public static Enumeration getSupportedClasses(String serviceType,
                                              String systemType)
                                       throws WTException

Returns an enumeration of the classes supported by a specified service and system type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

Returns:

Enumeration containing the logical class names supported

Throws:

WTException

getAttributeMappings

public static Hashtable getAttributeMappings(String serviceType,
                                             String systemType,
                                             String classType)
                                      throws WTException

Gets a table of attribute mappings associated with a specified service type, system type, and class.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which attribute mappings is wanted

Returns:

Hashtable mapping property names to attribute names.

Throws:

WTException

getSourceObjectIdPattern

public static String getSourceObjectIdPattern(String serviceType,
                                              String systemType,
                                              String classType)

Gets a source object identifier pattern for a specified service type and system type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a pattern is wanted

Returns:

String specifying source object identifier pattern

Throws:

WTException

getSourceObjectURLPattern

public static String getSourceObjectURLPattern(String serviceType,
                                               String systemType,
                                               String classType)

Gets a source object URL pattern for a specified service type and system type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

classType - logical name of the object class for which a pattern is wanted

Returns:

String specifying source object URL pattern

Throws:

WTException

getActionURLTemplate

public static String getActionURLTemplate(String serviceType,
                                          String systemType,
                                          String actionName)

Gets a URL template for a specified service type, system type, and action name.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

actionName - name of action for which URL template is wanted

Returns:

String specifying action URL template

Throws:

WTException

getSupportedActions

public static Enumeration getSupportedActions(String serviceType,
                                              String systemType)

Returns the enumeration of action names supported by a specified service type and system type.

Supported API: false

Parameters:

serviceType - type of federated service

systemType - type of system accessed via federated service

Returns:

Enumeration specifying the names of actions supported by the specified service and system type.

Throws:

WTException

parseClassFilter

public static String parseClassFilter(String filter)

Gets a string containing a class filter, parses the filter, and returns a comma separated list of objects classes.

initializeMappingTables

private static void initializeMappingTables()

Initializes the class mapping tables.