com.goldencode.p2j.util

Class LegacyJavaAppserverClient

java.lang.Object

com.goldencode.p2j.util.LegacyJavaAppserver

com.goldencode.p2j.util.LegacyJavaAppserverClient

All Implemented Interfaces:

LegacyJavaAppserverApi

Direct Known Subclasses:

MockLegacyJavaAppserverClient, RemoteLegacyJavaAppserverClient

public class LegacyJavaAppserverClient
extends LegacyJavaAppserver

Provides helper APIs to interact with the Appserver running in the same FWD server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	LegacyJavaAppserverClient.JavaClientAppServerWork Interface for the work task to be processed by the legacy appserver worker, as prepared by the java client.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	connectionID The appserver connection ID for this client.
protected static CentralLogger	LOG Anonymous log instance.
protected AppServerConnectionPool	pool The pool of workers.
protected long	sessionID The session ID associated with this client.

Fields inherited from interface com.goldencode.p2j.util.LegacyJavaAppserverApi

INPUT, INPUT_OUTPUT, OUTPUT, TYPE_BLOB, TYPE_CHARACTER, TYPE_CLOB, TYPE_DATASET, TYPE_DATASET_HANDLE, TYPE_DATE, TYPE_DATETIME, TYPE_DATETIMETZ, TYPE_DECIMAL, TYPE_HANDLE, TYPE_INT64, TYPE_INTEGER, TYPE_LOGICAL, TYPE_LONGCHAR, TYPE_MEMPTR, TYPE_RAW, TYPE_RECID, TYPE_ROWID, TYPE_TABLE, TYPE_TABLE_HANDLE, TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
LegacyJavaAppserverClient(AppServerConnectionPool pool) Initialize this client with the given worker pool.
LegacyJavaAppserverClient(AppServerConnectionPool pool, boolean normalizedExtent) Initialize this client with the given worker pool.

Method Summary

Modifier and Type	Method and Description
void	cancelAllRequests() Cancel all the requests active on this client.
boolean	connect() Execute the connection to the worker.
static LegacyJavaAppserverClient	connectRemote(BootstrapConfig cfg, java.lang.String appserver) Establish a remote client connection, and connect it to the target appserver.
static LegacyJavaAppserverClient	connectRemote(BootstrapConfig cfg, java.lang.String appserver, boolean sessionFree) Establish a remote client connection, and connect it to the target appserver.
void	deleteProcedure(handle h) Delete the specified procedure handle.
void	disconnect() Disconnect this client.
protected boolean	execute(LegacyAppServerWork work) Send the given task to be executed by one of the workers in the pool.
private java.lang.String	getTarget() Get the target for the current web request.
void	invokeWithArgs(java.lang.String procedure, LegacyJavaAppserverParameter[] paramArray) Perform a pseudo-dynamic call where the target procedure doesn't receive the parameter as arguments at the Java method definition, but instead they are managed via LegacyOpenClientCaller APIs.
boolean	isInitialized() Check if the pool is initialized.
java.lang.Object	runFunction(handle proxy, java.lang.String function, LegacyJavaAppserverParameter... paramArray) Run the specified internal function in the given proxy external program.
handle	runPersistentProcedure(java.lang.String procedureName, LegacyJavaAppserverParameter... paramArray) Run an external program persistent.
java.lang.String	runProcedure(handle proxy, java.lang.String procedure, LegacyJavaAppserverParameter... paramArray) Run the specified internal procedure in the given proxy external program.
java.lang.String	runProcedure(java.lang.String procedure, LegacyJavaAppserverParameter... paramArray) Run the specified external program in non-persistent mode.
handle	runSingleRunProcedure(java.lang.String procedure, LegacyJavaAppserverParameter... paramArray) Run the specified external program in SINGLE-RUN mode.
handle	runSingletonProcedure(java.lang.String procedure, LegacyJavaAppserverParameter... paramArray) Run the specified external program in SINGLETON mode.
static void	setMergeTables(boolean state) Set the DataSetSDOHelper.setMergeTables(boolean) flag.
(package private) void	setParameterOrig(LegacyJavaAppserverParameter param, java.lang.Object orig) Set the orig value, useful when mocking the LegacyJavaAppserverClient.
static void	setUnknownValuesForFields(boolean state) Set the DataSetSDOHelper.setUnknownValuesForFields(boolean) flag.

