wt.dataops.archivesystem
Class WTArchiveSystemHelper

java.lang.Object
  wt.dataops.archivesystem.WTArchiveSystemHelper

All Implemented Interfaces:

Externalizable, Serializable

public class WTArchiveSystemHelper

extends Object

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	archivePropFile
private static String	basicHintsFile
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private static String	hintsDir
private static String	LIBDIR
private static String	localGuid
protected static long	OLD_FORMAT_VERSION_UID
private static Map	prefNodeMap
private static String	RESOURCE
private static String	ROOT
private static String	searchHintsFileName
private static String	searchHintsFileNameSuffix
private static String	secondaryHintsFile
(package private) static long	serialVersionUID
private static boolean	VERBOSE
private static String	WT_HOME
private static String	wthome

Constructor Summary

WTArchiveSystemHelper()

Method Summary

private static String[]	convertToStringArray(String inStr, String token)
private static void	createPref(WTPreferences prefs, String prefName, String value)
static long	getArchiveRetentionPeriod() Supported API: false
static long	getArchiveRetentionPeriod(WTArchiveType archiveType) Supported API: false
static String[]	getArchiveSearchVolumes() Supported API: false
static String[]	getArchiveSearchVolumes(WTArchiveType archiveType) Supported API: false
static WTArchiveSystem	getArchiveSystemImpl() Supported API: false
static WTArchiveSystem	getArchiveSystemImpl(WTArchiveType archiveType) Supported API: false
static String	getArchiveVolume() Supported API: false
static String	getArchiveVolume(WTArchiveType archiveType) Supported API: false
static String	getArchiveWhereClause(String keyword, String searchType, String initialWhereClause) Given keyword, archived object type and an archived object where clause, produce a where clause to return the appropiate archives from the windchill search.
static File	getBasicHintsFile() Supported API: false
private static WTArchiveType	getDefaultArchiveSystemType()
static String	getHintsDir() Supported API: false
private static String	getImplPrefNodeName(WTArchiveType aType)
private static WTPreferences	getPrefNode(String nodeName, String impl)
private static WTPreferences	getPrefNode(WTArchiveType aType)
static long	getRetentionPeriodInSec() Supported API: false
private static File	getSearchHintsFile()
static File	getSecondaryHintsFile() Supported API: false
static String	getSourceSystemIdentity() gets the value of the guid of the local Repository object.
static boolean	isArchiveSystemInstalled() Supported API: false
static boolean	isArchiveSystemInstalled(WTArchiveType arType) Supported API: false
private static boolean	isCYAArchiveSystemInstalled()
private static boolean	isFileArchiveSystemInstalled()
static WTProperties	loadArchiveSystemProperties(WTProperties prop)
static void	loadFromProperties(WTArchiveType wtat)
private static void	loadPrefs(WTArchiveType aType, HashMap in)
static void	main(String[] args)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WTArchiveSystemHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static ArchiveResident[]	searchArchivedObjects(String any, String searchType, String searchString) Supported API: false
private static String	transform(String in)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

CLASSNAME

private static final String CLASSNAME

prefNodeMap

private static Map prefNodeMap

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

ROOT

private static final String ROOT

See Also:

Constant Field Values

WT_HOME

private static final String WT_HOME

See Also:

Constant Field Values

LIBDIR

private static final String LIBDIR

See Also:

Constant Field Values

localGuid

private static String localGuid

VERBOSE

private static boolean VERBOSE

searchHintsFileName

private static String searchHintsFileName

searchHintsFileNameSuffix

private static final String searchHintsFileNameSuffix

See Also:

Constant Field Values

hintsDir

private static String hintsDir

basicHintsFile

private static String basicHintsFile

secondaryHintsFile

private static String secondaryHintsFile

wthome

private static String wthome

archivePropFile

private static String archivePropFile

Constructor Detail

WTArchiveSystemHelper

public WTArchiveSystemHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTArchiveSystemHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

searchArchivedObjects

public static ArchiveResident[] searchArchivedObjects(String any,
                                                      String searchType,
                                                      String searchString)
                                               throws WTArchiveSystemException

Supported API: false

Parameters:

any -

searchType -

searchString -

Returns:

ArchiveResident[]

Throws:

WTArchiveSystemException

getArchiveSearchVolumes

public static String[] getArchiveSearchVolumes(WTArchiveType archiveType)
                                        throws WTArchiveSystemException

Supported API: false

Parameters:

archiveType -

Returns:

String[]

Throws:

WTArchiveSystemException

getArchiveVolume

public static String getArchiveVolume(WTArchiveType archiveType)
                               throws WTArchiveSystemException

