com.ptc.windchill.structconf.xconf
Class XconfUtil

java.lang.Object
  com.ptc.windchill.structconf.xconf.XconfUtil

public class XconfUtil

extends Object

Constants, getters, and canned parsing utility methods.

Field Summary

static String	ADD_TO_PROPERTY_ELEM
static String	CLASS_PATH_ENTRY_DIR_ATTR
static String	CLASS_PATH_ENTRY_ELEM
static String	CLASS_PATH_ENTRY_FILE_ATTR
static String	CONFIGURATION_ELEM
static String	CONFIGURATION_REF_ELEM
static String	CONFIGURATION_REF_HREF_ATTR
static String	FILE_EXTENSION Declaration
static String	PROPAGATION_ACTION_CLASS_NAME_ATTR
static String	PROPAGATION_ACTION_ELEM
static String	PROPERTY_DECLARED_DEFAULT_ATTR
static String	PROPERTY_DECLARED_MULTIVALUED_ATTR
static String	PROPERTY_DECLARED_OVERRIDABLE_ATTR
static boolean	PROPERTY_DECLARED_OVERRIDABLE_ATTR_DEFAULT
static String	PROPERTY_DECLARED_UNIX_DEFAULT_ATTR
static String	PROPERTY_DECLARED_WINDOWS_DEFAULT_ATTR
static String	PROPERTY_DOC_CATEGORY_ATTR
static String	PROPERTY_DOC_DEPRECATION_ELEM
static String	PROPERTY_DOC_DESCRIPTION_ELEM
static String	PROPERTY_DOC_ELEM
static String	PROPERTY_DOC_KEY_ATTR
static String	PROPERTY_DOC_SYNOPSIS_ELEM
static String	PROPERTY_ELEM
static String	PROPERTY_NAME_ATTR
static String	PROPERTY_SITE_VALUE_ATTR
static String	REMOVE_FROM_PROPERTY_ELEM
static String	RESET_PROPERTY_ELEM
static String	RESET_PROPERTY_NAME_ATTR
static String	RESOURCE_ATTR
static String	RESOURCE_ELEM
private static String	ROOT_XCONF_FILE
static String	SERVICE_CARDINALITY_ATTR
static String	SERVICE_CLASS_ATTR
static String	SERVICE_ELEM
private static String	SITE_ROOT_XCONF_FILE
static String	SVC_RSC_CONTEXT_ATTR
static String	SVC_RSC_NAME_ATTR
static boolean	SVC_RSC_OPTION_DECLARED_OVERRIDABLE_ATTR_DEFAULT
static String	SVC_RSC_OPTION_ELEM
static String	SVC_RSC_ORDER_ATTR
static String	SVC_RSC_REQUESTOR_ATTR
static String	SVC_RSC_SELECTOR_ATTR
static String	TYPE_BASED_CUSTOM_SERVICE_PROVIDER_VALUE
static String	TYPE_BASED_SERVICE_PROVIDER_VALUE
static String	UNDEFINE_PROPERTY_ELEM
static String	UNDEFINE_PROPERTY_NAME_ATTR
static String	WT_CUSTOM_SERVICE_PROVIDER_VALUE
static String	WT_SERVICE_PROVIDER_VALUE
private static String	XCONF_BACKUP_SUBDIR_NAME
static String	XCONF_DTD_FILE_NAME
static String	XCONF_SERVICE_PROVIDER_ATTR
static String	XCONF_TARGET_FILE_ATTR
static String	XLINK_NS_DECL_ATTR
static String	XLINK_NS_URL_VALUE

Constructor Summary

private

XconfUtil() Defined private to prevent it from showing up in the javadoc.

Method Summary

static File	getBackupDirFor(File file)
static File	getDeclarationRootXconfFile()
static File	getProductRootDirectory()
static File	getSiteRootXconfFile()
static File	getTargetRootDirectory()
static void	processAllXconfFiles(XconfHandler handler, int platform_mode) Equivalent of calling processDeclarationXconfFiles(handler) followed by processSiteXconfFiles(handler).
static void	processDeclarationXconfFiles(XconfHandler handler, int platform_mode)
static void	processSiteXconfFiles(XconfHandler handler, int platform_mode)
static void	validateForWellFormednessAndXconfDtdValid(File file, int parser_mode) Attempt to parse the file and ensure that it is well formed and valid.
static void	validateForWellFormednessAndXconfDtdValid(String file_or_url, int parser_mode) Attempt to parse the file (specified using absolute path, relative path from product rool, or fully qualified URL) and ensure that it is well formed and valid.

Methods inherited from class java.lang.Object

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

Field Detail

XCONF_DTD_FILE_NAME

public static final String XCONF_DTD_FILE_NAME

See Also:

Constant Field Values

ROOT_XCONF_FILE

