com.bmc.arsys.pluginsvr.plugins
Class AREAPlugin

java.lang.Object
  com.bmc.arsys.pluginsvr.plugins.ARPlugin
      com.bmc.arsys.pluginsvr.plugins.AREAPlugin

All Implemented Interfaces:

AREAPluggable, ARPluggable

public abstract class AREAPlugin
extends ARPlugin
implements AREAPluggable

Default implementation of the AREAPluggable interface

Constructor Summary

AREAPlugin()

Method Summary

abstract boolean	areaNeedSync(ARPluginContext context) Allows the plug-in to tell the AR Server that the user information in its cache is invalid.
abstract 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 class com.bmc.arsys.pluginsvr.plugins.ARPlugin

initialize, onEvent, terminate

Methods inherited from class java.lang.Object

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

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

initialize, onEvent, terminate

Constructor Detail

AREAPlugin

public AREAPlugin()

Method Detail

areaVerifyLogin

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

Description copied from interface: AREAPluggable

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

Specified by:

areaVerifyLogin in interface AREAPluggable

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

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

Description copied from interface: AREAPluggable

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.

Specified by:

areaNeedSync in interface AREAPluggable

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