Supported API: false

Parameters:

archiveType -

Returns:

String

Throws:

WTArchiveSystemException

getArchiveRetentionPeriod

public static long getArchiveRetentionPeriod(WTArchiveType archiveType)
                                      throws WTArchiveSystemException

Supported API: false

Parameters:

archiveType -

Returns:

long

Throws:

WTArchiveSystemException

getArchiveSystemImpl

public static WTArchiveSystem getArchiveSystemImpl()
                                            throws WTArchiveSystemException

Supported API: false

Returns:

WTArchiveSystem

Throws:

WTArchiveSystemException

getArchiveSystemImpl

public static WTArchiveSystem getArchiveSystemImpl(WTArchiveType archiveType)
                                            throws WTArchiveSystemException

Supported API: false

Parameters:

archiveType -

Returns:

WTArchiveSystem

Throws:

WTArchiveSystemException

getSourceSystemIdentity

public static String getSourceSystemIdentity()
                                      throws WTArchiveSystemException

gets the value of the guid of the local Repository object. This value can be used to identify a source system with the Archive System

Supported API: false

Returns:

String

Throws:

WTArchiveSystemException

getArchiveVolume

public static String getArchiveVolume()
                               throws WTArchiveSystemException

Supported API: false

Returns:

String

Throws:

WTArchiveSystemException

getArchiveSearchVolumes

public static String[] getArchiveSearchVolumes()
                                        throws WTArchiveSystemException

Supported API: false

Returns:

String[]

Throws:

WTArchiveSystemException

getArchiveRetentionPeriod

public static long getArchiveRetentionPeriod()
                                      throws WTArchiveSystemException

Supported API: false

Returns:

long

Throws:

WTArchiveSystemException

isArchiveSystemInstalled

public static boolean isArchiveSystemInstalled()

Supported API: false

Returns:

boolean

isArchiveSystemInstalled

public static boolean isArchiveSystemInstalled(WTArchiveType arType)

Supported API: false

Parameters:

arType -

Returns:

boolean

getBasicHintsFile

public static File getBasicHintsFile()
                              throws WTArchiveSystemException

Supported API: false

Returns:

File

Throws:

WTArchiveSystemException

getSecondaryHintsFile

public static File getSecondaryHintsFile()
                                  throws WTArchiveSystemException

Supported API: false

Returns:

File

Throws:

WTArchiveSystemException

getHintsDir

public static String getHintsDir()

Supported API: false

Returns:

String

getRetentionPeriodInSec

public static long getRetentionPeriodInSec()
                                    throws WTArchiveSystemException

Supported API: false

Returns:

long

Throws:

WTArchiveSystemException

getImplPrefNodeName

private static String getImplPrefNodeName(WTArchiveType aType)

getPrefNode

private static WTPreferences getPrefNode(WTArchiveType aType)

getPrefNode

private static WTPreferences getPrefNode(String nodeName,
                                         String impl)

convertToStringArray

private static String[] convertToStringArray(String inStr,
                                             String token)

getDefaultArchiveSystemType

private static WTArchiveType getDefaultArchiveSystemType()

loadPrefs

private static void loadPrefs(WTArchiveType aType,
                              HashMap in)
                       throws WTArchiveSystemException

Throws:

WTArchiveSystemException

createPref

private static void createPref(WTPreferences prefs,
                               String prefName,
                               String value)
                        throws WTArchiveSystemException

Throws:

WTArchiveSystemException

loadFromProperties

public static void loadFromProperties(WTArchiveType wtat)
                               throws WTArchiveSystemException

Throws:

WTArchiveSystemException

getSearchHintsFile

private static File getSearchHintsFile()
                                throws WTArchiveSystemException

Throws:

WTArchiveSystemException

main

public static void main(String[] args)

isCYAArchiveSystemInstalled

private static boolean isCYAArchiveSystemInstalled()

isFileArchiveSystemInstalled

private static boolean isFileArchiveSystemInstalled()

loadArchiveSystemProperties

public static WTProperties loadArchiveSystemProperties(WTProperties prop)
                                                throws WTArchiveSystemException

Throws:

WTArchiveSystemException

getArchiveWhereClause

public static String getArchiveWhereClause(String keyword,
                                           String searchType,
                                           String initialWhereClause)
                                    throws WTException

Given keyword, archived object type and an archived object where clause, produce a where clause to return the appropiate archives from the windchill search.

Supported API: false

Parameters:

keyword -

searchType -

initialWhereClause -

Returns:

String

Throws:

WTException

transform

private static String transform(String in)