com.cenqua.shaj
Class Authenticator

java.lang.Object
  com.cenqua.shaj.Authenticator

Direct Known Subclasses:

PAMAuthenticator, Win32Authenticator

public abstract class Authenticator

extends java.lang.Object

Base-class for platform-specific authentication.

This class is multi-thread safe.

Constructor Summary

Authenticator()

Method Summary

abstract boolean	checkGroupMembership(java.lang.String domain, java.lang.String username, java.lang.String group, Log log) Tests if a user is a member of a specific group.
abstract boolean	checkPassword(java.lang.String domain, java.lang.String username, java.lang.String password, Log log) Checks a user's password.
static Authenticator	getDefault() A singleton Authenticator for the underlying operating system.

Methods inherited from class java.lang.Object

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

Constructor Detail

Authenticator

public Authenticator()

Method Detail

getDefault

public static Authenticator getDefault()

A singleton Authenticator for the underlying operating system.

Returns:

a singleton instance

Throws:

java.lang.IllegalStateException - if Shaj did not load correctly (if Shaj.init() returns false).

checkPassword

public abstract boolean checkPassword(java.lang.String domain,
                                      java.lang.String username,
                                      java.lang.String password,
                                      Log log)

Checks a user's password.

Parameters:

domain - the (platform-specific) domain/service to used to perform the check. May be null (which has a platform-specific meaning).

username - the username

password - the password to verify

log - where to log errors/debugging

Returns:

true if the password matches the username

Throws:

java.lang.IllegalArgumentException - if username or password are null.

java.lang.IllegalStateException - if Shaj did not load correctly (if Shaj.init() returns false).

checkGroupMembership

public abstract boolean checkGroupMembership(java.lang.String domain,
                                             java.lang.String username,
                                             java.lang.String group,
                                             Log log)

Tests if a user is a member of a specific group.

Parameters:

domain - the (platform-specific) domain/service to used to perform the check. May be null (which has a platform-specific meaning).

username - the username to test for membership

group - the group to look in

log - where to log errors/debugging

Returns:

true if the user is a member of the group

Throws:

java.lang.IllegalArgumentException - if username or group are null.

java.lang.IllegalStateException - if Shaj did not load correctly (if Shaj.init() returns false).