com.hcl.domino.data

Interface Agent.AgentRunContext

Enclosing interface:

Agent

public static interface Agent.AgentRunContext

Method Summary

Modifier and Type	Method and Description
Optional<Document>	getDocumentContext() Returns the Document for Session.DocumentContext as a Document
Optional<Writer>	getOutputWriter() Returns the output writer used for Print statements during agent execution
int	getParamDocId() Returns the note id for Session.ParameterDocId
int	getTimeoutSeconds() Returns the agent timeout
String	getUsername() Returns the Notes username e.g.
boolean	isCheckSecurity() Returns whether security should be checked
boolean	isReopenDbAsSigner() Returns whether the DB should be reopened as agent signer
Agent.AgentRunContext	setCheckSecurity(boolean checkSecurity) Use this method to set the AGENT_SECURITY_ON flag: AGENT_SECURITY_ON: Use this flag to tell the run context that when it runs an agent, you want it to check the privileges of the signer of that agent and apply them.
Agent.AgentRunContext	setDocumentContext(Document doc) Sets the Document for Session.DocumentContext as a Document.
Agent.AgentRunContext	setOutputWriter(Writer writer) If this method is used to set an output writer, we will collect the agent output produced during execution (e.g.
Agent.AgentRunContext	setParamDocId(int paramDocId) Sets the note id for Session.ParameterDocId
Agent.AgentRunContext	setReopenDbAsSigner(boolean reopenAsSigner) Use this method to set the AGENT_REOPEN_DB flag: AGENT_REOPEN_DB: If AGENT_REOPEN_DB is set, the AgentRun call will reopen the agent's database with the privileges of the signer of the agent.
Agent.AgentRunContext	setTimeoutSeconds(int timeoutSeconds) Sets an execution timeout in seconds
Agent.AgentRunContext	setUsername(String sessionEffectiveName) Sets the Notes username e.g.

Method Detail

isCheckSecurity

boolean isCheckSecurity()

Returns whether security should be checked

Returns:

true to check

setCheckSecurity

Agent.AgentRunContext setCheckSecurity(boolean checkSecurity)

Use this method to set the AGENT_SECURITY_ON flag:

AGENT_SECURITY_ON:
Use this flag to tell the run context that when it runs an agent, you want it to check the privileges of the signer of that agent and apply them. For example, if the signer of the agent has "restricted" agent privileges, then the agent will be restricted. If you don't set this flag, all agents run as unrestricted.

• List of security checks enabled by this flag:
• Restricted/unrestricted agent
• Can create databases
• Is agent targeted to this machine
• Is user allowed to access this machine
• Can user run personal agents

Parameters:

checkSecurity - true to check security, true by default

Returns:

this context object (for chained calls)

isReopenDbAsSigner

boolean isReopenDbAsSigner()

Returns whether the DB should be reopened as agent signer

Returns:

true to reopen

setReopenDbAsSigner

Agent.AgentRunContext setReopenDbAsSigner(boolean reopenAsSigner)

Use this method to set the AGENT_REOPEN_DB flag:

AGENT_REOPEN_DB:
If AGENT_REOPEN_DB is set, the AgentRun call will reopen the agent's database with the privileges of the signer of the agent. If the flag is not set, the agent's "context" database will be open with the privileges of the current user (the current Notes id or the current Domino web user).

Parameters:

reopenAsSigner - true to reopen database, false by default

Returns:

this context object (for chained calls)

getOutputWriter

Optional<Writer> getOutputWriter()

Returns the output writer used for Print statements during agent execution

Returns:

an Optional describing the target Writer, or an empty one if no writer has been set

setOutputWriter

Agent.AgentRunContext setOutputWriter(Writer writer)

If this method is used to set an output writer, we will collect the agent output produced during execution (e.g. via Print statements in LotusScript) and write it to the specified writer when the agent execution is done.

Parameters:

writer - output writer, null by default

Returns:

this context object (for chained calls)

getTimeoutSeconds

int getTimeoutSeconds()

Returns the agent timeout

Returns:

timeout

setTimeoutSeconds

Agent.AgentRunContext setTimeoutSeconds(int timeoutSeconds)

Sets an execution timeout in seconds

Parameters:

timeoutSeconds - timeout in seconds, 0 by default

Returns:

this context object (for chained calls)

getDocumentContext

Optional<Document> getDocumentContext()

Returns the Document for Session.DocumentContext as a Document

Returns:

document context

setDocumentContext

Agent.AgentRunContext setDocumentContext(Document doc)

Sets the Document for Session.DocumentContext as a Document.

Parameters:

doc - document context, can be in-memory only (not saved yet)

Returns:

this context object (for chained calls)

getParamDocId

int getParamDocId()

Returns the note id for Session.ParameterDocId

Returns:

note id

setParamDocId

Agent.AgentRunContext setParamDocId(int paramDocId)

Sets the note id for Session.ParameterDocId

Parameters:

paramDocId - note id, 0 by default

Returns:

this context object (for chained calls)

getUsername

String getUsername()

Returns the Notes username e.g. to be used for evaluating @UserNamesList

Returns:

username

setUsername

Agent.AgentRunContext setUsername(String sessionEffectiveName)

Sets the Notes username e.g. to be used for evaluating @UserNamesList. Unfortunately, this does not cover Session.EffectiveUserName. We still need to find a way to change this (when calling WebQueryOpen/Save agents manually), if there is any.

Parameters:

sessionEffectiveName - either in canonical or abbreviated format, null by default, which means Session.EffectiveUserName will be the agent signer

Returns:

this context object (for chained calls)