RpcBroker

java.lang.Object
- gov.va.med.lom.javaBroker.rpc.RpcBroker

All Implemented Interfaces:

IPulseHandler, ITimerHandler
```
public class RpcBroker
extends java.lang.Object
implements IPulseHandler, ITimerHandler
```
The RpcBroker class provides VistA application developers with client/server-related functionality for software written in the Java programming language.

Using an instance of RpcBroker, an application can connect to the server by simply calling the connect method passing the server host and port. Remote procedures on the server can be executed by invoking one of the overloaded lCall, tCall, or sCall methods.
The following code performs a signon setup, signs the user on to the VistA broker server, and then gets information on the user:
```
   RpcBroker rpcBroker = new RpcBroker();
   rpcBroker.connect("test.lom.med.va.gov", 9100);
   long duz = rpcBroker.doSignon("access", "verify");
   if (duz > 0) {
     String s = rpcBroker.sCall("OR CPRS GUI CHART, "ORWU USERINFO");
   }
 
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String RPC_BROKER

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`RPC_BROKER`

Constructor Summary

Constructors
Constructor and Description
`RpcBroker()` Constructs an instance of RpcBroker using the default version of the RPC broker protocol.
`RpcBroker(int rpcProtocolVersion)` Constructs an instance of RpcBroker using the version of the protocol specified.
`RpcBroker(int rpcProtocolVersion, java.lang.String server, int port)` Constructs an instance of RpcBroker and connects to the server at the specified server host/ip and port using the version of the broker protocol that is specified .
`RpcBroker(java.lang.String server, int port)` Constructs an instance of RpcBroker and connects to the server at the specified server host/ip and port using the Version 2 broker protocol.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`call()` Makes the call on the broker server using the current context and current RPC API.
`java.lang.String`	`call(java.lang.String api)` Makes the call on the broker server using the current context.
`java.lang.String`	`call(java.lang.String api, java.lang.Object[] paramArray)` Makes the call on the broker server.
`java.lang.String`	`call(java.lang.String api, Params params)` Makes the call on the broker server using the current context.
`java.lang.String`	`call(java.lang.String api, java.lang.String ien)` Makes the call on the broker server using the current context.
`void`	`callOnRpcBrokerSignon()` Calls the onRpcBrokerSignon event handler.
`boolean`	`connect()` Connect to the broker server using the previously set server host/ip and port.
`boolean`	`connect(java.lang.String server, int port)` Connect to the broker server.
`BrokerException`	`createBrokerException(java.lang.Exception e, java.lang.String action, int code)` Creates a broker exception.
`boolean`	`createContext(java.lang.String aContext)` Creates and sets the context on the broker server.
`boolean`	`disconnect()` Disconnects from the broker server.
`void`	`doClearParams()` Clears the `params` property.
`void`	`doClearResults()` Clears the results.
`void`	`doPulse()`
`java.lang.String`	`doSignon()` Performs a signon setup and signon using the cached access and verify codes.
`java.lang.String`	`doSignon(java.lang.String avCode)` Performs a signon setup and signon using the supplied semicolon delimited access and verify codes.
`java.lang.String`	`doSignon(java.lang.String accessCode, java.lang.String verifyCode)` Performs a signon setup and signon using the supplied access and verify codes.
`java.lang.String`	`getAppHandle()` Gets a token that can be used to sign-on a new process.
`java.lang.String`	`getApplicationSegment()` Gets the application segment of the last inbound message.
`BrokerException`	`getBrokerException()` Gets the last broker exception.
`int`	`getBrokerInfo()` Gets info from the server regarding setup and parameters of the broker.
`boolean`	`getClearParams()` Tests whether or not to clear the parameter list between calls.
`boolean`	`getClearResults()` Tests whether the results are to be cleared between calls.
`java.lang.String`	`getCurrentContext()` Gets the current broker context.
`java.lang.String`	`getDataSegment()` Gets the data segment of the last inbound message.
`java.lang.String`	`getDomain()` Gets the domain of the signed-on user.
`java.lang.String`	`getErrorMessage()` Gets the message property associated with the exception or error that was encountered.
`IRpcBrokerEventHandler`	`getEventHandler()` Gets the event handler object that implements IRpcBrokerEventHandler interface.
`java.lang.String`	`getHashedAVCodes()` Returns the hashed access;verify code pair.
`int`	`getInactiveTimeout()` Returns the timeout duration (in msec) in which RpcBroker will log off of VistA if a connection has been idle for a period of time.
`java.util.Date`	`getLastMessageTime()` Returns the timestamp of the last (non-pulse) message sent to VistA.
`int`	`getListenerPort()` Gets the listener port on the broker server.
`static LogChannel`	`getLogChannel()` The log channel is used to write messages to a logging facility.
`java.lang.String`	`getLoginHandle()` The login handle property holds the application handle for doing a silent login.
`Params`	`getParams()` `Params` is an object that holds all of the parameters that the application needs to pass to the remote procedure.
`java.lang.String`	`getRemoteProcedure()` Gets the remote procedure property to the name of the remote procedure call entry in the REMOTE PROCEDURE file (#8994).
`java.lang.StringBuffer`	`getResults()` Gets the results as a StringBuffer.
`IRpcProtocol`	`getRpcProtocol()` The Rpc Protocol is the implementation of the RPC Broker protocol used.
`int`	`getRpcProtocolVersion()` The Rpc protocol version is the version of the RPC protocol used.
`java.lang.String`	`getRpcVersion()` Returns the RPC version
`java.lang.String`	`getSecuritySegment()` Gets the security segment of the last inbound message.
`java.lang.String`	`getServer()` The server property contains the name or Internet Protocol (IP) address of the server computer.
`java.lang.String`	`getService()` Gets the service ID of the signed-on user.
`java.lang.String`	`getServiceSection()` Gets the service/section of the signed-on user.
`java.lang.String`	`getStation()` Gets the station of the signed-on user.
`java.lang.String`	`getStationIen()` Gets the station IEN of the signed-on user.
`java.lang.String`	`getStationNo()` Gets the station number of the signed-on user.
`java.lang.String`	`getTitle()` Gets the title of the signed-on user.
`java.lang.String`	`getUserClass()` Gets the class of the signed-on user.
`java.lang.String`	`getUserDuz()` Gets the duz of the signed-on user.
`java.lang.String`	`getUserName()` Gets the name of the signed-on user.
`boolean`	`isConnected()` Tests if a connection is established, and allows you to branch accordingly depending on whether a connection is established or not.
`boolean`	`isConnecting()` Tests whether the broker client is currently in the process of connecting to the server.
`boolean`	`isKernelLogin()` Tests whether the login type is kernel login.
`protected void`	`lockCallMonitor()`
`void`	`log(int level, java.lang.Exception e)` Writes the exception message to the logging facility.
`void`	`log(int level, java.lang.String msg)` Writes the message to the logging facility.
`static void`	`main(java.lang.String[] args)`
`void`	`onTimerEvent()`
`void`	`setClearParameters(boolean value)` The clear parameters design-time property gives the developer the option to clear the `params` property following every invocation of the call methods.
`void`	`setClearResults(boolean value)` Setting clear results to `true` clears the `results` property.
`boolean`	`setConnected(boolean value)` If `value` is `true`, connects to the broker server using the previously set server host/ip and port.
`void`	`setContext(java.lang.String context)` Sets the current context without creating the context on the server.
`boolean`	`setCurrentContext(java.lang.String currentContext)` Sets the current broker context and creates the context on the server.
`void`	`setDomain(java.lang.String domain)` Sets the domain of the signed-on user.
`void`	`setEventHandler(IRpcBrokerEventHandler eventHandler)` Gets the event handler object.
`void`	`setHashedAVCodes(java.lang.String avCode)` Sets the hashed access;verify code pair for the user.
`void`	`setInactiveTimeout(int inactiveTimeout)` Sets the timeout duration (in msec) for inactivity, after which RpcBroker will log off of VistA.
`void`	`setKernelLogin(boolean kernelLogin)` If `kernelLogin` is `true`, sets the login type to kernel login.
`void`	`setListenerPort(int listenerPort)` Sets the port on which the broker server is listening.
`static void`	`setLogChannel(LogChannel logChannel)` Sets the static log channel used for writing messages to the logging facility.
`void`	`setParams(Params params)` Sets the `Params` object, which holds all of the parameters that the application needs to pass to the remote procedure.
`void`	`setRemoteProcedure(java.lang.String remoteProcedure)` Sets the remote procedure property to the name of the remote procedure call entry in the REMOTE PROCEDURE file (#8994).
`void`	`setRpcProtocol(IRpcProtocol rpcProtocol)` Sets the RPC version number
`void`	`setRpcProtocolVersion(int rpcProtocolVersion)` Sets the RPC broker protocol version number
`void`	`setRpcVersion(java.lang.String rpcVersion)` The RPC version property is used to pass the version of the RPC.
`void`	`setServer(java.lang.String server)` Changing the name of the server while the RpcBroker is connected disconnects the RpcBroker from the previous server.
`void`	`setService(java.lang.String service)` Sets the service ID of the signed-on user.
`void`	`setServiceSection(java.lang.String serviceSection)` Sets the service/section of the signed-on user.
`void`	`setStation(java.lang.String station)` Sets the station of the signed-on user.
`void`	`setStationIen(java.lang.String stationIen)` Sets the station IEN of the signed-on user.
`void`	`setStationNo(java.lang.String stationNo)` Sets the station number of the signed-on user.
`void`	`setTitle(java.lang.String title)` Sets the title of the signed-on user.
`void`	`setUserClass(java.lang.String userClass)` Sets the class of the signed-on user.
`void`	`setUserDuz(java.lang.String duz)` Sets the duz of the signed-on user.
`void`	`setUserName(java.lang.String userName)` Sets the name of the signed-on user.
`protected void`	`unlockCallMonitor()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RPC_BROKER
```
public static final java.lang.String RPC_BROKER
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RpcBroker
```
public RpcBroker()
          throws BrokerException
