com.esri.arcgis.search
Interface ISSUtilities

All Superinterfaces:

Serializable

All Known Implementing Classes:

SSUtilities

public interface ISSUtilities
extends Serializable

Search Server Utilities.

Method Summary

void	checkIndexingOverDue(IIndexingStatus pIndexingStatus, boolean[] pIsFullIndexingOverDue, boolean[] pIsIncrementalIndexingOverDue, ITime[] ppFullUTCTime, ITime ppIncrUTCTime) .
IIndexingOptions	createDefaultIndexingOptions(String fileName) .
void	createDefaultIndexingStatus(String fileName, IIndexingOptions pIndexingOptions) .
IDataSourceConfiguration	createDSCFromFile(String fileName) .
IDSCStatusArray	createDSCStatusArrayFromFile(String fileName) .
void	createDSCXMLFile(IDataSourceConfiguration pDataSourceConfiguration, String folderName) .
void	createIndexingFoldersAndFiles(IPropertySet pProps, String serviceName) .
void	createIndexingOptionsFile(IIndexingOptions pIndexingOptions, String fileName) .
void	createSearchGDB(String indexRootFolder, String gdbName) .
void	deleteDirectory(String dir) .
String	getCurrentUTCTime(ITime[] ppCurUTCTime) .
String	getCurrentUTCTimeXMLString() .
IStringArray	getDataSourceList(String cfgLocation) .
IStringArray	getDataSourceListFromGDB(String gdbConnectionFile, String serviceName) .
String	getDSCStatusFileName(String indexingConfigPath) .
String	getDSCXMLFileName(String folderName, String catalogPath) .
String	getFileGDBPath(String arcgisindexLocation, String serviceName) .
String	getFinishFileName(String folder) .
String	getGDBConnectionPath(IPropertySet pProps, String arcgisindexLocation, String serviceName) .
String	getIndexingConfigPath(String arcgisindexLocation, String serviceName) .
String	getIndexingOptionsFileName(String indexingConfigPath) .
String	getIndexingStatusFileName(String indexingConfigPath) .
IServerContext	getIndexItemSO(IServerObjectManager pSOM, String serviceName, IServerObject[] ppSO) .
String	getIndexLocation(String arcgisindexLocation, String serviceName) .
String	getSearchServiceLocation(String arcgisindexLocation, String serviceName) .
String	getStagingIndexLocation(String arcgisindexLocation, String serviceName) .
String	getStagingIndexPath(String arcgisindexLocation, String serviceName) .
String	getStagingIndexStagingPath(String arcgisindexLocation, String serviceName) .
String	getStagingPath(String arcgisindexLocation, String serviceName) .
ITable	initDataSourceConfigurationTable(IWorkspaceName pWSN, String dataSourceCfgTableTN) .
boolean	isOverDue(String targetUTCXMLTime) .
ITable	openDataSourceConfigurationTable(IFeatureWorkspace pFWS, String dSCTableName) .
ITable	openDSCTable(String sDEConnection, String serviceName) .
String	qualifyTableName(IFeatureWorkspace pFWS, String tableName) .
IIndexingOptions	readIndexingOptionsFile(String fileName) .
IIndexingStatus	readIndexingStatus(String fileName) .
void	replaceDSCStatusFile(IDSCStatusArray pDSCStatusArray, String bsDSCStatusFileName) .
void	replaceIndexingStatusFile(IIndexingStatus pIndexingStatus, String indexingStatusFileName) .
void	setNextIndexingStartTime(boolean isFull, IIndexingOptions pIndexingOptions, IIndexingStatus pIndexingStatus) .
void	updateDSCRunningStatus(IPropertySet pConnProps, IServerObjectManager pSOM, String bsDSCStatusFileName, String serviceName, IDSCStatusArray[] ppDSCStatusArray) .
void	updateFullStartTimeIndexingStatus(IIndexingOptions pIndexingOptions, String indexingConfigPath, IIndexingStatus pIndexingStatus) .

Method Detail

getIndexItemSO

IServerContext getIndexItemSO(IServerObjectManager pSOM,
                              String serviceName,
                              IServerObject[] ppSO)
                              throws IOException,
                                     AutomationException

.

Parameters:

pSOM - A reference to a com.esri.arcgis.server.IServerObjectManager (in)

serviceName - The serviceName (in)

ppSO - A reference to a com.esri.arcgis.server.IServerObject (out: use single element array)

Returns:

A reference to a com.esri.arcgis.server.IServerContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteDirectory

void deleteDirectory(String dir)
                     throws IOException,
                            AutomationException

.

Parameters:

