de.bea.domingo.notes
Class DAgentBase

java.lang.Object
  java.lang.Thread
      lotus.domino.NotesThread
          lotus.domino.AgentBase
              de.bea.domingo.notes.DAgentBase

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

DomingoServerAgent

public abstract class DAgentBase
extends lotus.domino.AgentBase

Domingo agents must extend DAgentBase and use run() as the entry point for their functional code. Use {link #getDSession() getDSession()} to get a DSession object. For output to browsers as well as Notes clients (the Java debug console), create a PrintWriter object with getAgentOutput().

Author:

Kurt Riede

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

DAgentBase()
Constructor.

Method Summary

void	dbgMsg(java.lang.String message) If debugging is enabled, send a debug message to System.out.
void	dbgMsg(java.lang.String message, java.io.PrintStream out) If debugging is enabled, send a debug message to the specified stream.
void	dbgMsg(java.lang.String message, java.io.PrintWriter out) If debugging is enabled, send a debug message to the specified writer.
java.io.PrintWriter	getAgentOutput() Returns the output writer of the current agent.
protected DSession	getDSession() Returns the Domingo session of the agent.
DNotesMonitor	getMonitor() Returns the monitor of the current Domingo agent.
lotus.domino.Session	getSession() Deprecated. use method getDSession()
boolean	isRestricted() Checks if the current agent is a restricted agent or not.
abstract void	main() main method to be implemented by concrete agents.
void	NotesMain()
void	setDebug(boolean b) Sets whether debugging is enabled or not for the current agent.
void	setTrace(boolean b) Activates or deactivates tracing method calls of the JVM.

Methods inherited from class lotus.domino.AgentBase

getAgentOutputStream, getAgentSession, runNotes, startup

Methods inherited from class lotus.domino.NotesThread

finalize, getNativeThreadID, 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

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

Constructor Detail

DAgentBase

public DAgentBase()

Constructor.

Method Detail

main

public abstract void main()

main method to be implemented by concrete agents.

NotesMain

public final void NotesMain()

Overrides:

NotesMain in class lotus.domino.AgentBase

See Also:

AgentBase.NotesMain()

getDSession

protected final DSession getDSession()

Returns the Domingo session of the agent.

Returns:

Domingo session

getSession

public final lotus.domino.Session getSession()

Deprecated. use method getDSession()

This method should not be called in Domingo agents. and always returns a runtime exception if a Domingo agent tries to get the internal Notes session.

Overrides:

getSession in class lotus.domino.AgentBase

Returns:

the underlying Notes session.

getMonitor

public final DNotesMonitor getMonitor()

Returns the monitor of the current Domingo agent.

Returns:

monitor of current Domingo agent

dbgMsg

public final void dbgMsg(java.lang.String message,
                         java.io.PrintStream out)

If debugging is enabled, send a debug message to the specified stream.

Overrides:

dbgMsg in class lotus.domino.AgentBase

Parameters:

message - the message

out - the output stream

See Also:

setDebug(boolean)

dbgMsg

public final void dbgMsg(java.lang.String message,
                         java.io.PrintWriter out)

If debugging is enabled, send a debug message to the specified writer.

Overrides:

dbgMsg in class lotus.domino.AgentBase

Parameters:

message - the message

out - the output writer

See Also:

setDebug(boolean)

dbgMsg

public final void dbgMsg(java.lang.String message)

If debugging is enabled, send a debug message to System.out.

Overrides:

dbgMsg in class lotus.domino.AgentBase

Parameters:

message - the message

See Also:

setDebug(boolean)

getAgentOutput

public final java.io.PrintWriter getAgentOutput()

Returns the output writer of the current agent.

Overrides:

getAgentOutput in class lotus.domino.AgentBase

Returns:

output writer of the current agent

isRestricted

public final boolean isRestricted()

Checks if the current agent is a restricted agent or not.

Overrides:

isRestricted in class lotus.domino.AgentBase

Returns:

true if the current agent is restricted, else false

setDebug

public final void setDebug(boolean b)

Sets whether debugging is enabled or not for the current agent.

Overrides:

setDebug in class lotus.domino.AgentBase

Parameters:

b - true if debugging should be enabled, else false

setTrace

public final void setTrace(boolean b)

Activates or deactivates tracing method calls of the JVM.

Overrides:

setTrace in class lotus.domino.AgentBase

Parameters:

b - true to enable instruction tracing; false to disable this feature.

See Also:

Runtime.traceMethodCalls(boolean)