atg.security

Interface UserAuthenticator

public interface UserAuthenticator

UserAuthenticator.java

This is an interface for objects classes that implement servlet security features.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION CVS class version string

Method Summary

Methods

Modifier and Type	Method and Description
java.security.Principal	getUserPrincipal(DynamoHttpServletRequest pRequest) Returns a java.security.Principal object containing the name of the current authenticated user.
boolean	isUserInRole(java.lang.String pRole, DynamoHttpServletRequest pRequest) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

CVS class version string

See Also:

Constant Field Values

Method Detail

getUserPrincipal

java.security.Principal getUserPrincipal(DynamoHttpServletRequest pRequest)

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

isUserInRole

boolean isUserInRole(java.lang.String pRole,
                   DynamoHttpServletRequest pRequest)

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.