EffectiveUserName (AgentContext - Java)

Read-only. The user name that is in effect for the current program.

For a program running on:

  • A workstation, this is the name of the current user.
  • A server, the identity of the person under whose identity the program is running.

Defined in

AgentContext

Data type

Name

Syntax

public String getEffectiveUserName()
    throws NotesException

Usage

The identity of the person under whose identity the program is running depends on whether you are running an agent, an XPage, a servlet, or a stand alone program.

For an agent, selecting 'run as web user' will make this property use the identity of the logged in web user. If 'run as web user' is not selected, this property will use the identity of the agent signer.

For everything else the identity is the identity established by the Session or automatically assigned by the environment.

This property returns the fully distinguished name.

For Java agents, this property will return the same value as the EffectiveUserName property in the Java Session class.

Example