|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
lotus.domino.NotesThread
JAddinThread
public abstract class JAddinThread
This abstract class is started as an separate thread by the JAddin. It establishes the JAddin user framework and calls the user code.
addinStart()
,
addinStop()
,
addinCommand(String)
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.lang.Thread |
---|
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler |
Field Summary |
---|
Fields inherited from class lotus.domino.NotesThread |
---|
dummyObj, isLoaded |
Fields inherited from class java.lang.Thread |
---|
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY |
Constructor Summary | |
---|---|
JAddinThread()
Dummy constructor |
Method Summary | |
---|---|
void |
addinCommand(java.lang.String pCommand)
This method is executed for every command entered at the Domino console, e.g. |
void |
addinInitialize(JAddin pMainThread,
java.lang.String pStartArguments)
This method is called by the main JAddin thread to initialize the JAddinThread |
void |
addinNextDay()
This method is called at the beginning of a new day. |
void |
addinNextHour()
This method is called at the beginning of an hour. |
abstract void |
addinStart()
This method is called by JAddinThread after all initialization work is done. |
abstract void |
addinStop()
This method is executed when the command "Quit" or "Exit" is entered or during Domino server shutdown. |
void |
addinTerminate()
Terminate the current addin. |
void |
finalize()
This method is called by the Java runtime during garbage collection to free all resources owned by this object. |
java.lang.String |
getAddinParameters()
Get the parameters passed to the addin. |
lotus.domino.Session |
getDominoSession()
Return the Domino session object. |
void |
logDebug(java.lang.String pMessage)
Write debug message to the standard output (Domino console). |
void |
logMessage(java.lang.String pMessage)
Write a log message to the Domino console. |
void |
runNotes()
This method is called from the JAddin framework. |
boolean |
sendMessage(java.lang.String pMessageFrom,
java.lang.String pMessageTo,
java.lang.String pMessageSubject,
java.lang.String pMessageBody)
Create and send a message. |
boolean |
sendMessage(java.lang.String pMessageFrom,
java.lang.String pMessageTo,
java.lang.String pMessageCC,
java.lang.String pMessageBCC,
java.lang.String pMessageSubject,
java.lang.String pMessageBody)
Create and send a message. |
void |
setAddinState(java.lang.String pMessage)
Set the addin status message text. |
void |
setDebugState(boolean pDebugState)
Set the debug state. |
void |
waitMilliSeconds(long pWaitTime)
Wait some time. |
Methods inherited from class lotus.domino.NotesThread |
---|
initThread, run, sinitThread, stermThread, termThread |
Methods inherited from class java.lang.Thread |
---|
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public JAddinThread()
Method Detail |
---|
public final void runNotes()
runNotes
in class lotus.domino.NotesThread
public final void addinInitialize(JAddin pMainThread, java.lang.String pStartArguments)
pMainThread
- JAddin threadpStartArguments
- Passed arguments or null ("Load RunJava JAddin AddinName xxxxx")public abstract void addinStart()
public abstract void addinStop()
public void addinCommand(java.lang.String pCommand)
"Tell AddinName xxxxxxxx"
.
Note: This method is called asynchronously from the JAddin framework and not from the users thread. It should return as quickly as
possible to avoid any processing delays of the Domino server message queue.
pCommand
- Command linepublic void addinNextHour()
public void addinNextDay()
public final void addinTerminate()
public final void setAddinState(java.lang.String pMessage)
"show tasks"
.
pMessage
- Status message or null to set the string to "Idle"public final void setDebugState(boolean pDebugState)
pDebugState
- Debug statepublic final java.lang.String getAddinParameters()
public final lotus.domino.Session getDominoSession()
public final void logMessage(java.lang.String pMessage)
"HelloWorld: xxxxxxxx"
pMessage
- Message to be displayedpublic final void logDebug(java.lang.String pMessage)
"RunJava JVM: AddInName(ThreadID).MethodName(LineNumber): xxxxxxxx"
.
The message is only logged if the debug flag is enabled thru setDebug(true)
or thru the Domino console
command "Tell AddinName Debug!".
pMessage
- Message to be displayedsetDebugState(boolean)
public final boolean sendMessage(java.lang.String pMessageFrom, java.lang.String pMessageTo, java.lang.String pMessageSubject, java.lang.String pMessageBody) throws java.lang.Exception
pMessageFrom
- Senders namepMessageTo
- Recipient namepMessageSubject
- Subject of messagepMessageBody
- Body of message
java.lang.Exception
public final boolean sendMessage(java.lang.String pMessageFrom, java.lang.String pMessageTo, java.lang.String pMessageCC, java.lang.String pMessageBCC, java.lang.String pMessageSubject, java.lang.String pMessageBody) throws java.lang.Exception
pMessageFrom
- Senders namepMessageTo
- Recipient namepMessageCC
- Carbon copy recipient or nullpMessageBCC
- Blind carbon copy recipient or nullpMessageSubject
- Subject of messagepMessageBody
- Body of message
java.lang.Exception
public final void waitMilliSeconds(long pWaitTime)
pWaitTime
- Wait time in milliseconds (0.00x seconds)public void finalize()
finalize
in class lotus.domino.NotesThread
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |