com.esri.gpt.catalog.harvest.clients
Class HROAIClient

java.lang.Object
  com.esri.gpt.catalog.harvest.clients.HRAbstractClient
      com.esri.gpt.catalog.harvest.clients.HRHttpClient
          com.esri.gpt.catalog.harvest.clients.HROAIClient

All Implemented Interfaces:

HRClient

public class HROAIClient
extends HRHttpClient

OAI client. Provides somplete implementation of the client capable to access OAI harvest respositories.

See Also:

Open Archives Initiative

Field Summary

Fields inherited from class com.esri.gpt.catalog.harvest.clients.HRHttpClient

FTP_URL_PFX, HTTP_URL_PFX, HTTPS_URL_PFX

Constructor Summary

HROAIClient(String hostUrl, String prefix, String set)
Creates instance of the client.

Method Summary

String	getHostUrl() Gets host URL.
String	getPrefix() Gets prefix.
String	getSet() Gets set.
void	ping() Pings the server.
void	setHostUrl(String hostUrl) Sets host URL.
void	setPrefix(String prefix) Sets prefix.
void	setSet(String set) Sets set.
String	toString() Returns a string representation of the object.
protected void	validateProtocol() Validates protocol definition.

Methods inherited from class com.esri.gpt.catalog.harvest.clients.HRHttpClient

isFtp, isHttp, isHttps, openConnection, openConnection

Methods inherited from class com.esri.gpt.catalog.harvest.clients.HRAbstractClient

getTimeout, isPingSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

HROAIClient

public HROAIClient(String hostUrl,
                   String prefix,
                   String set)

Creates instance of the client.

Parameters:

hostUrl - host url

prefix - prefix

set - set

Method Detail

getHostUrl

public String getHostUrl()

Gets host URL.

Specified by:

getHostUrl in class HRAbstractClient

Returns:

host URL

setHostUrl

public void setHostUrl(String hostUrl)

Sets host URL.

Parameters:

hostUrl - host URL

getPrefix

public String getPrefix()

Gets prefix.

Returns:

prefix

setPrefix

public void setPrefix(String prefix)

Sets prefix.

Parameters:

prefix - prefix

getSet

public String getSet()

Gets set.

Returns:

set

setSet

public void setSet(String set)

Sets set.

Parameters:

set - set

ping

public void ping()
          throws HRInvalidProtocolException,
                 HRConnectionException

Pings the server.

Throws:

HRInvalidProtocolException - if repository reference is invalid

HRConnectionException - if unable to connect to the repository

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class HRAbstractClient

Returns:

string representation of the object

validateProtocol

protected void validateProtocol()
                         throws HRInvalidProtocolException

Validates protocol definition.

Overrides:

validateProtocol in class HRHttpClient

Throws:

HRInvalidProtocolException - if invalid protocol definition