private static final String ROOT_XCONF_FILE

See Also:

Constant Field Values

SITE_ROOT_XCONF_FILE

private static final String SITE_ROOT_XCONF_FILE

See Also:

Constant Field Values

XCONF_BACKUP_SUBDIR_NAME

private static final String XCONF_BACKUP_SUBDIR_NAME

See Also:

Constant Field Values

FILE_EXTENSION

public static final String FILE_EXTENSION

Declaration

See Also:

Constant Field Values

XCONF_TARGET_FILE_ATTR

public static final String XCONF_TARGET_FILE_ATTR

See Also:

Constant Field Values

CONFIGURATION_ELEM

public static final String CONFIGURATION_ELEM

See Also:

Constant Field Values

CONFIGURATION_REF_ELEM

public static final String CONFIGURATION_REF_ELEM

See Also:

Constant Field Values

CONFIGURATION_REF_HREF_ATTR

public static final String CONFIGURATION_REF_HREF_ATTR

See Also:

Constant Field Values

XLINK_NS_DECL_ATTR

public static final String XLINK_NS_DECL_ATTR

See Also:

Constant Field Values

XLINK_NS_URL_VALUE

public static final String XLINK_NS_URL_VALUE

See Also:

Constant Field Values

PROPERTY_ELEM

public static final String PROPERTY_ELEM

See Also:

Constant Field Values

PROPERTY_NAME_ATTR

public static final String PROPERTY_NAME_ATTR

See Also:

Constant Field Values

PROPERTY_SITE_VALUE_ATTR

public static final String PROPERTY_SITE_VALUE_ATTR

See Also:

Constant Field Values

PROPERTY_DECLARED_DEFAULT_ATTR

public static final String PROPERTY_DECLARED_DEFAULT_ATTR

See Also:

Constant Field Values

PROPERTY_DECLARED_UNIX_DEFAULT_ATTR

public static final String PROPERTY_DECLARED_UNIX_DEFAULT_ATTR

See Also:

Constant Field Values

PROPERTY_DECLARED_WINDOWS_DEFAULT_ATTR

public static final String PROPERTY_DECLARED_WINDOWS_DEFAULT_ATTR

See Also:

Constant Field Values

PROPERTY_DECLARED_OVERRIDABLE_ATTR

public static final String PROPERTY_DECLARED_OVERRIDABLE_ATTR

See Also:

Constant Field Values

PROPERTY_DECLARED_OVERRIDABLE_ATTR_DEFAULT

public static final boolean PROPERTY_DECLARED_OVERRIDABLE_ATTR_DEFAULT

See Also:

Constant Field Values

PROPERTY_DECLARED_MULTIVALUED_ATTR

public static final String PROPERTY_DECLARED_MULTIVALUED_ATTR

See Also:

Constant Field Values

ADD_TO_PROPERTY_ELEM

public static final String ADD_TO_PROPERTY_ELEM

See Also:

Constant Field Values

REMOVE_FROM_PROPERTY_ELEM

public static final String REMOVE_FROM_PROPERTY_ELEM

See Also:

Constant Field Values

PROPERTY_DOC_ELEM

public static final String PROPERTY_DOC_ELEM

See Also:

Constant Field Values

PROPERTY_DOC_CATEGORY_ATTR

public static final String PROPERTY_DOC_CATEGORY_ATTR

See Also:

Constant Field Values

PROPERTY_DOC_KEY_ATTR

public static final String PROPERTY_DOC_KEY_ATTR

See Also:

Constant Field Values

PROPERTY_DOC_SYNOPSIS_ELEM

public static final String PROPERTY_DOC_SYNOPSIS_ELEM

See Also:

Constant Field Values

PROPERTY_DOC_DESCRIPTION_ELEM

public static final String PROPERTY_DOC_DESCRIPTION_ELEM

See Also:

Constant Field Values

PROPERTY_DOC_DEPRECATION_ELEM

public static final String PROPERTY_DOC_DEPRECATION_ELEM

See Also:

Constant Field Values

RESET_PROPERTY_ELEM

public static final String RESET_PROPERTY_ELEM

See Also:

Constant Field Values

RESET_PROPERTY_NAME_ATTR

public static final String RESET_PROPERTY_NAME_ATTR

See Also:

Constant Field Values

UNDEFINE_PROPERTY_ELEM

public static final String UNDEFINE_PROPERTY_ELEM

See Also:

Constant Field Values

UNDEFINE_PROPERTY_NAME_ATTR

public static final String UNDEFINE_PROPERTY_NAME_ATTR

See Also:

Constant Field Values

SERVICE_ELEM

public static final String SERVICE_ELEM

See Also:

Constant Field Values

RESOURCE_ELEM

public static final String RESOURCE_ELEM

See Also:

Constant Field Values

