com.goldencode.p2j.util

Class LegacyOpenClientCaller

java.lang.Object

com.goldencode.p2j.util.LegacyOpenClientCaller

public class LegacyOpenClientCaller
extends java.lang.Object

Defines APIs to manage the arguments sent by the LegacyJavaAppserverClient.invokeWithArgs(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter[]) call.

The target program acts as a controller, where it identifies the program to dispatch to call from the arguments or other means. Only the OUTPUT or INPUT-OUTPUT argument can be sent back to the caller, via the setArgument(int, com.goldencode.p2j.util.BaseDataType) and other setter APIs.

Arguments need to be retrieved via the getter APIs, and the target controller will need to prepare them, as needed, to be eventually passed to the invokeExternalProgram(java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), invokeMethod(com.goldencode.p2j.util.object<? extends com.goldencode.p2j.oo.lang._BaseObject_>, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]) or invokeStaticMethod(java.lang.String, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), to invoke the real target.

The getter, setters or otherwise APIs can be called only from the context of the target external program acting as a controller. Using these APIs from other code will throw a ErrorConditionException.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LegacyOpenClientCaller.WorkArea Stores global data relating to the state of the current context.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<LegacyOpenClientCaller.WorkArea>	local Context-local state.

Constructor Summary

Constructors

Constructor and Description
LegacyOpenClientCaller()

Method Summary