```
    Constructs an instance of RpcBroker using the default version of the RPC broker protocol.
    
    Parameters:
    server - the host/ip of the server
    port - the listening port on the server
    
    Throws:
    
    BrokerException
  - RpcBroker
```
public RpcBroker(int rpcProtocolVersion)
          throws BrokerException
```
    Constructs an instance of RpcBroker using the version of the protocol specified.
    
    Parameters:
    rpcProtocolVersion - the version of the rpc broker protocol to use
    
    Throws:
    
    BrokerException
  - RpcBroker
```
public RpcBroker(java.lang.String server,
         int port)
          throws BrokerException
```
    Constructs an instance of RpcBroker and connects to the server at the specified server host/ip and port using the Version 2 broker protocol.
    
    Parameters:
    server - the host/ip of the server
    port - the listening port on the server
    
    Throws:
    
    BrokerException
  - RpcBroker
```
public RpcBroker(int rpcProtocolVersion,
         java.lang.String server,
         int port)
          throws BrokerException
```
    Constructs an instance of RpcBroker and connects to the server at the specified server host/ip and port using the version of the broker protocol that is specified .
    
    Parameters:
    server - the host/ip of the server
    port - the listening port on the server
    
    Throws:
    
    BrokerException
- Method Detail
  - getEventHandler
```
public IRpcBrokerEventHandler getEventHandler()
```
    Gets the event handler object that implements IRpcBrokerEventHandler interface.
  - setEventHandler
```
public void setEventHandler(IRpcBrokerEventHandler eventHandler)
```
    Gets the event handler object.
    
    Parameters:
    eventHandler - object that implements IRpcBrokerEventHandler interface.
  - getRpcVersion
```
public java.lang.String getRpcVersion()
```
    Returns the RPC version
    
    Returns:
    the RPC version
  - setRpcVersion
```
public void setRpcVersion(java.lang.String rpcVersion)
```
    The RPC version property is used to pass the version of the RPC. This can be useful for backward compatibility.
    
    As you introduce new functionality into an existing RPC, your RPC can branch into different parts of the code based on the value of the RPC version property. The broker sets the XWBAPVER variable on the server to the contents of the RPC version property. This property cannot be empty and defaults to "0" (zero).
    
    Parameters:
    rpcVersion - the version of the RPC to set.
  - getClearParams
```
public boolean getClearParams()
```
    Tests whether or not to clear the parameter list between calls.
    
    Returns:
    true if the list of parameters should be cleared between calls, false otherwise.
  - setClearParameters
```
public void setClearParameters(boolean value)
```
    The clear parameters design-time property gives the developer the option to clear the params property following every invocation of the call methods. Setting clear parameters to true clears the params property.
    
    Simple assignment of true to this property clears the Pparam property after every invocation of the call methods. Thus, the parameters need only be prepared for the next call without being concerned about what was remaining from the previous call. By setting clear parameters to false, the programmer can make multiple calls with the same params property. It is also appropriate to set this property to false when a majority of the parameters in the params property should remain the same between calls. However, minor changes to the parameters can still be made. If value is true, clears the parameter list and clears parameters between all calls. Otherwise, if value is false, the parameters will not be cleared between calls.
    
    Parameters:
    value -
  - doClearParams
```
public void doClearParams()
```
    Clears the params property.
    
    See Also:
    setClearParameters(boolean value)
  - getClearResults
```
public boolean getClearResults()
```
    Tests whether the results are to be cleared between calls.
    
    Returns:
    true if the results have been cleared, false otherwise.
    See Also:
    setClearResults(boolean)
  - setClearResults
```
public void setClearResults(boolean value)
```
    Setting clear results to true clears the results property.
    
    If this property is true, then the results property is cleared before every invocation of the call methods, thus, assuring that only the results of the last call are returned. Conversely, a setting of falseresults property.
    Parameters: value - true if results are to be cleared between calls, false otherwise
  doClearResults public void doClearResults() Clears the results. See Also: setClearResults(boolean) isConnecting public boolean isConnecting() Tests whether the broker client is currently in the process of connecting to the server. Returns: true if the broker client is connecting, false otherwise. createBrokerException public BrokerException createBrokerException(java.lang.Exception e, java.lang.String action, int code) Creates a broker exception. Parameters: e - the exception that this broker exception encapsulates action - the action for which this exception occurred code - the integer code representing this exception Returns: the broker exception. getBrokerException public BrokerException getBrokerException() Gets the last broker exception. Returns: the last broker exception. getCurrentContext public java.lang.String getCurrentContext() Gets the current broker context. Returns: the current broker context. setCurrentContext public boolean setCurrentContext(java.lang.String currentContext) throws BrokerException Sets the current broker context and creates the context on the server. Parameters: currentContext - the current context to set Throws: BrokerException setContext public void setContext(java.lang.String context) Sets the current context without creating the context on the server. Parameters: context - the context to set isKernelLogin public boolean isKernelLogin() Tests whether the login type is kernel login. Returns: true if login type is kernel login, false otherwise. setKernelLogin public void setKernelLogin(boolean kernelLogin) If kernelLogin is true, sets the login type to kernel login. Parameters: kernelLogin - true if login type is kernel login, false otherwise. getListenerPort public int getListenerPort() Gets the listener port on the broker server. Returns: the listener port on the broker server setListenerPort public void setListenerPort(int listenerPort) Sets the port on which the broker server is listening. Parameters: listenerPort - the port on which the broker server is listening getParams public Params getParams() Params is an object that holds all of the parameters that the application needs to pass to the remote procedure. Returns: the params that the application needs to pass to the remote procedure setParams public void setParams(Params params) Sets the Params object, which holds all of the parameters that the application needs to pass to the remote procedure. Parameters: params - the params that the application needs to pass to the remote procedure getRemoteProcedure public java.lang.String getRemoteProcedure() Gets the remote procedure property to the name of the remote procedure call entry in the REMOTE PROCEDURE file (#8994). Returns: the current remote procedure API setRemoteProcedure public void setRemoteProcedure(java.lang.String remoteProcedure) Sets the remote procedure property to the name of the remote procedure call entry in the REMOTE PROCEDURE file (#8994). Parameters: remoteProcedure - the current remote procedure API getResults public java.lang.StringBuffer getResults() Gets the results as a StringBuffer. Returns: the contents of the data returned from the call getHashedAVCodes public java.lang.String getHashedAVCodes() Returns the hashed access;verify code pair. Returns: avCode the user's hashed access;verify code pair setHashedAVCodes public void setHashedAVCodes(java.lang.String avCode) Sets the hashed access;verify code pair for the user. Parameters: avCode - the hashed access;verify code pair getErrorMessage public java.lang.String getErrorMessage() Gets the message property associated with the exception or error that was encountered. Returns: the text of the last RPC broker error getSecuritySegment public java.lang.String getSecuritySegment() Gets the security segment of the last inbound message. Returns: the security segment of the message received from VistA getApplicationSegment public java.lang.String getApplicationSegment() Gets the application segment of the last inbound message. Returns: the application segment of the message received from VistA getDataSegment public java.lang.String getDataSegment() Gets the data segment of the last inbound message. Returns: the data segment of the message received from VistA getUserDuz public java.lang.String getUserDuz() Gets the duz of the signed-on user. Returns: the signed-on user's duz setUserDuz public void setUserDuz(java.lang.String duz) Sets the duz of the signed-on user. Parameters: duz - signed-on user's duz getDomain public java.lang.String getDomain() Gets the domain of the signed-on user. Returns: the signed-on user's domain setDomain public void setDomain(java.lang.String domain) Sets the domain of the signed-on user. Parameters: domain - signed-on user's domain getService public java.lang.String getService() Gets the service ID of the signed-on user. Returns: the signed-on user's service ID setService public void setService(java.lang.String service) Sets the service ID of the signed-on user. Parameters: service - signed-on user's service ID getServiceSection public java.lang.String getServiceSection() Gets the service/section of the signed-on user. Returns: the signed-on user's service/section setServiceSection public void setServiceSection(java.lang.String serviceSection) Sets the service/section of the signed-on user. Parameters: serviceSection - signed-on user's service/section getStation public java.lang.String getStation() Gets the station of the signed-on user. Returns: the signed-on user's station setStation public void setStation(java.lang.String station) Sets the station of the signed-on user. Parameters: station - signed-on user's station getStationIen public java.lang.String getStationIen() Gets the station IEN of the signed-on user. Returns: the signed-on user's station IEN setStationIen public void setStationIen(java.lang.String stationIen) Sets the station IEN of the signed-on user. Parameters: stationIen - signed-on user's station IEN getStationNo public java.lang.String getStationNo() Gets the station number of the signed-on user. Returns: the signed-on user's station number setStationNo public void setStationNo(java.lang.String stationNo) Sets the station number of the signed-on user. Parameters: stationNo - signed-on user's station number getTitle public java.lang.String getTitle() Gets the title of the signed-on user. Returns: the signed-on user's title setTitle public void setTitle(java.lang.String title) Sets the title of the signed-on user. Parameters: title - signed-on user's title getUserClass public java.lang.String getUserClass() Gets the class of the signed-on user. Returns: the signed-on user's class setUserClass public void setUserClass(java.lang.String userClass) Sets the class of the signed-on user. Parameters: userClass - signed-on user's class getUserName public java.lang.String getUserName() Gets the name of the signed-on user. Returns: the signed-on user's name setUserName public void setUserName(java.lang.String userName) Sets the name of the signed-on user. Parameters: userName - signed-on user's name getRpcProtocol public IRpcProtocol getRpcProtocol() The Rpc Protocol is the implementation of the RPC Broker protocol used. Returns: the RPC broker protocol used by this RpcBroker setRpcProtocol public void setRpcProtocol(IRpcProtocol rpcProtocol) Sets the RPC version number Parameters: rpcProtocol - the Rpc protocol implementation to use See Also: getRpcProtocol() getRpcProtocolVersion public int getRpcProtocolVersion() The Rpc protocol version is the version of the RPC protocol used. Returns: the RPC broker protocol version used by this RpcBroker setRpcProtocolVersion public void setRpcProtocolVersion(int rpcProtocolVersion) Sets the RPC broker protocol version number Parameters: rpcProtocolVersion - the Rpc protocol version being used See Also: getRpcProtocolVersion() getServer public java.lang.String getServer() The server property contains the name or Internet Protocol (IP) address of the server computer. Returns: the current server host/ip address setServer public void setServer(java.lang.String server) throws BrokerException Changing the name of the server while the RpcBroker is connected disconnects the RpcBroker from the previous server. If the name is used instead of the IP address, it should be resolved by the socket through the Domain Name Service (DNS). Parameters: server - the server host/IP address to set Throws: BrokerException See Also: getServer() getLoginHandle public java.lang.String getLoginHandle() The login handle property holds the application handle for doing a silent login. The application handle is obtained from the server by a currently running application using the getAppHandle method. The login handle may be passed as a command line argument to an application that is being started. The new application must know to look for the handle, and if present, set up the silent login. Note: The app handle that is obtained via the getAppHandle function is only valid for approximately 20 seconds, after which the silent login would fail. Returns: the login handle that was obtained by a previous call to getAppHandle See Also: getAppHandle() getInactiveTimeout public int getInactiveTimeout() Returns the timeout duration (in msec) in which RpcBroker will log off of VistA if a connection has been idle for a period of time. Returns: inactiveTimeout duration of inactivity in msec. setInactiveTimeout public void setInactiveTimeout(int inactiveTimeout) Sets the timeout duration (in msec) for inactivity, after which RpcBroker will log off of VistA. Parameters: inactiveTimeout - the duration of inactivity in msec. getLastMessageTime public java.util.Date getLastMessageTime() Returns the timestamp of the last (non-pulse) message sent to VistA. Returns: timestamp of last RPC invocation. getLogChannel public static LogChannel getLogChannel() The log channel is used to write messages to a logging facility. Returns: the static log channel used by this RpcBroker setLogChannel public static void setLogChannel(LogChannel logChannel) Sets the static log channel used for writing messages to the logging facility. Parameters: logChannel - the log channel to use for logging See Also: getLogChannel() log public void log(int level, java.lang.String msg) Writes the message to the logging facility. Parameters: level - the logging level (e.g. Logger.ERROR) msg - the messge to log log public void log(int level, java.lang.Exception e) Writes the exception message to the logging facility. Parameters: level - the logging level (e.g. Logger.ERROR) msg - the exception to log isConnected public boolean isConnected() Tests if a connection is established, and allows you to branch accordingly depending on whether a connection is established or not. Returns: true if connected to the broker server, false otherwise setConnected public boolean setConnected(boolean value) throws BrokerException If value is true, connects to the broker server using the previously set server host/ip and port. Otherwise, if value is false disconnects from the broker server. Returns: true if connected to the broker server, false otherwise Throws: BrokerException connect public boolean connect() throws BrokerException Connect to the broker server using the previously set server host/ip and port. Returns: true if connected to the broker server, false otherwise Throws: BrokerException connect public boolean connect(java.lang.String server, int port) throws BrokerException Connect to the broker server. Parameters: server - the host name or IP address of the broker server port - the listener port on the broker server Returns: true if connected to the broker server, false otherwise Throws: BrokerException disconnect public boolean disconnect() throws BrokerException Disconnects from the broker server. Returns: true if successfully disconnected, false otherwise Throws: BrokerException createContext public boolean createContext(java.lang.String aContext) throws BrokerException Creates and sets the context on the broker server. You can use the createContext method to create a context for your application. To create context, pass an option name as a parameter. If the function returns true, a context was created, and your application can use all RPCs entered in the option's RPC multiple. If the RpcBroker is not connected at the time context is created, a connection will be established. If for some reason a context could not be created, the createContext method will return False. Since context is nothing more than a client/server 'B'-type option in the OPTION file (#19), standard MenuMan security is applied in establishing a context. Therefore, a context option can be granted to user(s) exactly the same way as regular options are done using MenuMan. Before any RPC can run, it must have a context established for it to on the server. Thus, all RPCs must be registered to one or more 'B'-type option(s). This plays a major role in Broker security. A context cannot be established for the following reasons: The user has no access to that option. The option is temporarily out of order. An application can switch from one context to another as often as it needs to. Each time a context is created the previous context is overwritten. Parameters: context - the context to create Returns: true if the context was created, false otherwise Throws: BrokerException doSignon public java.lang.String doSignon(java.lang.String avCode) throws BrokerException Performs a signon setup and signon using the supplied semicolon delimited access and verify codes. Note that this method returns 0 if the signon was not successful for any reason, including invalid access/verify codes, expired verify code, or inability to connect to the broker server or create the required context. Parameters: avCode - semicolon-delimited access and verify codes Returns: the user's duz if signon was successful, 0 otherwise Throws: BrokerException doSignon public java.lang.String doSignon(java.lang.String accessCode, java.lang.String verifyCode) throws BrokerException Performs a signon setup and signon using the supplied access and verify codes. Parameters: accessCode - the user's access code verifyCode - the user's verify code Returns: the user's duz if signon was successful, 0 otherwise Throws: BrokerException See Also: doSignon(String) doSignon public java.lang.String doSignon() throws BrokerException Performs a signon setup and signon using the cached access and verify codes. Returns: the user's duz if signon was successful, 0 otherwise Throws: BrokerException See Also: doSignon(String) getBrokerInfo public int getBrokerInfo() throws BrokerException Gets info from the server regarding setup and parameters of the broker. Returns: timeout period for handler READs or 0 if the operation was not successful Throws: BrokerException getAppHandle public java.lang.String getAppHandle() throws BrokerException Gets a token that can be used to sign-on a new process. Returns: a token that can be used to sign-on a new process or a blank string ("") if the operation was not successful Throws: BrokerException doPulse public void doPulse() Specified by: doPulse in interface IPulseHandler onTimerEvent public void onTimerEvent() Specified by: onTimerEvent in interface ITimerHandler call public java.lang.String call() throws BrokerException Makes the call on the broker server using the current context and current RPC API. Returns: the result as an array of strings Throws: BrokerException call public java.lang.String call(java.lang.String api, java.lang.Object[] paramArray) throws BrokerException Makes the call on the broker server. Parameters: api - the RPC API to call paramArray - the array of parameters to pass to the call Returns: the result as an array of strings Throws: BrokerException call public java.lang.String call(java.lang.String api, java.lang.String ien) throws BrokerException Makes the call on the broker server using the current context. Parameters: api - the RPC API to call ien - the internal entry number of the record to retrieve Returns: the RPC result Throws: BrokerException call public java.lang.String call(java.lang.String api, Params params) throws BrokerException Makes the call on the broker server using the current context. Parameters: api - the RPC API to call params - the Params object containing the list of params Returns: the RPC resulty Throws: BrokerException call public java.lang.String call(java.lang.String api) throws BrokerException Makes the call on the broker server using the current context. Parameters: api - the RPC API to call Returns: the result as an array of strings Throws: BrokerException callOnRpcBrokerSignon public void callOnRpcBrokerSignon() Calls the onRpcBrokerSignon event handler. lockCallMonitor protected void lockCallMonitor() unlockCallMonitor protected void unlockCallMonitor() main public static void main(java.lang.String[] args)

Class RpcBroker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RPC_BROKER

Constructor Detail

RpcBroker

RpcBroker

RpcBroker

RpcBroker

Method Detail

getEventHandler

setEventHandler

getRpcVersion

setRpcVersion

getClearParams

setClearParameters

doClearParams

getClearResults

setClearResults

doClearResults

isConnecting

createBrokerException

getBrokerException

getCurrentContext

setCurrentContext

setContext

isKernelLogin

setKernelLogin

getListenerPort

setListenerPort

getParams

setParams

getRemoteProcedure

setRemoteProcedure

getResults

getHashedAVCodes

setHashedAVCodes

getErrorMessage

getSecuritySegment

getApplicationSegment

getDataSegment

getUserDuz

setUserDuz

getDomain

setDomain

getService

setService

getServiceSection

setServiceSection

getStation

setStation

getStationIen

setStationIen

getStationNo

setStationNo

getTitle

setTitle

getUserClass

setUserClass

getUserName

setUserName

getRpcProtocol

setRpcProtocol

getRpcProtocolVersion

setRpcProtocolVersion

getServer

setServer

getLoginHandle

getInactiveTimeout

setInactiveTimeout

getLastMessageTime

getLogChannel

setLogChannel

log

log

isConnected

setConnected