Package org.opends.server.core

Class AuthenticatedUsers

java.lang.Object

org.opends.server.api.plugin.DirectoryServerPlugin<PluginCfg>

org.opends.server.api.plugin.InternalDirectoryServerPlugin

org.opends.server.core.AuthenticatedUsers

public class AuthenticatedUsers
extends InternalDirectoryServerPlugin

This class provides a data structure which maps an authenticated user DN to the set of client connections authenticated as that user. Note that a single client connection may be registered with two different user DNs if the client has different authentication and authorization identities.

This class also provides a mechanism for detecting changes to authenticated user entries and notifying the corresponding client connections so that they can update their cached versions.

Constructor Summary

Constructors

Constructor	Description
AuthenticatedUsers(ServerContext serverContext)	Creates a new instance of this authenticated users object.

Method Summary

Modifier and Type	Method	Description
PluginResult.PostResponse	doPostResponse(PostResponseDeleteOperation op)	Performs any necessary processing that should be done after the Directory Server has completed all processing for a delete operation and has sent the response to the client.
PluginResult.PostResponse	doPostResponse(PostResponseModifyDNOperation op)	Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify DN operation and has sent the response to the client.
PluginResult.PostResponse	doPostResponse(PostResponseModifyOperation op)	Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify operation and has sent the response to the client.
Set<ClientConnection>	get(Dn userDN)	Retrieves the set of client connections authenticated as the specified user.
void	put(Dn userDN, ClientConnection clientConnection)	Registers the provided user DN and client connection with this object.
void	remove(Dn userDN, ClientConnection clientConnection)	Deregisters the provided user DN and client connection with this object.

Methods inherited from class org.opends.server.api.plugin.InternalDirectoryServerPlugin

initializePlugin, isConfigurationAcceptable

Methods inherited from class org.opends.server.api.plugin.DirectoryServerPlugin

doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostCommit, doPostCommit, doPostCommit, doPostCommit, doPostConnect, doPostDisconnect, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, finalizePlugin, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, processSubordinateDelete, processSubordinateModifyDN, setInvokeForInternalOperations

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedUsers

public AuthenticatedUsers(ServerContext serverContext)

Creates a new instance of this authenticated users object.

Parameters:

serverContext - the server context

Method Detail

put

public void put(Dn userDN,
                ClientConnection clientConnection)

Registers the provided user DN and client connection with this object.

Parameters:

userDN - The DN of the user associated with the provided client connection.

clientConnection - The client connection over which the user is authenticated.

remove

public void remove(Dn userDN,
                   ClientConnection clientConnection)

Deregisters the provided user DN and client connection with this object.

Parameters:

userDN - The DN of the user associated with the provided client connection.

clientConnection - The client connection over which the user is authenticated.

get

public Set<ClientConnection> get(Dn userDN)

Retrieves the set of client connections authenticated as the specified user. This method is only intended for internal testing use and should not be called for any other purpose.

Parameters:

userDN - The DN of the user for which to retrieve the corresponding set of client connections.

Returns:

The set of client connections authenticated as the specified user, or null if there are none.

doPostResponse

public PluginResult.PostResponse doPostResponse(PostResponseDeleteOperation op)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed all processing for a delete operation and has sent the response to the client.

Overrides:

doPostResponse in class DirectoryServerPlugin<PluginCfg>

Parameters:

op - The delete operation for which processing has completed and the response has been sent to the client.

Returns:

Information about the result of the plugin processing.

doPostResponse

public PluginResult.PostResponse doPostResponse(PostResponseModifyOperation op)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify operation and has sent the response to the client.

Overrides:

doPostResponse in class DirectoryServerPlugin<PluginCfg>

Parameters:

op - The modify operation for which processing has completed and the response has been sent to the client.

Returns:

Information about the result of the plugin processing.

doPostResponse

public PluginResult.PostResponse doPostResponse(PostResponseModifyDNOperation op)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify DN operation and has sent the response to the client.

Overrides:

doPostResponse in class DirectoryServerPlugin<PluginCfg>

Parameters:

op - The modifyDN operation for which processing has completed and the response has been sent to the client.

Returns:

Information about the result of the plugin processing.