dir - The dir (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDSCXMLFileName

String getDSCXMLFileName(String folderName,
                         String catalogPath)
                         throws IOException,
                                AutomationException

.

Parameters:

folderName - The folderName (in)

catalogPath - The catalogPath (in)

Returns:

The dSCFileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDSCXMLFile

void createDSCXMLFile(IDataSourceConfiguration pDataSourceConfiguration,
                      String folderName)
                      throws IOException,
                             AutomationException

.

Parameters:

pDataSourceConfiguration - A reference to a com.esri.arcgis.search.IDataSourceConfiguration (in)

folderName - The folderName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDSCFromFile

IDataSourceConfiguration createDSCFromFile(String fileName)
                                           throws IOException,
                                                  AutomationException

.

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.search.IDataSourceConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceList

IStringArray getDataSourceList(String cfgLocation)
                               throws IOException,
                                      AutomationException

.

Parameters:

cfgLocation - The cfgLocation (in)

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexingOptionsFileName

String getIndexingOptionsFileName(String indexingConfigPath)
                                  throws IOException,
                                         AutomationException

.

Parameters:

indexingConfigPath - The indexingConfigPath (in)

Returns:

The indexingOptionsFileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createIndexingOptionsFile

void createIndexingOptionsFile(IIndexingOptions pIndexingOptions,
                               String fileName)
                               throws IOException,
                                      AutomationException

.

Parameters:

pIndexingOptions - A reference to a com.esri.arcgis.search.IIndexingOptions (in)

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readIndexingOptionsFile

IIndexingOptions readIndexingOptionsFile(String fileName)
                                         throws IOException,
                                                AutomationException

.

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.search.IIndexingOptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDefaultIndexingOptions

IIndexingOptions createDefaultIndexingOptions(String fileName)
                                              throws IOException,
                                                     AutomationException

.

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.search.IIndexingOptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDSCStatusFileName

String getDSCStatusFileName(String indexingConfigPath)
                            throws IOException,
                                   AutomationException

.

Parameters:

indexingConfigPath - The indexingConfigPath (in)

Returns:

The dSCStatusFileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDSCStatusArrayFromFile

IDSCStatusArray createDSCStatusArrayFromFile(String fileName)
                                             throws IOException,
                                                    AutomationException

.

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.search.IDSCStatusArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceDSCStatusFile

void replaceDSCStatusFile(IDSCStatusArray pDSCStatusArray,
                          String bsDSCStatusFileName)
                          throws IOException,
                                 AutomationException

.

Parameters:

pDSCStatusArray - A reference to a com.esri.arcgis.search.IDSCStatusArray (in)

bsDSCStatusFileName - The bsDSCStatusFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateDSCRunningStatus

void updateDSCRunningStatus(IPropertySet pConnProps,
                            IServerObjectManager pSOM,
                            String bsDSCStatusFileName,
                            String serviceName,
                            IDSCStatusArray[] ppDSCStatusArray)
                            throws IOException,
                                   AutomationException

.

Parameters:

pConnProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

pSOM - A reference to a com.esri.arcgis.server.IServerObjectManager (in)

bsDSCStatusFileName - The bsDSCStatusFileName (in)

serviceName - The serviceName (in)

ppDSCStatusArray - A reference to a com.esri.arcgis.search.IDSCStatusArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateFullStartTimeIndexingStatus

void updateFullStartTimeIndexingStatus(IIndexingOptions pIndexingOptions,
                                       String indexingConfigPath,
                                       IIndexingStatus pIndexingStatus)
                                       throws IOException,
                                              AutomationException

.

Parameters:

pIndexingOptions - A reference to a com.esri.arcgis.search.IIndexingOptions (in)

indexingConfigPath - The indexingConfigPath (in)

pIndexingStatus - A reference to a com.esri.arcgis.search.IIndexingStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceIndexingStatusFile

void replaceIndexingStatusFile(IIndexingStatus pIndexingStatus,
                               String indexingStatusFileName)
                               throws IOException,
                                      AutomationException

.

Parameters:

pIndexingStatus - A reference to a com.esri.arcgis.search.IIndexingStatus (in)

indexingStatusFileName - The indexingStatusFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDefaultIndexingStatus

void createDefaultIndexingStatus(String fileName,
                                 IIndexingOptions pIndexingOptions)
                                 throws IOException,
                                        AutomationException

.

Parameters:

fileName - The fileName (in)

pIndexingOptions - A reference to a com.esri.arcgis.search.IIndexingOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexingStatusFileName

String getIndexingStatusFileName(String indexingConfigPath)
                                 throws IOException,
                                        AutomationException

.

Parameters:

indexingConfigPath - The indexingConfigPath (in)

Returns:

The dSCFileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readIndexingStatus

IIndexingStatus readIndexingStatus(String fileName)
                                   throws IOException,
                                          AutomationException

.

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.search.IIndexingStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchServiceLocation

String getSearchServiceLocation(String arcgisindexLocation,
                                String serviceName)
                                throws IOException,
                                       AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The searchServiceLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexLocation

String getIndexLocation(String arcgisindexLocation,
                        String serviceName)
                        throws IOException,
                               AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The indexLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStagingIndexLocation

String getStagingIndexLocation(String arcgisindexLocation,
                               String serviceName)
                               throws IOException,
                                      AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The stagingIndexLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStagingPath

String getStagingPath(String arcgisindexLocation,
                      String serviceName)
                      throws IOException,
                             AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The stagingPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStagingIndexPath

String getStagingIndexPath(String arcgisindexLocation,
                           String serviceName)
                           throws IOException,
                                  AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The stagingIndexPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStagingIndexStagingPath

String getStagingIndexStagingPath(String arcgisindexLocation,
                                  String serviceName)
                                  throws IOException,
                                         AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The stagingIndexStagingPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexingConfigPath

String getIndexingConfigPath(String arcgisindexLocation,
                             String serviceName)
                             throws IOException,
                                    AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The indexingConfigPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFinishFileName

String getFinishFileName(String folder)
                         throws IOException,
                                AutomationException

.

Parameters:

folder - The folder (in)

Returns:

The pFinishFileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createIndexingFoldersAndFiles

void createIndexingFoldersAndFiles(IPropertySet pProps,
                                   String serviceName)
                                   throws IOException,
                                          AutomationException

.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

serviceName - The serviceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentUTCTimeXMLString

String getCurrentUTCTimeXMLString()
                                  throws IOException,
                                         AutomationException

.

Returns:

The curUTCTimeXMLString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentUTCTime

String getCurrentUTCTime(ITime[] ppCurUTCTime)
                         throws IOException,
                                AutomationException

.

Parameters:

ppCurUTCTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)

