com.bmc.arsys.pluginsvr.plugins
Interface AREAPluggable

All Superinterfaces:

ARPluggable

All Known Implementing Classes:

AREAPlugin

public interface AREAPluggable
extends ARPluggable

Sub interface of ARPluggable that defines External authentication based methods to be implemented for a AREA plugin.

Method Summary

boolean	areaNeedSync(ARPluginContext context) Allows the plug-in to tell the AR Server that the user information in its cache is invalid.
AREAResponse	areaVerifyLogin(ARPluginContext context, String user, String password, String networkAddress, String authString) The plug-in server issues this call when the AR Server makes a request to authenticate a user.

Methods inherited from interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

initialize, onEvent, terminate

Method Detail

areaVerifyLogin

AREAResponse areaVerifyLogin(ARPluginContext context,
                             String user,
                             String password,
                             String networkAddress,
                             String authString)
                             throws com.bmc.arsys.api.ARException

The plug-in server issues this call when the AR Server makes a request to authenticate a user.

Parameters:

context - Current context for this plugin call, like username etc.

user - The user's name

password - The user's unencrypted password

networkAddress - The IP address that the user is connecting from

authString - The user's authentication string

Returns:

a response to the authentication request and null is treated as a failed login attempt

Throws:

com.bmc.arsys.api.ARException

areaNeedSync

boolean areaNeedSync(ARPluginContext context)
                     throws com.bmc.arsys.api.ARException

Allows the plug-in to tell the AR Server that the user information in its cache is invalid. The AR Server periodically checks with the AREA plug-in to determine whether any in-memory copies of user information have expired. The plug-in server issue this call if it recieves an authentication request from the server at least 5 minutes since the last authentication request.

Parameters:

context - Current context for this plugin call, like username etc.

Returns:

a true will instruct the AR Server to expire its internally stored user information

Throws:

com.bmc.arsys.api.ARException