com.esri.gpt.catalog.context
Class CatalogConfiguration

java.lang.Object
  com.esri.gpt.framework.context.Configuration
      com.esri.gpt.catalog.context.CatalogConfiguration

public class CatalogConfiguration
extends Configuration

Catalog configuration information.

Constructor Summary

CatalogConfiguration()
Default constructor.

Method Summary

ImsCatalog	getArcImsCatalog() Gets the configured ArcIMS catalog.
Schemas	getConfiguredSchemas() Gets the configured schemas.
TocCollection	getConfiguredTocs() Loads the configured tocs
String	getHarvestingHistoryTableName() Gets the harvesting history table name.
String	getHarvestingJobsCompletedTableName() Gets completed harvesting jobs table name.
String	getHarvestingJobsPendingTableName() Gets pending harvesting jobs table name.
String	getHarvestingTableName() Deprecated. since 10.0; use getResourceTableName() instead
LuceneConfig	getLuceneConfig() Gets the Lucene configuration.
String	getMetadataAdminTableName() Deprecated. since 10.0; use getResourceTableName() instead
String	getMetadataTableName() Deprecated. since 10.0; use getResourceTableName() instead
String	getMvsTablePrefix() Gets the prefix used for MVS table names.
StringAttributeMap	getParameters() Gets the map generally configured paramaters.
String	getResourceDataTableName() Gets resource data table name.
String	getResourceTableName() Gets resource table name.
SearchConfig	getSearchConfig() Gets the search config.
String	getSearchTableName() Gets the name of the saved search table.
String	getTablePrefix() Gets the prefix used for table names.
String	getUserTableName() Gets the name of the user table.
CatalogIndexAdapter	makeCatalogIndexAdapter(RequestContext context) Makes a catalog index adapter.
ImsSocketClient	makeImsSocketClient(ImsService service, Publisher publisher) Makes a suitable ArcIMS socket client for the service.
ImsSocketClient	makeImsSocketClient(RequestContext context, String serviceName) Makes a suitable ArcIMS socket client for the service.
DiscoveryQueryAdapter	newDiscoveryQueryAdapter() Instantiates a new discovery query adapter.
void	setMetadataTableName(String tableName) Sets the ArcIMS metadata table name.
void	setMvsTablePrefix(String prefix) Sets the prefix used for MVS table names.
void	setSearchConfig(SearchConfig searchConfig) Sets the search config.
void	setTablePrefix(String prefix) Sets the prefix used for table names.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogConfiguration

public CatalogConfiguration()

Default constructor.

Method Detail

getArcImsCatalog

public ImsCatalog getArcImsCatalog()

Gets the configured ArcIMS catalog.

Returns:

the configured catalog

getConfiguredSchemas

public Schemas getConfiguredSchemas()

Gets the configured schemas. Prevents queuing by not using synchronized and only calls the getConfiguredSchemasHelper when necessary

Returns:

the configured schemas

getConfiguredTocs

public TocCollection getConfiguredTocs()

Loads the configured tocs

Returns:

the configured tocs

getHarvestingTableName

@Deprecated
public String getHarvestingTableName()

Deprecated. since 10.0; use getResourceTableName() instead

Gets the harvesting repository table name.

Returns:

the harvesting repository table name

getHarvestingHistoryTableName

public String getHarvestingHistoryTableName()

Gets the harvesting history table name.

Returns:

the harvesting history table name

getHarvestingJobsPendingTableName

public String getHarvestingJobsPendingTableName()

Gets pending harvesting jobs table name. This is a table holding jobs definition to be processed or being processed at the time.

Returns:

pending harvesting jobs table name

getHarvestingJobsCompletedTableName

public String getHarvestingJobsCompletedTableName()

Gets completed harvesting jobs table name. This is a table holding historical data about already processed jobs.

Returns:

completed harvesting jobs table name

getLuceneConfig

public LuceneConfig getLuceneConfig()

Gets the Lucene configuration.

Returns:

the Lucene configuration

getMetadataAdminTableName

@Deprecated
public String getMetadataAdminTableName()

Deprecated. since 10.0; use getResourceTableName() instead

Gets the ArcIMS metadata administration table name.

Returns:

the ArcIMS metadata administration table name

getMetadataTableName

@Deprecated
public String getMetadataTableName()

Deprecated. since 10.0; use getResourceTableName() instead

Gets the ArcIMS metadata table name.

Returns:

the ArcIMS metadata table name

getResourceTableName

public String getResourceTableName()

Gets resource table name.

Returns:

resource table name

getResourceDataTableName

public String getResourceDataTableName()

Gets resource data table name.

Returns:

resource data table name

setMetadataTableName

public void setMetadataTableName(String tableName)

Sets the ArcIMS metadata table name.

Parameters:

tableName - the table name

getMvsTablePrefix

public String getMvsTablePrefix()

Gets the prefix used for MVS table names.

Returns:

the prefix

setMvsTablePrefix

public void setMvsTablePrefix(String prefix)

Sets the prefix used for MVS table names.

Parameters:

prefix - the prefix

getParameters

public StringAttributeMap getParameters()

Gets the map generally configured paramaters.

Returns:

the configured parameters (from tag)

getSearchConfig

public SearchConfig getSearchConfig()

Gets the search config.

Returns:

the search config (possibly null)

setSearchConfig

public void setSearchConfig(SearchConfig searchConfig)

Sets the search config.

Parameters:

searchConfig - the new search config

getSearchTableName

public String getSearchTableName()

Gets the name of the saved search table.

Returns:

the save search table name

getTablePrefix

public String getTablePrefix()

Gets the prefix used for table names.

Returns:

the prefix

setTablePrefix

public void setTablePrefix(String prefix)

Sets the prefix used for table names.

Parameters:

prefix - the prefix

getUserTableName

public String getUserTableName()

Gets the name of the user table.

Returns:

the user table name

makeCatalogIndexAdapter

public CatalogIndexAdapter makeCatalogIndexAdapter(RequestContext context)

Makes a catalog index adapter.

Parameters:

context - the request context

Returns:

the catalog index adapter (null if none)

makeImsSocketClient

public ImsSocketClient makeImsSocketClient(ImsService service,
                                           Publisher publisher)

Makes a suitable ArcIMS socket client for the service.

Parameters:

service - the metadata service

publisher - the publisher associated with the request (only required for a socket request against the GPT_Publish_Service

Returns:

the client

makeImsSocketClient

public ImsSocketClient makeImsSocketClient(RequestContext context,
                                           String serviceName)
                                    throws NotAuthorizedException,
                                           IdentityException,
                                           ImsServiceException,
                                           SQLException

Makes a suitable ArcIMS socket client for the service.

Parameters:

serviceName - the metadata service name

context - the request context for a socket request against the GPT_Publish_Service

Returns:

the client

Throws:

NotAuthorizedException - if the user is not authorized

IdentityException - if an integrity violation occurs

ImsServiceException - if an exception occurs when creating the default folder

SQLException - if a database exception occurs

newDiscoveryQueryAdapter

public DiscoveryQueryAdapter newDiscoveryQueryAdapter()

Instantiates a new discovery query adapter.

By default, a new instance of com.esri.gpt.catalog.lucene.LuceneQueryAdapter is returned.

This can be overridden by the configuration parameter: /gptConfig/catalog/parameter@key="discoveryQueryAdapter"

Returns:

the discovery query adapter

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string