Methods inherited from class com.goldencode.p2j.util.LegacyJavaAppserver

addDataObject, addDataObject, addRelation, addTableMetaData, addTableMetaData, beginLogging, createDataGraph, createDataGraph, createDataObject, createDataObject, createGraphMetaData, createMemptr, createObjectMetaData, createObjectMetaData, endLogging, getArgumentModes, getArguments, getBeforeObjects, getBytes, getChangedDataObjects, getChanges, getChangeSummary, getChildRows, getConnection, getDataGraphName, getDataObjects, getDataObjects, getDataObjects, getFieldCount, getFieldName, getFields, getFieldType, getGraphName, getGregorianCalendar, getGregorianCalendar, getJavaParameter, getJavaParameter, getMetaData, getNamespacePrefix, getNamespaceURI, getNumTables, getNumTables, getOutputParameter, getOutputParameter, getRelation, getRelation, getRelations, getRelations, getTableFieldCount, getTableFieldNames, getTableFields, getTableFieldType, getTableFieldType, getTableIndex, getTableIndex, getTableIndex, getTableMetaData, getTableMetaData, getTableMetaData, getTableName, getTableNames, getXmlNodeName, isCreated, isDeleted, isMemptr, isTableField, postProcessArguments, selectRows, setDefaultTrackChanges, setFieldMetaData, setGregorianCalendar, setNamespacePrefix, setNamespaceURI, setNormalizedExtent, setXmlNodeName, useSchemaMarshalNone

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.LegacyJavaAppserverApi

blob, character, clob, dataset, datasetHandle, date, datetime, datetimetz, decimal, handle, input, inputOutput, int64, integer, logical, longchar, memptr, output, raw, recid, rowid, table, tableHandle, unknown

Field Detail

LOG

protected static final CentralLogger LOG

Anonymous log instance.

pool

protected final AppServerConnectionPool pool

The pool of workers.

sessionID

protected final long sessionID

The session ID associated with this client.

connectionID

protected java.lang.String connectionID

The appserver connection ID for this client. May be shared by multiple client sessions.

Constructor Detail

LegacyJavaAppserverClient

public LegacyJavaAppserverClient(AppServerConnectionPool pool)

Initialize this client with the given worker pool.

Parameters:

pool - The pool of workers where tasks will be forwarded, to be executed on the remote appserver.

LegacyJavaAppserverClient

public LegacyJavaAppserverClient(AppServerConnectionPool pool,
                                 boolean normalizedExtent)

Initialize this client with the given worker pool.

Parameters:

pool - The pool of workers where tasks will be forwarded, to be executed on the remote appserver.

normalizedExtent - The extent field mode.

Method Detail

connectRemote

public static LegacyJavaAppserverClient connectRemote(BootstrapConfig cfg,
                                                      java.lang.String appserver)

Establish a remote client connection, and connect it to the target appserver.

Parameters:

cfg - The configuration to connect to the remote FWD server.

appserver - The appserver name for the target connection.

Returns:

The client, used to perform calls on that connection.

connectRemote

public static LegacyJavaAppserverClient connectRemote(BootstrapConfig cfg,
                                                      java.lang.String appserver,
                                                      boolean sessionFree)

Establish a remote client connection, and connect it to the target appserver.

Parameters:

cfg - The configuration to connect to the remote FWD server.

appserver - The appserver name for the target connection.

sessionFree - Flag indicating if session-free mode is used.

Returns:

The client, used to perform calls on that connection.

setUnknownValuesForFields

public static void setUnknownValuesForFields(boolean state)

Set the DataSetSDOHelper.setUnknownValuesForFields(boolean) flag. This will allow the getter to return null if the field is not currently set in a table row (or even if it was set to null), instead of returning 0 or false for Java native types (like int and boolean).

Parameters:

state - true to return null if the field is not set.

setMergeTables

public static void setMergeTables(boolean state)

Set the DataSetSDOHelper.setMergeTables(boolean) flag. This will allow the response to be merged based on the signature instead of being replaced in the dataset.

Parameters:

state - true to merge the response.

cancelAllRequests

