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

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

All Implemented Interfaces:

HRClient

public class HRARCIMSClient
extends HRHttpClient

ArcIMS repository client. Provides complete functionality required to establish connection with ArcIMS server.

See Also:

ArcIMS 9.2 documentation

Field Summary

static int

DEFAULT_PORT_NO Default port number.

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

FTP_URL_PFX, HTTP_URL_PFX, HTTPS_URL_PFX

Constructor Summary

HRARCIMSClient(String hostUrl, int portNo, String serviceName, String userName, String userPassword, String rootFolder)
Creates instance of the client.

Method Summary

String	getHostUrl() Gets host URL.
int	getPortNo() Gets connection port number.
String	getRootFolder() Gets root folder.
String	getServiceName() Gets service name.
String	getUserName() Gets user name required to make connection.
String	getUserPassword() Gets user password required to make connection.
void	ping() Checks and verifies connection to the remote repository.
void	setHostUrl(String hostUrl) Sets host URL.
void	setPortNo(int portNo) Sets port number.
void	setRootFolder(String rootFolder) Sets root folder.
void	setServiceName(String serviceName) Sets service name.
void	setUserName(String userName) Sets user name required to make connection.
void	setUserPassword(String userPassword) Sets user password required to make connection.
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

Field Detail

DEFAULT_PORT_NO

public static final int DEFAULT_PORT_NO

Default port number.

See Also:

Constant Field Values

Constructor Detail

HRARCIMSClient

public HRARCIMSClient(String hostUrl,
                      int portNo,
                      String serviceName,
                      String userName,
                      String userPassword,
                      String rootFolder)

Creates instance of the client.

Parameters:

hostUrl - host url

portNo - port number

serviceName - service name

userName - user name (optional)

userPassword - user password (optional)

rootFolder - root folder (optional)

Method Detail

getPortNo

public int getPortNo()

Gets connection port number.

Returns:

port number

setPortNo

public void setPortNo(int portNo)

Sets port number.

Parameters:

portNo - port number

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

getUserName

public String getUserName()

Gets user name required to make connection.

Returns:

user name required to make connection

setUserName

public void setUserName(String userName)

Sets user name required to make connection.

Parameters:

userName - user name required to make connection

getUserPassword

public String getUserPassword()

Gets user password required to make connection.

Returns:

user password required to make connection

setUserPassword

public void setUserPassword(String userPassword)

Sets user password required to make connection.

Parameters:

userPassword - user password required to make connection

getServiceName

public String getServiceName()

Gets service name.

Returns:

service name

setServiceName

public void setServiceName(String serviceName)

Sets service name.

Parameters:

serviceName - service name

getRootFolder

public String getRootFolder()

Gets root folder.

Returns:

root folder

setRootFolder

public void setRootFolder(String rootFolder)

Sets root folder.

Parameters:

rootFolder - root folder

ping

public void ping()
          throws HRInvalidProtocolException,
                 HRConnectionException

Checks and verifies connection to the remote repository.

Throws:

HRInvalidProtocolException - if provided connection definition is incomplete

HRConnectionException - if connection to the remote repository can not be established at this moment

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