intradoc.shared
Class DocumentPathBuilder

java.lang.Object
  |
  +--intradoc.shared.DocumentPathBuilder

public class DocumentPathBuilder

extends java.lang.Object

This class is used to help build portions of web urls and portions of document paths. These are the parts of the path that are most likely to be subject to change.

Field Summary

static boolean

m_allLowerCase

Constructor Summary

DocumentPathBuilder()

Method Summary

static java.lang.String	computeRelativeVaultDir(Parameters docInfo) Computes the part of the vault directory path following vault directory.
static java.lang.String	computeRenditionFilename(Parameters docInfo, int counter)
static java.lang.String	computeRenditionFilename(java.lang.String docName, java.lang.String renFlag, java.lang.String revLabel, java.lang.String ext)
static java.lang.String	computeRenditionTail(java.lang.String renFlag, java.lang.String revLabel, java.lang.String ext)
static java.lang.String	computeWebDirPartialPath(DataBinder docInfo, boolean isActive) Computes the directory portion of the portion web URL that follows the relative web root.
static java.lang.String	computeWebDirPartialPath(Parameters docInfo)
static java.lang.String	computeWebDirSecuritySuffix(DataBinder docInfo, boolean isActive) Computes the web directory suffix that the path to include the portion that determines the security of the URL.
static java.lang.String	computeWebDirSecuritySuffix(Parameters docInfo)
static java.lang.String	computeWebDirSuffix(DataBinder docInfo, boolean isActive) This function is also used by the DirectoryLocator service computeWebPathDir since it is the part of the URL that is guaranteed to be shared between the URL and physical file location.
static java.lang.String	computeWebDirSuffix(Parameters docInfo)
static java.lang.String	computeWebFileExtension(Parameters docInfo, boolean isReleased)
static java.lang.String	computeWebUrlDir(DataBinder docInfo, boolean isAbsolute, boolean isActive)
static java.lang.String	computeWebUrlDir(Parameters docInfo, boolean isAbsolute)
protected static java.lang.String	convertToAccountDirStr(java.lang.String acct)
static java.lang.String	extractDocNameFromFileName(java.lang.String filename)
static java.lang.String	extractFileNameFromUrl(java.lang.String path)
static java.lang.String	getAbsoluteWebRoot() Used only web addressing from server other then host machine for weblayout.
static java.lang.String	getBaseAbsoluteRoot() Used as a default as the base part for absolute addresses.
static java.lang.String	getRelativeWebRoot() Computes the relative web root (used as prefix for all web URLs to intradoc controlled URLs).

Methods inherited from class java.lang.Object

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

Field Detail

m_allLowerCase

public static boolean m_allLowerCase

Constructor Detail

DocumentPathBuilder

public DocumentPathBuilder()

Method Detail

getRelativeWebRoot

public static java.lang.String getRelativeWebRoot()

Computes the relative web root (used as prefix for all web URLs to intradoc controlled URLs).

getAbsoluteWebRoot

public static java.lang.String getAbsoluteWebRoot()

Used only web addressing from server other then host machine for weblayout. (Example: if building a search collection and search exe is run by a different machine then bulkload should use absolute root instead of relative root.)

getBaseAbsoluteRoot

public static java.lang.String getBaseAbsoluteRoot()

Used as a default as the base part for absolute addresses. Only used when launching browsers to point to URLs pointing through web server managed by this instance of Intradoc.

computeWebDirSecuritySuffix

public static java.lang.String computeWebDirSecuritySuffix(DataBinder docInfo,
                                                           boolean isActive)
                                                    throws DataException

Computes the web directory suffix that the path to include the portion that determines the security of the URL.

DataException

computeWebDirSecuritySuffix

public static java.lang.String computeWebDirSecuritySuffix(Parameters docInfo)
                                                    throws DataException

DataException

computeWebDirSuffix

public static java.lang.String computeWebDirSuffix(DataBinder docInfo,
                                                   boolean isActive)
                                            throws DataException

This function is also used by the DirectoryLocator service computeWebPathDir since it is the part of the URL that is guaranteed to be shared between the URL and physical file location. This is the part that will eventually be configurable.

DataException

computeWebDirSuffix

public static java.lang.String computeWebDirSuffix(Parameters docInfo)
                                            throws DataException

DataException

computeWebDirPartialPath

public static java.lang.String computeWebDirPartialPath(DataBinder docInfo,
                                                        boolean isActive)
                                                 throws DataException

Computes the directory portion of the portion web URL that follows the relative web root.

DataException

computeWebDirPartialPath

public static java.lang.String computeWebDirPartialPath(Parameters docInfo)
                                                 throws DataException

DataException

computeWebUrlDir

public static java.lang.String computeWebUrlDir(DataBinder docInfo,
                                                boolean isAbsolute,
                                                boolean isActive)
                                         throws DataException

DataException

computeWebUrlDir

public static java.lang.String computeWebUrlDir(Parameters docInfo,
                                                boolean isAbsolute)
                                         throws DataException

DataException

computeRelativeVaultDir

public static java.lang.String computeRelativeVaultDir(Parameters docInfo)
                                                throws DataException

Computes the part of the vault directory path following vault directory.

DataException

convertToAccountDirStr

protected static java.lang.String convertToAccountDirStr(java.lang.String acct)

computeRenditionFilename

public static java.lang.String computeRenditionFilename(Parameters docInfo,
                                                        int counter)
                                                 throws DataException

DataException

computeRenditionFilename

public static java.lang.String computeRenditionFilename(java.lang.String docName,
                                                        java.lang.String renFlag,
                                                        java.lang.String revLabel,
                                                        java.lang.String ext)

computeRenditionTail

public static java.lang.String computeRenditionTail(java.lang.String renFlag,
                                                    java.lang.String revLabel,
                                                    java.lang.String ext)

computeWebFileExtension

public static java.lang.String computeWebFileExtension(Parameters docInfo,
                                                       boolean isReleased)
                                                throws DataException

DataException

extractFileNameFromUrl

public static java.lang.String extractFileNameFromUrl(java.lang.String path)

extractDocNameFromFileName

public static java.lang.String extractDocNameFromFileName(java.lang.String filename)