|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rexxla.bsf.engines.rexx.RexxAndJava
This class manages the calls from Rexx or Object Rexx into Java. (Any scripting language being able to pass Strings to and from Java will be able to use this interface, making it really easy to interface with Java.)
RexxAndJava.java - this class relays Java and (Object) Rexx Copyright (C) 2001-2005 Rony G. Flatscher This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA The following URL may be available for further information: http://www.gnu.org/copyleft/lesser.html
Nested Class Summary | |
(package private) class |
RexxAndJava.ExitDelayed
Class to exit the JVM, will be executed concurrently, sleeps and then calls System.exit(exit_number) . |
protected class |
RexxAndJava.SyncPutGet
Inner class to implement a Synchronized ReaderWriter, where a read on an empty Vector blocks the read, until a write occurs (with optional timeout). |
Field Summary | |
(package private) static boolean |
bMethodHasSetAccessible
true if setting accessibility rights is available, false else. |
protected static java.lang.String |
DLL_NAME
Defines the name of DLL to be used to resolve the native functions. |
protected static java.lang.String |
EVENT_TEXT
Defines the string to indicate an 'eventText' is passed in: "<eventText>". |
protected RexxAndJava.SyncPutGet |
eventTextList
Allows Synchronized access to the vector storing the text sent by the eventListeners. |
(package private) org.apache.bsf.util.type.TypeConvertorRegistry |
glob_tcr
To store the default TypeConvertorRegistry, if needed. |
(package private) java.util.Hashtable |
methodReferences
Allows storing successfully reflected methods. |
(package private) org.apache.bsf.BSFManager |
mgr
Stores the BSF manager. |
protected static java.lang.String |
null4Rexx
Defines the string which represents null , by default
".NIL" . |
(package private) java.util.Hashtable |
orxReferences
Stores the number of references from Object Rexx to Java objects using beanName as the key. |
(package private) org.apache.bsf.BSFEngine |
RexxEngine
Stores the Rexx engine. |
Constructor Summary | |
(package private) |
RexxAndJava(org.apache.bsf.BSFManager mgr,
org.apache.bsf.BSFEngine rengine)
Constructor to receive and store the BSF manager and the Rexx engine. |
Method Summary | |
(package private) java.lang.Object[] |
coerceArgs(java.lang.Object[] funcArgs,
java.lang.Class[] paramTypes)
Coerces the arguments from Rexx to the appropriate Java types. |
java.lang.String |
javaCallBSF(java.lang.String[] args)
Entry point for Rexx calls into Java. |
int |
jniInitialize4Rexx()
rgf, 2003-01-15, used for allowing the BSF4Rexx-DLL to get at *env, *obj and then to mid etc. |
int |
jniRegisterBSF()
This native method makes sure that the function 'BSF' is registered with Rexx, making it thereby available to all Rexx and Object Rexx programs, called from Java. |
int |
jniRexxDidRexxTerminate()
Deprecated. This native method indicates whether the Object Rexx interpreter is still running or not. |
java.lang.String |
jniRexxStart(java.lang.String script,
java.lang.String[] args)
This native method Calls the Rexx interpreter, having it execute the passed in script with the given array of arguments. |
int |
jniRexxWaitForTermination()
Deprecated. This native method waits for the Object Rexx interpreter to terminate and waits until all of the cleanup (e.g. of Object Rexx) is done. |
protected java.lang.String |
makeString4Rexx(java.lang.Object o)
This method determines what String content to return. |
(package private) java.lang.String |
pp(java.lang.Object o)
'Pretty print': returns string value of supplied object enclosed in square brackets. |
protected boolean |
unregisterBean(java.lang.String beanName)
This method allows for unregistering Beans, taking into account reference counters. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String DLL_NAME
protected static final java.lang.String EVENT_TEXT
protected static java.lang.String null4Rexx
null
, by default
".NIL"
. Arguments given by Rexx can in addition
be indicated to be null
by merely omitting them on the Rexx side.
protected RexxAndJava.SyncPutGet eventTextList
static boolean bMethodHasSetAccessible
true
if setting accessibility rights is available, false
else.
org.apache.bsf.BSFManager mgr
org.apache.bsf.BSFEngine RexxEngine
java.util.Hashtable orxReferences
beanName
as the key. This way it becomes possible for the
Object Rexx implementation using "BSF.cls"
to
transparently create Object Rexx proxy objects, if objects are returned
from Java method invocations and to transparently unregister them, when
the Object Rexx proxy objects are garbage collected.
java.util.Hashtable methodReferences
org.apache.bsf.util.type.TypeConvertorRegistry glob_tcr
Constructor Detail |
RexxAndJava(org.apache.bsf.BSFManager mgr, org.apache.bsf.BSFEngine rengine)
Preregisters the most important class objects. Referring to them is possible by using the following strings from Rexx (case *is* significant!):
Method Detail |
public int jniRegisterBSF()
public java.lang.String jniRexxStart(java.lang.String script, java.lang.String[] args)
script
- a String consisting of Rexx statements separated by
by line-end characters (';' or CR-LF).args
- an array of Strings representing the arguments
or null
, if no arguments are available.
null
, if
no result is returned or the Rexx interpreter stopped
execution due to a runtime error.public int jniRexxWaitForTermination()
public int jniRexxDidRexxTerminate()
public int jniInitialize4Rexx()
public java.lang.String javaCallBSF(java.lang.String[] args) throws org.apache.bsf.BSFException
TypeIndicator | Following Argument is of Type: |
"BOolean"
| "boolean" i.e. the value 0 (false) or 1 (true)
|
"BYte"
| "byte" a byte value
|
"Char"
| "char" i.e. a single (UTF8) character
|
"Double"
| "double" a double value
|
"Float"
| "float" a float value
|
"Int"
| "int" an integer value
|
"Long"
| "long" a long value
|
"Object"
| "Object" an Object which must be registered already |
"SHort"
| "short" a short value
|
"STring"
| "String" a string value (UTF8)
|
Hence, for the "...Strict"-subfunctions the Rexx supplied arguments must be given in pairs by Rexx: first the type argument (from the above table) and then the argument itself.
The call syntax from Rexx looks like, e.g.:
call BSF "SubFunctionName", "argument1", "argument2", "", ... or: a=BSF("SubFunctionName", "argument1", "argument2", ...)
The following BSF methods are made available to Rexx and can therefore be indicated as the first argument (the 'subfunction') to the 'BSF' call from Rexx:
SubFunctionName | Argument | Description |
"addEventListener"
| Adds an event listener to a bean and defines the eventText
to be generated. These generated texts can be retrieved with the
function pollEventText .
| |
beanName
| Mandatory, name of a registered bean which should get monitored. | |
eventSetName
| Mandatory, name of the set the event belongs to. This name is used to create an event adapter at runtime. | |
filter
| Mandatory, name of the actual event which should cause a notification. | |
eventText
| Mandatory, text which should be sent by this event listener, each time the event occurs. | |
"arrayAt"
| Allows accessing a Java array element.
Returns the Java object at the indicated array element, or null , if no object is stored there.
| |
arrayObject
| Mandatory, name of a registered arrayObject (received by Java). | |
idx1
| Mandatory, integer indicating the position in dimension 1.
Alternatively, a sole Java int-array containing the 0-based index-values. | |
idx2
| Integer indicating the position in dimension 2 ... | |
"arrayLength"
| Returns the value of the 'length' field of the arrayObject .
| |
arrayObject
| Mandatory, name of a registered arrayObject (received by Java). | |
"arrayPut"
| Allows to put a new value into a Java array element at the indicated position. | |
arrayObject
| Mandatory, name of a registered arrayObject (received by Java). | |
newValue
| The new value to be set at the indicated position in the array. | |
idx1
| Mandatory, integer indicating the position in dimension 1.
Alternatively, a sole Java int-array containing the 0-based index-values. | |
...idxn
| Integer indicating the position in dimension n ... | |
"arrayPutStrict"
| Allows to put a new value into a Java array element at the indicated position. | |
arrayObject
| Mandatory, name of a registered arrayObject (received by Java). | |
typeIndicator
| Type indicator for newValue
| |
newValue
| The new value to be set at the indicated position in the array. | |
idx1
| Mandatory, integer indicating the position in dimension 1.
Alternatively, a sole Java int-array containing the 0-based index-values. | |
... idxn
| Integer indicating the position in dimension n ... | |
"createArray"
| Creates a Java array of the given componentType and number of
dimensions.
Returns the created Java array object. | |
componentType
| Mandatory, name of a registered Java class object. For convenience, you may use any
of the pre-registered beans named (note case of first letter!): " Class.class ",
"Object.class ",
"Method.class ",
"Array.class ",
"String.class ",
"System.class ",
"Boolean.class ",
"boolean.class " (primitive data type),
"Byte.class ",
"byte.class " (primitive data type),
"Character.class ",
"char.class " (primitive data type),
"Double.class ",
"double.class " (primitive data type),
"Integer.class ",
"int.class " (primitive data type),
"Long.class ",
"long.class " (primitive data type),
"Float.class ",
"float.class " (primitive data type),
"Short.class ",
"short.class " (primitive data type).
| |
capacity 1
| Mandatory, integer indicating the number of elements in dimension 1.
Alternatively, a sole Java int-array containing the capacity per dimension. The first dimension is stored with index 0, the second with index 1, ... | |
capacity 2
| Integer indicating the number of elements in dimension 2. | |
... capacity n
| Integer indicating the number of elements in dimension n. | |
"wrapArray"
| Wraps the given array up in a ArrayWrapper -object, allowing
easy access to information about the array like dimensions, size and
also getting and setting values in an easy manner.
| |
arrayObject
| Mandatory, name of a registered arrayObject (received by Java). | |
"exit"
| Terminates the Java Virtual Machine. Allows Rexx
to shut down the JVM (and thereby Rexx as well).
In order for Rexx being able to shutdown properly
itself, the termination of the JVM is delayed by
time2wait .
Returns the string "SHUTDOWN, REXX !" .
| |
retVal
| Optional integer return value. If omitted, then "0"
will be used as argument for the System.exit(n) call.
| |
time2wait
| Optional number of milliseconds (msecs) to wait until the JVM will
be terminated. This allows Rexx to shutdown (clean up) its side as
well. Default value, if omitted: 100 , i.e. 100 msecs,
i.e. 1/10th second.
| |
"getFieldValue"
| Looks up a public field of the registered
object. The case of the characters of the field name does not matter.
Hint: If the field cannot be found, then this subfunction assumes that a getter method (field name prepended by "get") exists for the field and tries to invoke one. If you do not want this behaviour use subfunciton "getFieldValueStrict" instead.
Returns the value of the field. | |
beanName
| Mandatory, name of the object to be looked up. | |
fieldName
| Mandatory, name of the public field of the object. | |
"getFieldValueStrict"
| Looks up a public field of the registered
object. The case of the characters of the field name must match exactly.
Returns the value of the field. | |
beanName
| Mandatory, name of the object to be looked up. | |
fieldName
| Mandatory, case sensitive name of the public field of the object. | |
"getPropertyValue" (untested!)
| Looks up a property of the registered
Java Bean object.
Returns the value of the property. | |
beanName
| Mandatory, name of the Java Bean object to be looked up. | |
propertyName
| Mandatory, name of the Java Bean property. | |
index
| Mandatory, null , if Java Bean property is not indexed,
a valid integer number else.
| |
"getStaticValue"
| Looks up a public static field of the
given class or interface. This function does not instantiate
the class (would not be possible for abstract classes
or interfaces). Case of fieldName is not relevant!
Returns the value of the public static field. | |
className
| Mandatory, name of the class, abstract class or interface to be looked up. | |
fieldName
| Mandatory, name of the public static field of the object. | |
"getStaticValueStrict"
| Looks up a public static field of the
given class or interface. This function does not instantiate
the class (would not be possible for abstract classes
or interfaces). Case of fieldName is relevant!
Returns the value of the public static field. | |
className
| Mandatory, name of the class, abstract class or interface to be looked up. | |
fieldName
| Mandatory, case sensitive name of the public static field of the object. | |
"invoke"
| Invokes (calls) the method with the given arguments
on the bean.
Hint: if the method could not be found and has no arguments, this subfunction assumes that the value of a field is sought. Therefore, it employs the subfunction "getFieldValue" using
the methodName as the fieldName .
If you do not want to use this
feature, then employ the subfunction "invokeStrict" instead.
Returns the result of the method invocation or null .
| |
beanName
| Mandatory, name of a registered bean on which the method (function) should get invoked. | |
methodName
| Mandatory, name of the method which should get invoked. methodName is not
case sensitive!
| |
arg # 1
| Argument # 1 (if given). | |
... arg # n
| Argument # n (if given). | |
"invokeStrict"
| Invokes (calls) the method with the given arguments
on the bean.
The case of the characters of the method name must match exactly.
Each Rexx argument must be preceeded by its Java type.
Returns the result of the method invocation or null .
| |
beanName
| Mandatory, name of a registered bean on which the method (function) should get invoked. | |
methodName
| Mandatory, case sensitive name of the method which should get invoked. | |
typeIndicator # 1
| Type indicator for argument # 1 (if given). | |
arg # 1
| The argument # 1 itself (if given). | |
Any additional arguments must be given in pairs of "typeIndicator" and "arg" as well. | ||
"lookupBean"
| Looks up an object in the BSF
manager object registry. (Allows for retrieving pre-declared
beans as well.)
Returns the object or null , if not found.
| |
beanName
| Mandatory, name of the object to be looked up. Returns
the object rendered to a string or null , if not found.
| |
"pollEventText"
| Polls for the eventText defined in the above subfunction
"addEventListener " placed
into a queue by the appropriate event listeners,
or posted via "postEventText " below.
If no timeout value is supplied, "0" will be used by default, which blocks the return of this function (forever) until some text is available for return. Returns available eventText , or if a
timeout occurred while waiting null .
| |
timeOut
| Optional, timeout in milliseconds, i.e. time to wait for
an eventText to appear, before returning.
| |
"postEventText"
| Adds eventText to the eventText vector (list),
can be retrieved via pollEventText .
Returns the received eventText
| |
eventText
| Mandatory, text which should be put into the eventText vector.
| |
priority
| Optional, priority level of eventText , can be one of:
| |
"registerBean" or"new" (a synonym)
| Creates a new object (instantiating the given Java class
with the given arguments) and registers it using the
given beanName.
Returns beanName (always use this returned beanName for looking up the object in the registry). | |
beanName
| Name of the object to be created and registered.
if no name is given (empty string or null )
then a unique one will be created and returned;
the code to create the unique name is the same
as the documented "Object.hashCode()":
o.getClass().getName() + "@"
+ Integer.toHexString(o.hashCode()) .
| |
beanType
| Mandatory, type (Java class name) of the bean (Java object) to be created and registered. | |
arg # 1
| The argument # 1 (if given). | |
... arg # n
| The argument # n (if given). | |
"registerBeanStrict" or"newStrict" (a synonym)
| Creates a new object (instantiating the given Java class
with the given arguments) and registers it using the
given beanName.
Returns beanName (always use this returned beanName for looking up the object in the registry). | |
beanName
| Name of the object to be created and registered.
if no name is given (empty string or null )
then a unique one will be created and returned;
the code to create the unique name is the same
as the documented "Object.hashCode()":
o.getClass().getName() + "@"
+ Integer.toHexString(o.hashCode()) .
| |
beanType
| Mandatory, type (Java class name) of the bean (Java object) to be created and registered. | |
typeIndicator # 1
| Type indicator for argument # 1 (if given). | |
arg # 1
| The argument # 1 (if given). | |
Any additional arguments must be given in pairs of "typeIndicator" and "arg" as well. | ||
"setFieldValue"
| Looks up a public field of the registered
object and sets it to the argument's value.
Hint: if the field could not be found, this subfunction automatically attempts to employ a setter method ( fieldName
prepended with the string "set"). If you do not want to use this
feature, then employ the subfunction "setFieldValueStrict" instead.
Returns the new value of the field. | |
beanName
| Mandatory, name of the object to be looked up. | |
fieldName
| Mandatory, name of the public field of the object. | |
newValue
| The new value the field gets set to. | |
"setFieldValueStrict"
| Looks up a public field of the registered
object and sets it to the argument's value.
Returns the new value of the field. | |
beanName
| Mandatory, name of the object to be looked up. | |
fieldName
| Mandatory, case sensitive name of the public field of the object. | |
typeIndicator
| optional type indicator for the immediately following argument
(newValue ) or newValue .
| |
newValue
| The new value the field gets set to. (If this argument is given, then the
previous argument is interpreted as a typeIndicator .)
| |
"setPropertyValue" (untested!)
| Looks up a property of the registered
Java Bean object and sets it to the argument's value.
Returns the new value of the property. | |
beanName
| Mandatory, name of the Java Bean object to be looked up. | |
propertyName
| Mandatory, name of the Java Bean property. | |
index
| Mandatory, null , if Java Bean property is not indexed,
a valid integer number else.
| |
newValue
| The new value the property gets set to. | |
"setPropertyValueStrict" (untested!)
| Looks up a property of the registered
Java Bean object and sets it to the argument's value.
Returns the new value of the property. | |
beanName
| Mandatory, name of the Java Bean object to be looked up. | |
propertyName
| Mandatory, name of the Java Bean property. | |
index
| Mandatory, null , if Java Bean property is not indexed,
a valid integer number else.
| |
typeIndicator
| Type indicator for the immediately following argument
(newValue ).
| |
newValue
| The new value the property gets set to. | |
"setRexxNullString"
| Sets the field null4Rexx to the string which serves
as the representation for null .
| |
newString
| Mandatory, the new string to be used to indicate a Java
null .
| |
"sleep"
| Sleeps time2sleep seconds before returning.
| |
time2sleep
| Mandatory, indicates seconds to sleep before returning. time2sleep .
The sleeping occurs with an attempted resolution of milliseconds,
being calculated like:
(long) ((double)time2sleep*1000+0.5d) , e.g.
Hint: If available, use Rexx' | |
"unregisterBean"
| Unregisters an object from the BSF manager's
object registry.
Returns the former beanName of the just unregistered object. | |
beanName
| Mandatory, name of bean (Java object) to be unregistered. | |
"version"
| Returns the version of this program in the form of
"version.YYYYMMMDDD package-name-of-engine info ", e.g.
"254.20050730 org.rexxla.bsf.engines.rexx (org.apache.bsf) "
for IBM's BSF or
"254.20050730 org.rexxla.bsf.engines.rexx (org.apache.bsf) "
for Apache's BSF.
| |
| There exists no argument for this subfunction. | |
"wrapEnumeration"
| Wraps the given object up in a EnumerationWrapper -object, allowing
Java 1.1 programs to use the methods of the Enumeration interface
(the problem: Java 1.1 raises an IllegalAccessException, if accessing
methods of inner classes; starting with 1.2 one can come by this bug
under program control).
| |
enumerationObject
| Mandatory, name of a registered enumerationObject (received by Java). |
null
.
org.apache.bsf.BSFException
java.lang.Object[] coerceArgs(java.lang.Object[] funcArgs, java.lang.Class[] paramTypes)
funcArgs
- an Object
array (actually the Rexx arguments of type
String
)paramTypes
- an Class
array, containing the Java class objects to which
the Rexx arguments have to be converted to
null
else.protected boolean unregisterBean(java.lang.String beanName)
beanName
- name of the Bean to be unregistered
true
, if the Bean exists, false
else.protected java.lang.String makeString4Rexx(java.lang.Object o)
o
- the object which should get returned as a string to Rexx.
null
,
then the string of null4Rexx
is returned to Rexx.java.lang.String pp(java.lang.Object o)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |