com.esri.gpt.server.csw.client
Class CswCatalog

java.lang.Object
  com.esri.gpt.server.csw.client.CswCatalog

All Implemented Interfaces:

Comparable

public class CswCatalog
extends Object
implements Comparable

Maintains information of CSW Catalog The catalogs contain all the information like url, profile information credentials and capabilities.

Constructor Summary

CswCatalog()
Instantiates a new csw catalog.

CswCatalog(String url, String name, CswProfile profile)
Creates instance of the catalog.

Method Summary

int	compareTo(Object arg0)
boolean	connect()
boolean	connect(Bots bots) To connect to a catalog service.
String	getBaseUrl() Gets the base url.
org.apache.commons.httpclient.HttpClient	getBatchHttpClient() Gets the underlying Apache HttpClient to be used for batch requests to the same server.
CswCatalogCapabilities	getCapabilities() Gets the capabilities.
int	getConnectionTimeoutMs() Gets the connection timeout ms.
UsernamePasswordCredentials	getCredentials() Gets the credentials.
String	getId() Gets the id.
String	getName() Gets the name.
CswProfile	getProfile() Gets the profile.
int	getResponseTimeoutMs() Gets the request timeout ms.
String	getUrl() Gets the url.
boolean	IsConnected() To test if already connected to a catalog service.
boolean	Locking() Locking.
void	setBaseUrl(String baseUrl) Sets the base url.
void	setBatchHttpClient(org.apache.commons.httpclient.HttpClient batchHttpClient) Sets the underlying Apache HttpClient to be used for batch requests to the same server.
void	setCapabilities(CswCatalogCapabilities capabilities) Sets the capabilities.
void	setConnectionTimeoutMs(int connectionTimeoutMs) Sets the connection timeout ms.
void	setCredentials(UsernamePasswordCredentials credentials) Sets the credentials.
void	setId(String id) Sets the id.
void	setName(String name) Sets the name.
void	setProfile(CswProfile profile) Sets the profile.
void	setResponseTimeoutMs(int requestTimeoutMs) Sets the request timeout ms.
void	setUrl(String url) Sets the url.

Methods inherited from class java.lang.Object

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

Constructor Detail

CswCatalog

public CswCatalog()

Instantiates a new csw catalog.

CswCatalog

public CswCatalog(String url,
                  String name,
                  CswProfile profile)

Creates instance of the catalog.

Parameters:

url - the url

name - the name

profile - the profile

Method Detail

getBatchHttpClient

public org.apache.commons.httpclient.HttpClient getBatchHttpClient()

Gets the underlying Apache HttpClient to be used for batch requests to the same server.

Returns:

the batch client

setBatchHttpClient

public void setBatchHttpClient(org.apache.commons.httpclient.HttpClient batchHttpClient)

Sets the underlying Apache HttpClient to be used for batch requests to the same server.

Parameters:

batchHttpClient - the batch client

getBaseUrl

public String getBaseUrl()

Gets the base url.

Returns:

the base url

setBaseUrl

public void setBaseUrl(String baseUrl)

Sets the base url.

Parameters:

baseUrl - the new base url

getConnectionTimeoutMs

public int getConnectionTimeoutMs()

Gets the connection timeout ms.

Returns:

the connection timeout ms

setConnectionTimeoutMs

public void setConnectionTimeoutMs(int connectionTimeoutMs)

Sets the connection timeout ms.

Parameters:

connectionTimeoutMs - the new connection timeout ms

getResponseTimeoutMs

public int getResponseTimeoutMs()

Gets the request timeout ms.

Returns:

the request timeout ms

setResponseTimeoutMs

public void setResponseTimeoutMs(int requestTimeoutMs)

Sets the request timeout ms.

Parameters:

requestTimeoutMs - the new request timeout ms

getCapabilities

public CswCatalogCapabilities getCapabilities()

Gets the capabilities.

Returns:

the capabilities

setCapabilities

public void setCapabilities(CswCatalogCapabilities capabilities)

Sets the capabilities.

Parameters:

capabilities - the new capabilities

getCredentials

public UsernamePasswordCredentials getCredentials()

Gets the credentials.

Returns:

the credentials

setCredentials

public void setCredentials(UsernamePasswordCredentials credentials)

Sets the credentials.

Parameters:

credentials - the new credentials

getId

public String getId()

Gets the id.

Returns:

the id

setId

public void setId(String id)

Sets the id.

Parameters:

id - the new id

getName

public String getName()

Gets the name.

Returns:

the name

setName

public void setName(String name)

Sets the name.

Parameters:

name - the new name

getProfile

public CswProfile getProfile()

Gets the profile.

Returns:

the profile

setProfile

public void setProfile(CswProfile profile)

Sets the profile.

Parameters:

profile - the new profile

getUrl

public String getUrl()

Gets the url.

Returns:

the url

setUrl

public void setUrl(String url)

Sets the url.

Parameters:

url - the new url

connect

public boolean connect()
                throws SAXException,
                       IOException,
                       ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

connect

public boolean connect(Bots bots)
                throws SAXException,
                       IOException,
                       ParserConfigurationException

To connect to a catalog service. The capabilties details are populated based on the service.

Parameters:

bots - robots.txt or null if unavailable

Returns:

true if connection can be made to the csw service

Throws:

ParserConfigurationException - the parser configuration exception

IOException - Signals that an I/O exception has occurred.

SAXException - the sAX exception

IsConnected

public boolean IsConnected()

To test if already connected to a catalog service.

Returns:

true if connection has already been made to the csw service else false

Locking

public boolean Locking()

Locking.

Returns:

true, if successful

compareTo

public int compareTo(Object arg0)

Specified by:

compareTo in interface Comparable