Modifier and Type	Method and Description
static void	asDataSetParameter(int idx, handle dataset) Associate the given dataset with the dataset-handle parameter at the given index.
static void	asTableParameter(int idx, handle table) Associate the given temp-table with the table-handle parameter at the given index.
(package private) static void	clearArguments() For the LegacyJavaAppserverClient.invokeWithArgs(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter[]) call, clear the argument state, once the call has finished.
static character	getCharacter(int idx) Get the argument at the specified position, as a character.
static handle	getDataSetHandle(int idx) Get the argument at the specified position, as a DATASET-HANDLE.
static date	getDate(int idx) Get the argument at the specified position, as a date.
static datetime	getDatetime(int idx) Get the argument at the specified position, as a datetime.
static datetimetz	getDatetimetz(int idx) Get the argument at the specified position, as a datetimetz.
static decimal	getDecimal(int idx) Get the argument at the specified position, as a decimal.
static int64	getInt64(int idx) Get the argument at the specified position, as a int64.
static integer	getInteger(int idx) Get the argument at the specified position, as a integer.
static logical	getLogical(int idx) Get the argument at the specified position, as a logical.
static longchar	getLongchar(int idx) Get the argument at the specified position, as a longchar.
static memptr	getMemptr(int idx) Get the argument at the specified position, as a memptr.
static integer	getNumArguments() Get the number of arguments sent by the remote side.
static java.lang.String	getParameterType(int idx) Get the argument's type at the specified index.
static raw	getRaw(int idx) Get the argument at the specified position, as a raw.
static recid	getRecid(int idx) Get the argument at the specified position, as a recid.
static rowid	getRowid(int idx) Get the argument at the specified position, as a rowid.
static handle	getTableHandle(int idx) Get the argument at the specified position, as a TABLE-HANDLE.
(package private) static void	initializeArguments(int[] argTypes, java.lang.String modes, java.lang.Object[] args) For the LegacyJavaAppserverClient.invokeWithArgs(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter[]) call, initialize the argument state, before the call was performed.
static void	invokeExternalProgram(character name, character[] ptypes, java.lang.Object[] args) Invoke the target external program.
static void	invokeExternalProgram(java.lang.String name, character[] ptypes, java.lang.Object[] args) Invoke the target external program.
static java.lang.Object	invokeMethod(object<? extends _BaseObject_> ref, character name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target method in the given legacy class instance.
static java.lang.Object	invokeMethod(object<? extends _BaseObject_> ref, java.lang.String name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target method in the given legacy class instance.
static java.lang.Object	invokeStaticMethod(character clsName, character name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target static method in the given legacy class.
static java.lang.Object	invokeStaticMethod(character clsName, java.lang.String name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target static method in the given legacy class.
static java.lang.Object	invokeStaticMethod(java.lang.String clsName, character name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target static method in the given legacy class.
static java.lang.Object	invokeStaticMethod(java.lang.String clsName, java.lang.String name, java.lang.String modes, character[] ptypes, java.lang.Object[] args) Invoke the target static method in the given legacy class.
static boolean	isInput(int idx) Check if the argument at the specified index was sent as INPUT.
static boolean	isInputOutput(int idx) Check if the argument at the specified index was sent as INPUT-OUTPUT.
static boolean	isOutput(int idx) Check if the argument at the specified index was sent as OUTPUT.
private static java.lang.Object[]	resolveArgs(java.lang.String modes, character[] ptypes, java.lang.Object[] args, boolean isOO) Resolve the arguments passed to invokeExternalProgram(java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), invokeStaticMethod(java.lang.String, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]) or invokeMethod(com.goldencode.p2j.util.object<? extends com.goldencode.p2j.oo.lang._BaseObject_>, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), so that they can be passed to the target invocation.
private static void	securityCheck(LegacyOpenClientCaller.WorkArea wa) Check if the call is being performed in the context of the OpenClient call.
private static void	securityCheck(LegacyOpenClientCaller.WorkArea wa, boolean root) Check if the call is being performed in the context of the OpenClient call.
static void	setArgument(int idx, BaseDataType val) Set the argument at the specified position.
static void	setArguments(java.lang.Object... args) Store all the OUTPUT or INPUT-OUTPUT arguments received in the given array to be transferred back to the caller.
static void	setCharacter(int idx, character val) Set the argument at the specified position, as a character.
static void	setDataSetHandle(int idx, handle val) Set the argument at the specified position, as a DATASET-HANDLE.
static void	setDate(int idx, date val) Set the argument at the specified position, as a date.
static void	setDatetime(int idx, datetime val) Set the argument at the specified position, as a datetime.
static void	setDatetimetz(int idx, datetimetz val) Set the argument at the specified position, as a datetimetz.
static void	setDecimal(int idx, decimal val) Set the argument at the specified position, as a decimal.
static void	setInt64(int idx, int64 val) Set the argument at the specified position, as a int64.
static void	setInteger(int idx, integer val) Set the argument at the specified position, as a integer.
static void	setLogical(int idx, logical val) Set the argument at the specified position, as a logical.
static void	setLongchar(int idx, longchar val) Set the argument at the specified position, as a longchar.
static void	setMemptr(int idx, memptr val) Set the argument at the specified position, as a memptr.
static void	setRaw(int idx, raw val) Set the argument at the specified position, as a raw.
static void	setRecid(int idx, recid val) Set the argument at the specified position, as a recid.
static void	setRowid(int idx, rowid val) Set the argument at the specified position, as a rowid.
static void	setTableHandle(int idx, handle val) Set the argument at the specified position, as a TABLE-HANDLE.
private static java.lang.Object	toJava(LegacyOpenClientCaller.WorkArea wa, int idx, int argType, java.lang.Object arg) For a setter, convert the given argument to its representation so it can be sent back to the remote side.
private static BaseDataType	toLegacy(LegacyOpenClientCaller.WorkArea wa, int idx) Get the argument at the given 1-based index in a BaseDataType form, used by the legacy converted code.
private static void	validateIndex(LegacyOpenClientCaller.WorkArea wa, int idx) Validate the given index to be in the LegacyOpenClientCaller.WorkArea.arguments range.
private static void	validateIndex(LegacyOpenClientCaller.WorkArea wa, int idx, boolean validateBound) Validate the given index to be in the LegacyOpenClientCaller.WorkArea.arguments range.

Methods inherited from class java.lang.Object

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

Field Detail

local

private static final ContextLocal<LegacyOpenClientCaller.WorkArea> local

Context-local state.

Constructor Detail

LegacyOpenClientCaller

public LegacyOpenClientCaller()

Method Detail

asDataSetParameter

public static void asDataSetParameter(int idx,
                                      handle dataset)

Associate the given dataset with the dataset-handle parameter at the given index.

This will act as if the given dataset reference has been defined as a parameter for the external program.

Parameters:

idx - The 1-based index for the argument.

dataset - The handle to a static dataset or a handle where to store the dynamic dataset, otherwise.

asTableParameter

public static void asTableParameter(int idx,
                                    handle table)

Associate the given temp-table with the table-handle parameter at the given index.

This will act as if the given DMO reference has been defined as a parameter for the external program.

Parameters:

idx - The 1-based index for the argument.

table - The handle to a static temp-table or a handle where to store the dynamic temp-table, otherwise.

getNumArguments

public static integer getNumArguments()

Get the number of arguments sent by the remote side.

Returns:

See above.

isInput

public static boolean isInput(int idx)

Check if the argument at the specified index was sent as INPUT.

Parameters:

idx - The 1-based index for the argument.

Returns:

true if the argument's mode is INPUT.

isOutput

public static boolean isOutput(int idx)

Check if the argument at the specified index was sent as OUTPUT.

Parameters:

idx - The 1-based index for the argument.

Returns:

true if the argument's mode is OUTPUT.

isInputOutput

public static boolean isInputOutput(int idx)

Check if the argument at the specified index was sent as INPUT-OUTPUT.

Parameters:

idx - The 1-based index for the argument.

Returns:

true if the argument's mode is INPUT-OUTPUT.

getParameterType

public static java.lang.String getParameterType(int idx)

Get the argument's type at the specified index.

Parameters:

idx - The 1-based index for the argument.

Returns:

The string representation of the argument's 4GL type.

invokeExternalProgram

public static void invokeExternalProgram(java.lang.String name,
                                         character[] ptypes,
                                         java.lang.Object[] args)

Invoke the target external program.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

name - The target external program.

ptypes - The argument data-types.

args - The arguments.

invokeExternalProgram

public static void invokeExternalProgram(character name,
                                         character[] ptypes,
                                         java.lang.Object[] args)

Invoke the target external program.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

name - The target external program.

ptypes - The argument data-types.

args - The arguments.

invokeStaticMethod

public static java.lang.Object invokeStaticMethod(java.lang.String clsName,
                                                  java.lang.String name,
                                                  java.lang.String modes,
                                                  character[] ptypes,
                                                  java.lang.Object[] args)

Invoke the target static method in the given legacy class.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

clsName - The target legacy class name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

invokeStaticMethod

public static java.lang.Object invokeStaticMethod(character clsName,
                                                  java.lang.String name,
                                                  java.lang.String modes,
                                                  character[] ptypes,
                                                  java.lang.Object[] args)

Invoke the target static method in the given legacy class.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

clsName - The target legacy class name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

invokeStaticMethod

public static java.lang.Object invokeStaticMethod(java.lang.String clsName,
                                                  character name,
                                                  java.lang.String modes,
                                                  character[] ptypes,
                                                  java.lang.Object[] args)

Invoke the target static method in the given legacy class.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

clsName - The target legacy class name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

invokeStaticMethod

public static java.lang.Object invokeStaticMethod(character clsName,
                                                  character name,
                                                  java.lang.String modes,
                                                  character[] ptypes,
                                                  java.lang.Object[] args)

Invoke the target static method in the given legacy class.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

clsName - The target legacy class name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

invokeMethod

public static java.lang.Object invokeMethod(object<? extends _BaseObject_> ref,
                                            java.lang.String name,
                                            java.lang.String modes,
                                            character[] ptypes,
                                            java.lang.Object[] args)

Invoke the target method in the given legacy class instance.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

ref - The target instance.

name - The target legacy method name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

invokeMethod

public static java.lang.Object invokeMethod(object<? extends _BaseObject_> ref,
                                            character name,
                                            java.lang.String modes,
                                            character[] ptypes,
                                            java.lang.Object[] args)

Invoke the target method in the given legacy class instance.

The argument types must be specified, so FWD runtime can build the proper argument for i.e. TABLE-HANDLE or DATASET-HANDLE.

Parameters:

ref - The target instance.

name - The target legacy method name.

modes - The argument modes.

ptypes - The argument data-types.

args - The arguments.

getTableHandle

public static handle getTableHandle(int idx)

Get the argument at the specified position, as a TABLE-HANDLE.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setTableHandle

public static void setTableHandle(int idx,
                                  handle val)

Set the argument at the specified position, as a TABLE-HANDLE.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getDataSetHandle

public static handle getDataSetHandle(int idx)

Get the argument at the specified position, as a DATASET-HANDLE.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setDataSetHandle

public static void setDataSetHandle(int idx,
                                    handle val)

Set the argument at the specified position, as a DATASET-HANDLE.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getMemptr

public static memptr getMemptr(int idx)

Get the argument at the specified position, as a memptr.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setMemptr

public static void setMemptr(int idx,
                             memptr val)

Set the argument at the specified position, as a memptr.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getInteger

public static integer getInteger(int idx)

Get the argument at the specified position, as a integer.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setInteger

public static void setInteger(int idx,
                              integer val)

Set the argument at the specified position, as a integer.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getInt64

public static int64 getInt64(int idx)

Get the argument at the specified position, as a int64.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setInt64

public static void setInt64(int idx,
                            int64 val)

Set the argument at the specified position, as a int64.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getDecimal

public static decimal getDecimal(int idx)

Get the argument at the specified position, as a decimal.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setDecimal

public static void setDecimal(int idx,
                              decimal val)

Set the argument at the specified position, as a decimal.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getCharacter

public static character getCharacter(int idx)

Get the argument at the specified position, as a character.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setCharacter

public static void setCharacter(int idx,
                                character val)

Set the argument at the specified position, as a character.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getLongchar

public static longchar getLongchar(int idx)

Get the argument at the specified position, as a longchar.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setLongchar

public static void setLongchar(int idx,
                               longchar val)

Set the argument at the specified position, as a longchar.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getLogical

public static logical getLogical(int idx)

Get the argument at the specified position, as a logical.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setLogical

public static void setLogical(int idx,
                              logical val)

Set the argument at the specified position, as a logical.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getDate

public static date getDate(int idx)

Get the argument at the specified position, as a date.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setDate

public static void setDate(int idx,
                           date val)

Set the argument at the specified position, as a date.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getDatetime

public static datetime getDatetime(int idx)

Get the argument at the specified position, as a datetime.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setDatetime

public static void setDatetime(int idx,
                               datetime val)

Set the argument at the specified position, as a datetime.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getDatetimetz

public static datetimetz getDatetimetz(int idx)

Get the argument at the specified position, as a datetimetz.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setDatetimetz

public static void setDatetimetz(int idx,
                                 datetimetz val)

Set the argument at the specified position, as a datetimetz.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getRecid

public static recid getRecid(int idx)

Get the argument at the specified position, as a recid.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setRecid

public static void setRecid(int idx,
                            recid val)

Set the argument at the specified position, as a recid.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getRaw

public static raw getRaw(int idx)

Get the argument at the specified position, as a raw.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setRaw

public static void setRaw(int idx,
                          raw val)

Set the argument at the specified position, as a raw.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

getRowid

public static rowid getRowid(int idx)

Get the argument at the specified position, as a rowid.

Parameters:

idx - The 1-based argument index.

Returns:

The argument's value.

setRowid

public static void setRowid(int idx,
                            rowid val)

Set the argument at the specified position, as a rowid.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

setArgument

public static void setArgument(int idx,
                               BaseDataType val)

Set the argument at the specified position.

Parameters:

idx - The 1-based argument index.

val - The argument's value.

setArguments

public static void setArguments(java.lang.Object... args)

Store all the OUTPUT or INPUT-OUTPUT arguments received in the given array to be transferred back to the caller.

Parameters:

args - The arguments.

initializeArguments

static void initializeArguments(int[] argTypes,
                                java.lang.String modes,
                                java.lang.Object[] args)

For the LegacyJavaAppserverClient.invokeWithArgs(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter[]) call, initialize the argument state, before the call was performed.

Parameters:

argTypes - The argument types.

modes - The argument modes.

args - The arguments.

clearArguments

static void clearArguments()

For the LegacyJavaAppserverClient.invokeWithArgs(java.lang.String, com.goldencode.p2j.util.LegacyJavaAppserverParameter[]) call, clear the argument state, once the call has finished.

toJava

private static java.lang.Object toJava(LegacyOpenClientCaller.WorkArea wa,
                                       int idx,
                                       int argType,
                                       java.lang.Object arg)

For a setter, convert the given argument to its representation so it can be sent back to the remote side.

Parameters:

wa - The context-local instance.

idx - The 0-based argument index.

argType - The argument type, one of the LegacyJavaAppserverApi.integer() APIs.

arg - The argument instance.

Returns:

The argument, in the form where it can be stored in LegacyOpenClientCaller.WorkArea.arguments, to be sent back to the remote side.

toLegacy

private static BaseDataType toLegacy(LegacyOpenClientCaller.WorkArea wa,
                                     int idx)

Get the argument at the given 1-based index in a BaseDataType form, used by the legacy converted code.

Parameters:

wa - The context-local instance.

idx - The 1-based argument index.

Returns:

See above.

resolveArgs

private static java.lang.Object[] resolveArgs(java.lang.String modes,
                                              character[] ptypes,
                                              java.lang.Object[] args,
                                              boolean isOO)

Resolve the arguments passed to invokeExternalProgram(java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), invokeStaticMethod(java.lang.String, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]) or invokeMethod(com.goldencode.p2j.util.object<? extends com.goldencode.p2j.oo.lang._BaseObject_>, java.lang.String, java.lang.String, com.goldencode.p2j.util.character[], java.lang.Object[]), so that they can be passed to the target invocation.

Parameters:

modes - The argument modes.

ptypes - The string-representation of the argument types.

args - The arguments.

isOO - Flag indicating if this is a OO call.

Returns:

See above.

validateIndex

private static void validateIndex(LegacyOpenClientCaller.WorkArea wa,
                                  int idx)

Validate the given index to be in the LegacyOpenClientCaller.WorkArea.arguments range.

Parameters:

wa - The context-local instance.

idx - The 1-based index.

validateIndex

private static void validateIndex(LegacyOpenClientCaller.WorkArea wa,
                                  int idx,
                                  boolean validateBound)

Validate the given index to be in the LegacyOpenClientCaller.WorkArea.arguments range.

Parameters:

wa - The context-local instance.

idx - The 1-based index.

validateBound - Flag indicating if the LegacyOpenClientCaller.WorkArea.boundArguments needs to be false.

securityCheck

private static void securityCheck(LegacyOpenClientCaller.WorkArea wa)

Check if the call is being performed in the context of the OpenClient call. This means that ProcedureManager.ProcedureHelper._thisProcedure() must be the same as ProcedureManager.ProcedureHelper._rootProcedure().

Parameters:

wa - The context-local instance.

root - Flag indicating we must be in the root external block.

securityCheck

private static void securityCheck(LegacyOpenClientCaller.WorkArea wa,
                                  boolean root)

Check if the call is being performed in the context of the OpenClient call. This means that ProcedureManager.ProcedureHelper._thisProcedure() must be the same as ProcedureManager.ProcedureHelper._rootProcedure().

Parameters:

wa - The context-local instance.

root - Flag indicating we must be in the root external block.