com.dynalivery.harmoni
Class HarmoniConfigServer

java.lang.Object
  |
  +--com.dynalivery.harmoni.HarmoniService
        |
        +--com.dynalivery.harmoni.HarmoniConfigServer

public class HarmoniConfigServer

extends HarmoniService

This class allows you to retrieve configuration information about the Harmoni Server configuration. The information available from this class may be usefull to users who want to write portable applications, without having to hardcode hostnames, etc.

Constructor Summary

HarmoniConfigServer()
Specify a Harmoni Configuration Service without host or server name.

HarmoniConfigServer(java.lang.String host)
Specify a Harmoni Configuration Service with the given host and no server name.

HarmoniConfigServer(java.lang.String host, java.lang.String name)
Specify a Harmoni Configuration Service with the given host and server name.

Method Summary

void	Connect() Connect the client to the Harmoni Configuration Server.
void	Disconnect() Disconnect the client from the Harmoni Configuration Server.
java.lang.String	getHarmoniDORTempDir(java.lang.String serverType) Get the temp directory on the server for DOR run-time temp files.
java.lang.String	getHarmoniFileServer() Return the name of the file transfer protocol used by the file return.
java.lang.String	getHarmoniGatewayName() Get the default HarmoniGateway name.
java.lang.String	getHarmoniHostAddress() Get the IP Address of the host on which the Harmoni Product is installed.
java.lang.String	getHarmoniHostName() Get the name of the host on which the Harmoni Product is installed.
HarmoniInfo	getHarmoniInfo() Retrieve all the attribute strings in one API call.
java.lang.String	getHarmoniInstallDir() Get the product installation directory, (this is the server side install directory).
java.lang.String	getHarmoniOutputDir() Get the name of the directory where output may be put.
java.lang.String	getHarmoniSampleOutputDir() Get the name of the directory to be used for sample output.
java.lang.String	getHarmoniTemplatesDir(java.lang.String serverType) Get the name of the directory containing the sample report templates for the serverType specified.
java.lang.String	getHarmoniVersion() Find the Harmoni Product version.
java.lang.String	getHarmoniWebServerDir() Get the web server directory.
java.lang.String	getHost() Return the host-name of the Harmoni Configuration Server.
void	setHost(java.lang.String address) Set the host-name of the Harmoni Configuration Server.

Methods inherited from class com.dynalivery.harmoni.HarmoniService

getServerHost, getServerName, getServerObject, getServiceClient, getServiceName, isConnected, setConnected, setServerHost, setServerName, setServerObject, setServiceClient, setServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

HarmoniConfigServer

public HarmoniConfigServer()

Specify a Harmoni Configuration Service without host or server name.

HarmoniConfigServer

public HarmoniConfigServer(java.lang.String host)

Specify a Harmoni Configuration Service with the given host and no server name.

Parameters:

host - The host running the Gateway server.

HarmoniConfigServer

public HarmoniConfigServer(java.lang.String host,
                           java.lang.String name)

Specify a Harmoni Configuration Service with the given host and server name.

Parameters:

host - The host running the Gateway server.

name - The name of the Gateway server.

Method Detail

Connect

public void Connect()
             throws HarmoniClientError

Connect the client to the Harmoni Configuration Server. Must have connected client before making this call.

Overrides:

Connect in class HarmoniService

Throws:

HarmoniClientError - If the HarmoniConfigServer is not installed on the client, or on error

Disconnect

public void Disconnect()

Disconnect the client from the Harmoni Configuration Server.

Overrides:

Disconnect in class HarmoniService

getHost

public java.lang.String getHost()

Return the host-name of the Harmoni Configuration Server.

Returns:

The hostname on which the Harmoni Configuration Server is running.

getHarmoniDORTempDir

public java.lang.String getHarmoniDORTempDir(java.lang.String serverType)
                                      throws HarmoniClientError,
                                             HarmoniConfigServerError

Get the temp directory on the server for DOR run-time temp files.

Parameters:

serverType - for the required directory.

Returns:

The DOR run-time temp directory.

getHarmoniFileServer

public java.lang.String getHarmoniFileServer()
                                      throws HarmoniClientError,
                                             HarmoniConfigServerError

Return the name of the file transfer protocol used by the file return.

Returns:

The name of the file transfer protocol, currently on FTPServer is provided.

getHarmoniGatewayName

public java.lang.String getHarmoniGatewayName()
                                       throws HarmoniClientError,
                                              HarmoniConfigServerError

Get the default HarmoniGateway name.

Returns:

The default HarmoniGateway name.

getHarmoniHostAddress

public java.lang.String getHarmoniHostAddress()
                                       throws HarmoniClientError,
                                              HarmoniConfigServerError

Get the IP Address of the host on which the Harmoni Product is installed.

Returns:

The ip address of the Harmoni server.

getHarmoniHostName

public java.lang.String getHarmoniHostName()
                                    throws HarmoniClientError,
                                           HarmoniConfigServerError

Get the name of the host on which the Harmoni Product is installed.

Returns:

The hostname of the Harmoni Server.

getHarmoniInfo

public HarmoniInfo getHarmoniInfo()
                           throws HarmoniClientError,
                                  HarmoniServerError,
                                  HarmoniConfigServerError

Retrieve all the attribute strings in one API call.

Returns:

All the attribute strings.

getHarmoniInstallDir

public java.lang.String getHarmoniInstallDir()
                                      throws HarmoniClientError,
                                             HarmoniConfigServerError

Get the product installation directory, (this is the server side install directory).

Returns:

The product installation directory.

getHarmoniOutputDir

public java.lang.String getHarmoniOutputDir()
                                     throws HarmoniClientError,
                                            HarmoniConfigServerError

Get the name of the directory where output may be put.

Returns:

The Harmoni Output Directory.

getHarmoniSampleOutputDir

public java.lang.String getHarmoniSampleOutputDir()
                                           throws HarmoniClientError,
                                                  HarmoniConfigServerError

Get the name of the directory to be used for sample output.

Returns:

The name of the output directory the sample programs will use.

getHarmoniTemplatesDir

public java.lang.String getHarmoniTemplatesDir(java.lang.String serverType)
                                        throws HarmoniClientError,
                                               HarmoniConfigServerError

Get the name of the directory containing the sample report templates for the serverType specified.

Returns:

The name of the directory containing the sample report templates.

getHarmoniVersion

public java.lang.String getHarmoniVersion()
                                   throws HarmoniClientError,
                                          HarmoniConfigServerError

Find the Harmoni Product version.

Returns:

The Harmoni Product version.

getHarmoniWebServerDir

public java.lang.String getHarmoniWebServerDir()
                                        throws HarmoniClientError,
                                               HarmoniConfigServerError

Get the web server directory.

Returns:

The web server directory.

setHost

public void setHost(java.lang.String address)
             throws HarmoniClientError

Set the host-name of the Harmoni Configuration Server.

Parameters:

address - The host-name to use.