Returns:

The curUTCTimeXMLString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkIndexingOverDue

void checkIndexingOverDue(IIndexingStatus pIndexingStatus,
                          boolean[] pIsFullIndexingOverDue,
                          boolean[] pIsIncrementalIndexingOverDue,
                          ITime[] ppFullUTCTime,
                          ITime ppIncrUTCTime)
                          throws IOException,
                                 AutomationException

.

Parameters:

pIndexingStatus - A reference to a com.esri.arcgis.search.IIndexingStatus (in)

pIsFullIndexingOverDue - The pIsFullIndexingOverDue (in)

pIsIncrementalIndexingOverDue - The pIsIncrementalIndexingOverDue (in)

ppFullUTCTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)

ppIncrUTCTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverDue

boolean isOverDue(String targetUTCXMLTime)
                  throws IOException,
                         AutomationException

.

Parameters:

targetUTCXMLTime - The targetUTCXMLTime (in)

Returns:

The isOverDue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNextIndexingStartTime

void setNextIndexingStartTime(boolean isFull,
                              IIndexingOptions pIndexingOptions,
                              IIndexingStatus pIndexingStatus)
                              throws IOException,
                                     AutomationException

.

Parameters:

isFull - The isFull (in)

pIndexingOptions - A reference to a com.esri.arcgis.search.IIndexingOptions (in)

pIndexingStatus - A reference to a com.esri.arcgis.search.IIndexingStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileGDBPath

String getFileGDBPath(String arcgisindexLocation,
                      String serviceName)
                      throws IOException,
                             AutomationException

.

Parameters:

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The fileGDBPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGDBConnectionPath

String getGDBConnectionPath(IPropertySet pProps,
                            String arcgisindexLocation,
                            String serviceName)
                            throws IOException,
                                   AutomationException

.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

arcgisindexLocation - The arcgisindexLocation (in)

serviceName - The serviceName (in)

Returns:

The connectionFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceListFromGDB

IStringArray getDataSourceListFromGDB(String gdbConnectionFile,
                                      String serviceName)
                                      throws IOException,
                                             AutomationException

.

Parameters:

gdbConnectionFile - The gdbConnectionFile (in)

serviceName - The serviceName (in)

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSearchGDB

void createSearchGDB(String indexRootFolder,
                     String gdbName)
                     throws IOException,
                            AutomationException

.

Parameters:

indexRootFolder - The indexRootFolder (in)

gdbName - The gdbName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initDataSourceConfigurationTable

ITable initDataSourceConfigurationTable(IWorkspaceName pWSN,
                                        String dataSourceCfgTableTN)
                                        throws IOException,
                                               AutomationException

.

Parameters:

pWSN - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

dataSourceCfgTableTN - The dataSourceCfgTableTN (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDSCTable

ITable openDSCTable(String sDEConnection,
                    String serviceName)
                    throws IOException,
                           AutomationException

.

Parameters:

sDEConnection - The sDEConnection (in)

serviceName - The serviceName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDataSourceConfigurationTable

ITable openDataSourceConfigurationTable(IFeatureWorkspace pFWS,
                                        String dSCTableName)
                                        throws IOException,
                                               AutomationException

.

Parameters:

pFWS - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

dSCTableName - The dSCTableName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyTableName

String qualifyTableName(IFeatureWorkspace pFWS,
                        String tableName)
                        throws IOException,
                               AutomationException

.

Parameters:

pFWS - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

tableName - The tableName (in)

Returns:

The qualifiedTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.