com.basis.bbj.webservice

Class BBjWSImpl

java.lang.Object

com.basis.bbj.webservice.BBjWSImpl

public class BBjWSImpl
extends java.lang.Object

This class can be deployed as a Web Service. It will allow the caller to execute any program that is accessible to BBjServices. Although this class may itself be deployed as a Web Service it is suggested that Web Services be built by extending this class and then deploying the extended class. This allows the WebService to have a more specific interface and to constrain the programs which are called. So for example one might have someWebService extends BBjWS that would have a method someWebService.login(String userName) that was implemented by calling invokeBBjReturnBytes() to call a login.bbj.

Constructor Summary

Constructors

Constructor and Description
BBjWSImpl()
BBjWSImpl(java.lang.String p_commandLineParams)

Method Summary

Modifier and Type	Method and Description
void	destroy() the destroy method required in order to implement ServiceLifecycle.
int	getMaxPoolSize() retrieve current setting for max number of JavaBBjBridges in pool.
ServletEndpointContext	getServletEndpointContext() retrieve the servelt endpoint context
void	init(java.lang.Object context) the init method is required in order to implement ServiceLifecycle.
byte[]	invokeBBjReturnBytes(java.lang.String p_programName, java.lang.String p_programParams, java.util.HashMap p_keyValuesAsStrings, int p_timeoutInSeconds) invoke bbj and return a byte[] containing any strings that the bbj program wrote to its J-channel using WRITE
java.util.HashMap	invokeBBjReturnMap(java.lang.String p_programName, java.lang.String p_programParams, java.util.HashMap p_keyValuesAsStrings, int p_timeoutInSeconds) invoke bbj and return the key-value pairs that the called program wrote to its J-channel using writeRecord with a key
void	setMaxPoolSize(int p_poolSize) set max number of JavaBBjBridges in pool

Methods inherited from class java.lang.Object

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

Constructor Detail

BBjWSImpl

public BBjWSImpl()

BBjWSImpl

public BBjWSImpl(java.lang.String p_commandLineParams)

Parameters:

p_commandLineParams - the command line that is to be passed to the bridge when it is created Recognized command line options are "[-c] " + "[-u] " + "[-LP]\n\t" + "[-RH] " + "[-RP] " + "[-SC]]\n\t" +

Method Detail

invokeBBjReturnBytes

public byte[] invokeBBjReturnBytes(java.lang.String p_programName,
                                   java.lang.String p_programParams,
                                   java.util.HashMap p_keyValuesAsStrings,
                                   int p_timeoutInSeconds)
                            throws java.rmi.RemoteException

invoke bbj and return a byte[] containing any strings that the bbj program wrote to its J-channel using WRITE

Parameters:

p_programName - the bbj program that is to be executed

p_programParams - string containing parameters to be passed to program. p_programParams may be null

p_keyValuesAsStrings - a set of key-value pairs that will be made available to the program when it does a readRecord with key. p_keyValuesAsStrings may be null. Each key and each value is expected to be a String.

p_timeoutInSeconds - number of seconds this call should block waiting for execution of program to be complete

Throws:

java.rmi.RemoteException

invokeBBjReturnMap

public java.util.HashMap invokeBBjReturnMap(java.lang.String p_programName,
                                            java.lang.String p_programParams,
                                            java.util.HashMap p_keyValuesAsStrings,
                                            int p_timeoutInSeconds)
                                     throws java.rmi.RemoteException

invoke bbj and return the key-value pairs that the called program wrote to its J-channel using writeRecord with a key

Parameters:

p_programName - the bbj program that is to be executed

p_programParams - string containing parameters to be passed to program. p_programParams may be null

p_keyValuesAsStrings - a set of key-value pairs that will be made available to the program when it does a readRecord with key. p_keyValuesAsStrings may be null. Each key and each value is expected to be a String.

p_timeoutInSeconds - number of seconds this call should block waiting for execution of program to be complete

Throws:

java.rmi.RemoteException

destroy

public void destroy()

the destroy method required in order to implement ServiceLifecycle. this method is called by the deployment container when the deployed service is being shut down

init

public void init(java.lang.Object context)
          throws javax.xml.rpc.ServiceException

the init method is required in order to implement ServiceLifecycle. this method is called with the deployment container is starting this service

Throws:

javax.xml.rpc.ServiceException

getServletEndpointContext

public ServletEndpointContext getServletEndpointContext()

retrieve the servelt endpoint context

getMaxPoolSize

public int getMaxPoolSize()

retrieve current setting for max number of JavaBBjBridges in pool. By default

Returns:

max number of JavaBBjBridges in pool

setMaxPoolSize

public void setMaxPoolSize(int p_poolSize)

set max number of JavaBBjBridges in pool

Parameters:

p_poolSize - max number of JavaBBjBridges in pool If there are already more than p_poolSize JavaBBjBridges already in use then none of those JavaBBjBridges are destroyed although they may time out and be removed from the pool. No new JavaBBjBridges will be created until the current number of JavaBBjBridges falls below maxPoolSize