public void cancelAllRequests()

Cancel all the requests active on this client.

isInitialized

public boolean isInitialized()

Check if the pool is initialized.

Returns:

See above.

connect

public boolean connect()

Execute the connection to the worker.

Returns:

true if it connected.

invokeWithArgs

public void invokeWithArgs(java.lang.String procedure,
                           LegacyJavaAppserverParameter[] paramArray)

Perform a pseudo-dynamic call where the target procedure doesn't receive the parameter as arguments at the Java method definition, but instead they are managed via LegacyOpenClientCaller APIs.

This allows the target program to act as a controller, where it can prepare the arguments, perform security checks, etc, before dispatching the call to the real target, which can be resolved from the arguments or in some other way.

Parameters:

procedure - The target external program. Must have no parameters defined.

paramArray - The parameter array.

deleteProcedure

public void deleteProcedure(handle h)
                     throws ConditionException,
                            RuntimeAppserverError

Delete the specified procedure handle.

Parameters:

h - The procedure handle.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runFunction

public java.lang.Object runFunction(handle proxy,
                                    java.lang.String function,
                                    LegacyJavaAppserverParameter... paramArray)

Run the specified internal function in the given proxy external program.

Parameters:

proxy - A proxy external program obtained via runPersistentProcedure(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter...).

function - The internal function name.

paramArray - The parameters.

Returns:

The function's returned value.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runProcedure

public java.lang.String runProcedure(java.lang.String procedure,
                                     LegacyJavaAppserverParameter... paramArray)
                              throws ConditionException,
                                     RuntimeAppserverError

Run the specified external program in non-persistent mode.

Parameters:

procedure - The external program name.

paramArray - The parameters.

Returns:

The RETURN-VALUE.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runSingleRunProcedure

public handle runSingleRunProcedure(java.lang.String procedure,
                                    LegacyJavaAppserverParameter... paramArray)
                             throws ConditionException,
                                    RuntimeAppserverError

Run the specified external program in SINGLE-RUN mode.

Parameters:

procedure - The external program name.

paramArray - The parameters.

Returns:

The RETURN-VALUE.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runSingletonProcedure

public handle runSingletonProcedure(java.lang.String procedure,
                                    LegacyJavaAppserverParameter... paramArray)
                             throws ConditionException,
                                    RuntimeAppserverError

Run the specified external program in SINGLETON mode.

Parameters:

procedure - The external program name.

paramArray - The parameters.

Returns:

The RETURN-VALUE.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runProcedure

public java.lang.String runProcedure(handle proxy,
                                     java.lang.String procedure,
                                     LegacyJavaAppserverParameter... paramArray)
                              throws ConditionException,
                                     RuntimeAppserverError

Run the specified internal procedure in the given proxy external program.

Parameters:

proxy - A proxy external program obtained via runPersistentProcedure(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter...).

procedure - The internal procedure name.

paramArray - The parameters.

Returns:

The RETURN-VALUE.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

runPersistentProcedure

public handle runPersistentProcedure(java.lang.String procedureName,
                                     LegacyJavaAppserverParameter... paramArray)
                              throws ConditionException,
                                     RuntimeAppserverError

Run an external program persistent.

Parameters:

procedureName - The procedure name.

paramArray - The parameters.

Returns:

The proxy for this external program.

Throws:

ConditionException - In case the remote call has thrown an condition (STOP, QUIT, ERROR).

RuntimeAppserverError - In case the remote call has thrown an unexpected error.

disconnect

public void disconnect()

Disconnect this client.

execute

protected boolean execute(LegacyAppServerWork work)

Send the given task to be executed by one of the workers in the pool.

Parameters:

work - The work to be executed.

Throws:

java.lang.RuntimeException - If the request was not posted to any worker or the time allowed to execute has elapsed.

setParameterOrig

void setParameterOrig(LegacyJavaAppserverParameter param,
                      java.lang.Object orig)

Set the orig value, useful when mocking the LegacyJavaAppserverClient.

Parameters:

param - The parameter instance.

orig - The value assumed to be returned by the remote side.

getTarget

private java.lang.String getTarget()

Get the target for the current web request. If no HTTP web request is available, return 'n/a'.

Returns:

See above.