Server Reference Guide : Java Interface : Java Classes : com.ca.openroad.RemoteServer
 
Share this page          
com.ca.openroad.RemoteServer
The Java RemoteServer class wraps a corresponding instance of the OpenROAD.RemoteServer COM class. You should be familiar already with the underlying COM RemoteServer methods (see OpenROAD Client 4GL RemoteServer System Class).
This class has the following characteristics:
• All methods are synchronized and final.
• All methods throw COMException, except for the release method.
• The default constructor takes no arguments and creates an underlying COM RSO instance that is not connected.
Clients must explicitly call "release" on every OpenROAD Java object instance they create. Otherwise, the underlying COM resources may not get freed. This is why the example code shows the release calls in the "finally" block, to ensure that they will be executed even in case an exception is thrown.
The following table describes COM RSO wrapper methods:
Wrappers
Description
void release(); // does not throw
Releases the underlying COM RSO instance. After the release method is called, the Java object instance becomes essentially useless and should be discarded.
void getConnectionDetails(String akaName, String location, String routing);
Wraps the COM RSO GetConnectionDetails method. Both location and routing are optional and can be passed as null references or empty strings.
void connect(String akaName, String location, String routing);
Wraps the COM RSO Connect method. Both location and routing are optional and can be passed as null references or empty strings.
void callProc(String procName, ParameterData byValPDO, ParameterData byRefPDO);
Wraps the COM RSO CallProc method. Both byValPDO and byRefPDO are optional and can be passed as null references.
String jsonRpcRequest(String request)
Wraps the COM RSO JsonRpcRequest method.
void disconnect();
Wraps the COM RSO Disconnect method
void initiate(String imgFile, String cmdFlags, String location, String routing, int ps)
Wraps the COM RSO Initiate method
Void terminate();
Is provided just for symmetry with the initiate method. Has the same effect as disconnect.
String getAkaName();
void setAkaName(String akaName);
The get/set methods wrap the COM RSO AkaName property.
String getImageFile();
void setImageFile(String imageFile);
The get and set methods wrap the COM RSO ImageFile property.
String getCmdFlags();
void setCmdFlags(String cmdFlags);
The get and set methods wrap the COM RSO CmdFlags property.
String getLocation();
void setLocation(String location);
The get and set methods wrap the COM RSO Location property.
String getRouting();
void setRouting(String routing);
The get and set methods wrap the COM RSO Routing property.
int getPrivateOrShared();
void setPrivateOrShared(int iVal);
The get and set methods wrap the COM RSO PrivateOrShared property.
int getUseASOLib();
void setUseASOLib(int iVal);
The get and set methods wrap the COM RSO UseASOLib property.
boolean isConnected();
The get method wraps the COM RSO readonly IsConnected property.