![]() |
T4S4
18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
|
Commands to work with Java pipe servers. More...
Functions | |
activate javaServerVar | |
Activate the pipe server. More... | |
activateFor javaServerVar application | |
Activate the pipe server for the given application. More... | |
addPlugins javaServerVar args | |
Add jars or directories to classpath. More... | |
copy javaServerVar copyVar | |
Copy an array representing a java pipe server to a new array. More... | |
eExecute handle timeout command args | |
Execute a command with the EPipeServer. More... | |
execute javaServerVar command args | |
Execute a command. More... | |
extendClassPath javaServerVar args | |
Add class path entries. More... | |
extendJVMArgs javaServerVar args | |
Add addtional parameters for the JVM. More... | |
getClassPath javaServerVar | |
Return the classpath. More... | |
getDefaultLogChannel javaServerVar | |
Return default log channel for this pipe server. More... | |
getEPipeServerHandle javaServerVar | |
Return the handle of an EPipe based pipe server. More... | |
initialize javaServerVar | |
Initialize this pipe server. You do not need to call this as it happens on demand. More... | |
isEPipeServerHandleValid handle | |
Test whether the handle of an EPipe based pipe server is valid or not, i.e. whether the pipe is running or not. More... | |
isRunning javaServerVar | |
Test whether the given Java server is running or not. More... | |
reset javaServerVar | |
Reset all values to their defaults. More... | |
setClassPath javaServerVar classPathAsAList | |
Set an alternate class path. More... | |
setDefaultLogChannel javaServerVar newDefaultLogChannel | |
Set default log channel for this pipe server. More... | |
setFilterFile javaServerVar filterFile | |
Specify where to configure filters to reduce the amount of traced data. More... | |
setIdleTimeout javaServerVar timeout | |
Set idle timeout, the amount of idle time after which to stop the pipe server. More... | |
setInitialJavaHeapSize javaServerVar initialJavaHeapSizeInMegaBytes | |
Set the initial java heap size (the value set with -Xms) More... | |
setJavaDataModel javaServerVar javaDataModel | |
Set the data model of the java virtual machine using the -d64 command line option. More... | |
setMainClass javaServerVar newMainClass | |
Set main class implementing the PipeServer. More... | |
setMaximumJavaHeapSize javaServerVar maximumJavaHeapSizeInMegaBytes | |
Set the maximum java heap size (the value set with -Xmx) More... | |
setProfilingType javaServerVar mem_or_cpu | |
Set whether you want to profile execution types or memory consumption. More... | |
setRemoteDebuggingEnabled javaServerVar enabledAsABoolean | |
Set whether to prepare the pipe server for debugging or not. More... | |
setRemoteDebuggingPort javaServerVar portAsAnInteger | |
Set port number under which the remote debugger will connect to the pipe server. More... | |
setRemoteProfilingEnabled javaServerVar enabledAsABoolean | |
Set whether to prepare the pipe server for debugging or not. More... | |
setTimeout javaServerVar timeout | |
Set timeout, the amount of time after which to give up waiting for a result. More... | |
setTraceFile javaServerVar traceFile | |
Specify where to store trace information. More... | |
setUseStreamPipe javaServerVar useStreamPipe | |
Specify whether to use the old stream based pipe server or the newer EPipe based pipe server. More... | |
setWaitForRemoteDebugger javaServerVar waitAsABoolean | |
Control whether or not to block the pipe server until the remote debugger connects. More... | |
sExecute handle command args | |
Execute a command with the EPipeServer. Other than with eExecute the timeout is read from the handle. More... | |
tpcontrol javaServerVar command args | |
Control the pipe server. More... | |
Commands to work with Java pipe servers.
Java pipe servers are the foundation of some of the features of T4x and its flavors. There are test scripts you can try out and look into to learn more about them. Inside the T4x installation directory the test scripts are located in var/test
. When you are in the T4x web interface (also known as Admin GUI) navigate to Script → Scripts. The test script are organized in folders and the test scripts dealing with functionality based on the Object Server are under Samples.
Find below which test scripts we have prepared to assist you in customizing functionalities based on Java pipe servers.
If you select the test script in the web interface the name of the file becomes visible. You can also look into the file using the script debugger.
Note that not all of the above features may be present in your installation of T4x.
T4X::JAVASERVER::activate | javaServerVar | ||
Activate the pipe server.
Activating the pipe server means: Check if initialization has gone without errors and in case of the EPipe based pipe server obtain a PipeServer handle if we don't have one already using the tpco_openECMD command. This actually starts the EPipe based pipe server.
javaServerVar | name of an array representing the pipe server |
References activateFor().
T4X::JAVASERVER::activateFor | javaServerVar application | ||
Activate the pipe server for the given application.
Activating the pipe server means: Check if initialization has gone without errors and in case of the EPipe based pipe server obtain a PipeServer handle if we don't have one already using the tpco_openECMD command. This actually starts the EPipe based pipe server.
javaServerVar | name of an array representing the pipe server |
application | name of the application for which to query the java binary path and other parameters that control how the JVM will be started. |
References initialize(), and tpco_openECMD().
Referenced by activate(), T4X::SOA::importSSLCertificate(), T4X::SOA::performGenericWebServiceCall2(), T4X::SOA::performGenericWebServiceCallFireAndForget(), T4X::SOA::setProxy(), and T4X::OBJECTS::tpmodule().
T4X::JAVASERVER::addPlugins | javaServerVar args | ||
Add jars or directories to classpath.
They are assumed to reside in the installation's lib directory.
javaServerVar | name of an array representing the pipe server |
args | variable argument list with each argument representing a jar or directory to be added to the class path |
References initialize().
T4X::JAVASERVER::copy | javaServerVar copyVar | ||
Copy an array representing a java pipe server to a new array.
javaServerVar | name of an array representing the pipe server to copy from. |
copyVar | name of an array representing the pipe server to copy to. |
Referenced by T4X::OBJECTS::cloneDefaultJavaServer().
T4X::JAVASERVER::eExecute | handle timeout command args | ||
Execute a command with the EPipeServer.
handle | of the pipe server |
timeout | after which to give up waiting for a result |
command | name of the command to execute |
args | variable length argument list of args to be passed to the command |
References tpco_sendECMD().
T4X::JAVASERVER::execute | javaServerVar command args | ||
Execute a command.
javaServerVar | name of an array representing the pipe server |
command | name of the command to execute |
args | variable length argument list of args to be passed to the command |
References tpco_sendECMD().
Referenced by T4X::SOA::importSSLCertificate(), T4X::SOA::performGenericWebServiceCall2(), T4X::SOA::performGenericWebServiceCallFireAndForget(), T4X::SOA::setProxy(), T4X::OBJECTS::tpnumbers(), and T4X::OBJECTS::tpsnapshot().
T4X::JAVASERVER::extendClassPath | javaServerVar args | ||
Add class path entries.
javaServerVar | name of an array representing the pipe server |
args | variable argument list with each argument representing a class path entry |
References initialize().
Referenced by T4X::SOA::extendClassPath().
T4X::JAVASERVER::extendJVMArgs | javaServerVar args | ||
Add addtional parameters for the JVM.
javaServerVar | name of an array representing the pipe server |
args | parameters to add to the command line of the JVM |
References initialize().
Referenced by T4X::SOA::extendJVMArgs().
T4X::JAVASERVER::getClassPath | javaServerVar | ||
Return the classpath.
javaServerVar | name of an array representing the pipe server |
References initialize().
T4X::JAVASERVER::getDefaultLogChannel | javaServerVar | ||
Return default log channel for this pipe server.
javaServerVar | name of an array representing the pipe server |
References initialize().
T4X::JAVASERVER::getEPipeServerHandle | javaServerVar | ||
Return the handle of an EPipe based pipe server.
Ensures that the pipe server is running.
T4X::JAVASERVER::initialize | javaServerVar | ||
Initialize this pipe server. You do not need to call this as it happens on demand.
javaServerVar | name of an array representing the pipe server |
Referenced by activateFor(), addPlugins(), extendClassPath(), extendJVMArgs(), getClassPath(), getDefaultLogChannel(), reset(), setClassPath(), setDefaultLogChannel(), setFilterFile(), setIdleTimeout(), setInitialJavaHeapSize(), setJavaDataModel(), setMainClass(), setMaximumJavaHeapSize(), setProfilingType(), setRemoteDebuggingEnabled(), setRemoteDebuggingPort(), setRemoteProfilingEnabled(), setTimeout(), setTraceFile(), setUseStreamPipe(), and setWaitForRemoteDebugger().
T4X::JAVASERVER::isEPipeServerHandleValid | handle | ||
Test whether the handle of an EPipe based pipe server is valid or not, i.e. whether the pipe is running or not.
true
if the handle is valid; false
otherwise References tpco_getECMDState().
Referenced by isRunning(), T4X::OBJECTS::tpexists(), and T4X::OBJECTS::tprelease().
T4X::JAVASERVER::isRunning | javaServerVar | ||
Test whether the given Java server is running or not.
javaServerVar | name of an array representing the pipe server |
true
if the server is running; false
otherwise References isEPipeServerHandleValid().
Referenced by T4X::OBJECTS::isRunning().
T4X::JAVASERVER::reset | javaServerVar | ||
Reset all values to their defaults.
javaServerVar | name of an array representing the pipe server |
References initialize().
T4X::JAVASERVER::setClassPath | javaServerVar classPathAsAList | ||
Set an alternate class path.
javaServerVar | name of an array representing the pipe server |
classPathAsAList | class path as a list of class path entries |
References initialize().
Referenced by T4X::SOA::setClassPath().
T4X::JAVASERVER::setDefaultLogChannel | javaServerVar newDefaultLogChannel | ||
Set default log channel for this pipe server.
Defaults to the session log channel.
javaServerVar | name of an array representing the pipe server |
newDefaultLogChannel | default log channel to set |
References initialize().
Referenced by T4X::MESSAGING::acknowledgeMessage(), T4X::MESSAGING::closeAll(), T4X::MESSAGING::closeConnection(), T4X::MESSAGING::receiveMessage(), and T4X::MESSAGING::startConnection().
T4X::JAVASERVER::setFilterFile | javaServerVar filterFile | ||
Specify where to configure filters to reduce the amount of traced data.
Defaults to PipeServerTraceFilter.txt
javaServerVar | name of an array representing the pipe server |
filterFile | the new path to the filter file |
References initialize().
T4X::JAVASERVER::setIdleTimeout | javaServerVar timeout | ||
Set idle timeout, the amount of idle time after which to stop the pipe server.
It is measured in seconds and defaults to 0 which means the pipe server will never be stopped.
javaServerVar | name of an array representing the pipe server |
timeout | if the pipe server is idle during this amount of time it will be stopped; 0 is the default and means it will never be stopped. |
References initialize().
Referenced by T4X::SOA::setIdleTimeout().
T4X::JAVASERVER::setInitialJavaHeapSize | javaServerVar initialJavaHeapSizeInMegaBytes | ||
Set the initial java heap size (the value set with -Xms)
javaServerVar | name of an array representing the pipe server |
initialJavaHeapSizeInMegaBytes | initial java heap size in mega bytes; if it starts with a slash the value will be a fraction of the maximum java heap size, e.g. /4 means initialJavaHeapSizeInMegaBytes = maximumJavaHeapSizeInMegaBytes / 4 |
References initialize().
Referenced by T4X::SOA::setInitialJavaHeapSize().
T4X::JAVASERVER::setJavaDataModel | javaServerVar javaDataModel | ||
Set the data model of the java virtual machine using the -d64 command line option.
This is only relevant on some Unix operating systems.
You can set this to
Anything else means to not set the -d64 or -d32 command line option.
javaServerVar | name of an array representing the pipe server |
javaDataModel | the data model for the java virtual machine |
References initialize().
Referenced by T4X::SOA::setJavaDataModel().
T4X::JAVASERVER::setMainClass | javaServerVar newMainClass | ||
Set main class implementing the PipeServer.
javaServerVar | name of an array representing the pipe server |
newMainClass | main class including java package name in dot separated notation |
References initialize().
T4X::JAVASERVER::setMaximumJavaHeapSize | javaServerVar maximumJavaHeapSizeInMegaBytes | ||
Set the maximum java heap size (the value set with -Xmx)
javaServerVar | name of an array representing the pipe server |
maximumJavaHeapSizeInMegaBytes | maximum java heap size in mega bytes; |
References initialize().
Referenced by T4X::SOA::setMaximumJavaHeapSize().
T4X::JAVASERVER::setProfilingType | javaServerVar mem_or_cpu | ||
Set whether you want to profile execution types or memory consumption.
Choose cpu
in the first and mem
in the second case.
javaServerVar | name of an array representing the pipe server |
mem_or_cpu | mem or cpu |
References initialize().
T4X::JAVASERVER::setRemoteDebuggingEnabled | javaServerVar enabledAsABoolean | ||
Set whether to prepare the pipe server for debugging or not.
Defaults to false
.
javaServerVar | name of an array representing the pipe server |
enabledAsABoolean | true if the pipe server is to be prepared for remote debugging. |
References initialize().
T4X::JAVASERVER::setRemoteDebuggingPort | javaServerVar portAsAnInteger | ||
Set port number under which the remote debugger will connect to the pipe server.
Defaults to 8000.
javaServerVar | name of an array representing the pipe server |
portAsAnInteger | the port number |
References initialize().
T4X::JAVASERVER::setRemoteProfilingEnabled | javaServerVar enabledAsABoolean | ||
Set whether to prepare the pipe server for debugging or not.
Defaults to false
.
javaServerVar | name of an array representing the pipe server |
enabledAsABoolean | true if the pipe server is to be prepared for remote debugging. |
References initialize().
T4X::JAVASERVER::setTimeout | javaServerVar timeout | ||
Set timeout, the amount of time after which to give up waiting for a result.
Defaults to 3000000. Only applicable when using the newer EPipe based pipe server.
javaServerVar | name of an array representing the pipe server |
timeout | the amount of time after which to give up waiting for a result |
References initialize().
Referenced by T4X::SOA::setTimeout().
T4X::JAVASERVER::setTraceFile | javaServerVar traceFile | ||
Specify where to store trace information.
Defaults to PipeServer.trcxml
javaServerVar | name of an array representing the pipe server |
traceFile | the new path to the trace file |
References initialize().
T4X::JAVASERVER::setUseStreamPipe | javaServerVar useStreamPipe | ||
Specify whether to use the old stream based pipe server or the newer EPipe based pipe server.
javaServerVar | name of an array representing the pipe server |
useStreamPipe | true for the old stream based pipe server; false for the newer EPipe based pipe server. |
References initialize().
T4X::JAVASERVER::setWaitForRemoteDebugger | javaServerVar waitAsABoolean | ||
Control whether or not to block the pipe server until the remote debugger connects.
Defaults to false
.
javaServerVar | name of an array representing the pipe server |
waitAsABoolean | true if the pipe server is supposed to block; false otherwise |
References initialize().
T4X::JAVASERVER::sExecute | handle command args | ||
Execute a command with the EPipeServer. Other than with eExecute the timeout is read from the handle.
handle | of the pipe server |
command | name of the command to execute |
args | variable length argument list of args to be passed to the command |
References tpco_sendECMD().
Referenced by T4X::OBJECTS::tpalet(), T4X::OBJECTS::tpdescribe(), T4X::OBJECTS::tpexists(), T4X::OBJECTS::tplet(), T4X::OBJECTS::tpletovl(), T4X::OBJECTS::tpmlet(), T4X::OBJECTS::tpmodule(), T4X::OBJECTS::tprelease(), T4X::OBJECTS::tprevertto(), T4X::OBJECTS::tpwith(), and T4X::OBJECTS::tpwithovl().
T4X::JAVASERVER::tpcontrol | javaServerVar command args | ||
Control the pipe server.
Pass in a subordinate command. The following are available:
javaServerVar | name of an array representing the pipe server |
command | subordinate command, e.g. stop (see above) |
args | args for the subordinate command, depending on the particular command |
References tpco_closeECMD().
Referenced by T4X::MESSAGING::closeAll(), T4X::MESSAGING::closeConnection(), and T4X::OBJECTS::tpcontrol().