com.dynalivery.harmoni
Class HarmoniApplicationClient

java.lang.Object
  |
  +--com.dynalivery.harmoni.HarmoniClient
        |
        +--com.dynalivery.harmoni.HarmoniApplicationClient

public class HarmoniApplicationClient

extends HarmoniClient

Fields inherited from class com.dynalivery.harmoni.HarmoniClient

CRYSTAL7, CRYSTAL9, folder, HARMONI_FAIL, HARMONI_NAME, HARMONI_OK, priority, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_MEDIUM, verbose, WORD

Constructor Summary

HarmoniApplicationClient()
Construct a HarmoniApplicationClient.

HarmoniApplicationClient(LogService logger)
Construct a HarmoniApplicationClient.

Method Summary

void	Connect(java.lang.String host, int port, java.lang.String serverType, LoadBalanceInfo lb, org.omg.CORBA.ORB cltOrb, java.lang.String[] args, java.util.Properties props) Connect client to Report Server.
void	ConnectToHost(java.lang.String host, java.lang.String serverType) Connect client to Report Server.
void	ConnectUsingLoadBalance(java.lang.String serverType, LoadBalanceInfo lb) Connect client to Report Server.
void	Disconnect() Disconnect client from all Report Server services.
boolean	isRetrieveMode() Getter method for retrieveMode member.
void	Quit() Short-hand for Quit(HarmoniClient.HARMONI_OK).
void	Quit(int code) Disconnect client and release server resources.
void	setRetrieveMode(boolean newRetrieveMode) Deprecated. As of Parallel Crystal 2.7, replaced by setRetrieveOutputToClientDisk in the HarmoniJob class. This method will still work and will cause all HarmoniJob's associated with this client to retrieve the output to the client disk.

Methods inherited from class com.dynalivery.harmoni.HarmoniClient

Connect, Connect, Connected, GetAPI, getArchiveFileReturnOption, getClientName, getConfigServer, getDisableServerTimeout, getFolder, getGateway, getHost, getLog, getName, getORB, GetPrinterInfo, GetPrinterNames, getPriority, getServer, getServerType, GetService, getSharedORB, getVerbose, OpenCrystalEngine, OpenWordEngine, PutAPI, PutService, RemoveAPI, RemoveService, ResetReportServer, SelectReportServer, setArchiveFileReturnOption, setClientName, setConfigServer, setDisableServerTimeout, setFolder, setGatewayServer, setLog, setName, setPriority, setReportEngineServer, setServerType, setSharedORB, setVerbose, Terminate, Terminate

Methods inherited from class java.lang.Object

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

Constructor Detail

HarmoniApplicationClient

public HarmoniApplicationClient()

Construct a HarmoniApplicationClient. The client will connect to a Harmoni Gateway Service on an available but indeterminate host and request a server from the Gateway.

HarmoniApplicationClient

public HarmoniApplicationClient(LogService logger)

Construct a HarmoniApplicationClient. The client will connect to a Harmoni Gateway Service on an available but indeterminate host and request a server from the Gateway.

Parameters:

console - The application console class.

Method Detail

ConnectToHost

public void ConnectToHost(java.lang.String host,
                          java.lang.String serverType)
                   throws HarmoniError,
                          HarmoniClientError,
                          GatewayShuttingDown

Connect client to Report Server.

Parameters:

host - The name of the Report Server to connect to

serverType - The type of Server to connect to ("word")

Throws:

HarmoniError - is thrown on error.

HarmoniClientError - is thrown on error.

GatewayShuttingDown - is thrown on error.

ConnectUsingLoadBalance

public void ConnectUsingLoadBalance(java.lang.String serverType,
                                    LoadBalanceInfo lb)
                             throws HarmoniError,
                                    HarmoniClientError,
                                    GatewayShuttingDown

Connect client to Report Server.

Parameters:

serverType - The type of Server to connect to ("word")

lb - A LoadBalanceInfo object that gives properties for connecting to the Load Balance Server

Throws:

HarmoniError - is thrown on error.

HarmoniClientError - is thrown on error.

GatewayShuttingDown - is thrown on error.

Connect

public void Connect(java.lang.String host,
                    int port,
                    java.lang.String serverType,
                    LoadBalanceInfo lb,
                    org.omg.CORBA.ORB cltOrb,
                    java.lang.String[] args,
                    java.util.Properties props)
             throws HarmoniError,
                    GatewayShuttingDown

Connect client to Report Server. This method is used only for Java users when incompatability in the default ORB is encountered. ConnectToHost and ConnectUsingLoadBalance are the primary methods that are to be used.

Parameters:

host - The name of the machine running the Harmoni Server. You can alternatively pass a dotted decimal IP address of the machine.

port - The port number for connecting to the Harmoni Server (Pass "0" value for a default setting, Used only when there is a port conflict with the default port of 14020)

serverType - The type of the Server supported by Harmoni. (Presently supported options are Crystal-7 : "cr7", Crystal-9 : "cr9" and MS Word 10 : "word")

lb - A LoadBalanceInfo object that gives properties for connecting to the Load Balancing Server

cltOrb - The client customized ORB to be used for this connection. Used when the ORB supplied by Dynalivery has compatability issues with J2EE WebASppServers.

args - Arguments used for creating the customized ORB.

props - Properties needed for creating the customized ORB.

Throws:

HarmoniError - is thrown on error.

HarmoniClientError - is thrown on error.

GatewayShuttingDown - is thrown on error.

Disconnect

public void Disconnect()
                throws HarmoniError

Disconnect client from all Report Server services.

Overrides:

Disconnect in class HarmoniClient

Throws:

HarmoniError - is thrown on error.

isRetrieveMode

public boolean isRetrieveMode()

Getter method for retrieveMode member.

Returns:

boolean

Quit

public void Quit()

Short-hand for Quit(HarmoniClient.HARMONI_OK).

Overrides:

Quit in class HarmoniClient

Quit

public void Quit(int code)

Disconnect client and release server resources.

Overrides:

Quit in class HarmoniClient

Parameters:

code - The termination code. Suggested values: HarmoniClient.HARMONI_OK, HarmoniClient.HARMONI_FAIL

setRetrieveMode

public void setRetrieveMode(boolean newRetrieveMode)

Deprecated. As of Parallel Crystal 2.7, replaced by setRetrieveOutputToClientDisk in the HarmoniJob class. This method will still work and will cause all HarmoniJob's associated with this client to retrieve the output to the client disk.

Parameters:

newRetrieveMode - boolean