SVC_RSC_NAME_ATTR

public static final String SVC_RSC_NAME_ATTR

See Also:

Constant Field Values

SVC_RSC_CONTEXT_ATTR

public static final String SVC_RSC_CONTEXT_ATTR

See Also:

Constant Field Values

SVC_RSC_OPTION_ELEM

public static final String SVC_RSC_OPTION_ELEM

See Also:

Constant Field Values

SVC_RSC_SELECTOR_ATTR

public static final String SVC_RSC_SELECTOR_ATTR

See Also:

Constant Field Values

SVC_RSC_REQUESTOR_ATTR

public static final String SVC_RSC_REQUESTOR_ATTR

See Also:

Constant Field Values

SVC_RSC_ORDER_ATTR

public static final String SVC_RSC_ORDER_ATTR

See Also:

Constant Field Values

SERVICE_CLASS_ATTR

public static final String SERVICE_CLASS_ATTR

See Also:

Constant Field Values

SERVICE_CARDINALITY_ATTR

public static final String SERVICE_CARDINALITY_ATTR

See Also:

Constant Field Values

RESOURCE_ATTR

public static final String RESOURCE_ATTR

See Also:

Constant Field Values

SVC_RSC_OPTION_DECLARED_OVERRIDABLE_ATTR_DEFAULT

public static final boolean SVC_RSC_OPTION_DECLARED_OVERRIDABLE_ATTR_DEFAULT

See Also:

Constant Field Values

XCONF_SERVICE_PROVIDER_ATTR

public static final String XCONF_SERVICE_PROVIDER_ATTR

See Also:

Constant Field Values

WT_SERVICE_PROVIDER_VALUE

public static final String WT_SERVICE_PROVIDER_VALUE

See Also:

Constant Field Values

WT_CUSTOM_SERVICE_PROVIDER_VALUE

public static final String WT_CUSTOM_SERVICE_PROVIDER_VALUE

See Also:

Constant Field Values

TYPE_BASED_SERVICE_PROVIDER_VALUE

public static final String TYPE_BASED_SERVICE_PROVIDER_VALUE

See Also:

Constant Field Values

TYPE_BASED_CUSTOM_SERVICE_PROVIDER_VALUE

public static final String TYPE_BASED_CUSTOM_SERVICE_PROVIDER_VALUE

See Also:

Constant Field Values

PROPAGATION_ACTION_ELEM

public static final String PROPAGATION_ACTION_ELEM

See Also:

Constant Field Values

PROPAGATION_ACTION_CLASS_NAME_ATTR

public static final String PROPAGATION_ACTION_CLASS_NAME_ATTR

See Also:

Constant Field Values

CLASS_PATH_ENTRY_ELEM

public static final String CLASS_PATH_ENTRY_ELEM

See Also:

Constant Field Values

CLASS_PATH_ENTRY_DIR_ATTR

public static final String CLASS_PATH_ENTRY_DIR_ATTR

See Also:

Constant Field Values

CLASS_PATH_ENTRY_FILE_ATTR

public static final String CLASS_PATH_ENTRY_FILE_ATTR

See Also:

Constant Field Values

Constructor Detail

XconfUtil

private XconfUtil()

Defined private to prevent it from showing up in the javadoc.

Method Detail

getBackupDirFor

public static File getBackupDirFor(File file)

getProductRootDirectory

public static File getProductRootDirectory()

getTargetRootDirectory

public static File getTargetRootDirectory()

getDeclarationRootXconfFile

public static File getDeclarationRootXconfFile()

getSiteRootXconfFile

public static File getSiteRootXconfFile()

processDeclarationXconfFiles

public static void processDeclarationXconfFiles(XconfHandler handler,
                                                int platform_mode)
                                         throws XconfException

Throws:

XconfException

processSiteXconfFiles

public static void processSiteXconfFiles(XconfHandler handler,
                                         int platform_mode)
                                  throws XconfException

Throws:

XconfException

processAllXconfFiles

public static void processAllXconfFiles(XconfHandler handler,
                                        int platform_mode)
                                 throws XconfException

Equivalent of calling processDeclarationXconfFiles(handler) followed by processSiteXconfFiles(handler).

Throws:

XconfException

validateForWellFormednessAndXconfDtdValid

public static void validateForWellFormednessAndXconfDtdValid(File file,
                                                             int parser_mode)
                                                      throws XconfException

Attempt to parse the file and ensure that it is well formed and valid.

Throws:

XconfException

validateForWellFormednessAndXconfDtdValid

public static void validateForWellFormednessAndXconfDtdValid(String file_or_url,
                                                             int parser_mode)
                                                      throws XconfException

Attempt to parse the file (specified using absolute path, relative path from product rool, or fully qualified URL) and ensure that it is well formed and valid.

Throws:

XconfException