com.oracle.tuxedo.tjatmi
Class TuxedoJavaServer
java.lang.Object
com.oracle.tuxedo.tjatmi.TuxedoJavaServer
- All Implemented Interfaces:
- TuxATMIConstants
public abstract class TuxedoJavaServer
- extends java.lang.Object
- implements TuxATMIConstants
TuxedoJavaServer
is the base class for all
customer Tuxedo Java server class implementations.
- Author:
- Oracle, Inc.
Fields inherited from interface com.oracle.tuxedo.tjatmi.TuxATMIConstants |
TPABSOLUTE, TPEXIT, TPFAIL, TPGETANY, TPMULTICONTEXTS, TPNOBLOCK, TPNOCHANGE, TPNOREPLY, TPNOTIME, TPNOTRAN, TPSA_FASTPATH, TPSA_PROTECTED, TPSIGRSTRT, TPSUCCESS, TPTRAN, TPU_DIP, TPU_IGN, TPU_MASK, TPU_SIG, TPU_THREAD |
Method Summary |
TuxAppContext |
getTuxAppContext()
getTuxAppContext() is called by Java service routine to retrieve
the current attached Tuxedo application Java context. |
abstract void |
tpsvrdone()
abstract method tpsvrdone() needs to be implemented
by every user defined Java server class. |
abstract int |
tpsvrinit()
abstract method tpsvrinit() needs to be implemented
by every user defined Java server class. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TuxedoJavaServer
public TuxedoJavaServer()
getTuxAppContext
public final TuxAppContext getTuxAppContext()
throws TuxException
getTuxAppContext()
is called by Java service routine to retrieve
the current attached Tuxedo application Java context.
Java servcice routine needs this Java context to do all the related ATMI calls.
- Returns:
- Upon successful completion,
getTuxAppContext()
returns TuxAppContext.
- Throws:
TuxException
- Upon failure getTuxAppContext
throws TuxException
tpsvrinit
public abstract int tpsvrinit()
throws TuxException
- abstract method
tpsvrinit()
needs to be implemented
by every user defined Java server class. And this method in the user defined Java server class
will be invoked one time by Tuxedo Java server when Tuxedo Java server starts.
User can do initialization work in this function.
- Returns:
- If tpsvrinit() of user defined Java server class returns 0, it means the initialization of
user defined Java server class has succeeded. If tpsvrinit() of user defined Java server class does
not return 0, it means the initialization of user defined Java server class has failed.
Tuxedo Java server will write a warning message to indicate the failure of tpsvrinit() in the userlog.
- Throws:
TuxException
- Upon failure getTuxAppContext
could also throw TuxException
tpsvrdone
public abstract void tpsvrdone()
- abstract method
tpsvrdone()
needs to be implemented
by every user defined Java server class. And this method in the user defined Java server class
will be invoked once by Tuxedo Java server when Tuxedo Java server is shut down.
User can do cleanup work in this function.