Tomcat 10.1.19 · org.apache.catalina.realm · APIdia, the JavaDoc alternative

Modifier and Type	Interface and Description
public interface	X509UsernameRetriever Provides an interface for retrieving a user name from an X509Certificate.

Class Summary

Modifier and Type	Class and Description
public class	AuthenticatedUserRealm This Realm is intended for use with Authenticator implementations (`org.apache.catalina.authenticator.SSLAuthenticator`, `org.apache.catalina.authenticator.SpnegoAuthenticator`) that authenticate the user as well as obtain the user credentials.
public class	CombinedRealm Realm implementation that contains one or more realms.
public class	DataSourceRealm Implementation of Realm that works with any JDBC JNDI DataSource.
public abstract class	DigestCredentialHandlerBase Base implementation for the Tomcat provided `CredentialHandler`s.
public class	GenericPrincipal Generic implementation of java.security.Principal that is available for use by `Realm` implementations.
public class	JAASCallbackHandler Implementation of the JAAS `CallbackHandler` interface, used to negotiate delivery of the username and credentials that were specified to our constructor.
public class	JAASMemoryLoginModule Implementation of the JAAS LoginModule interface, primarily for use in testing `JAASRealm`.
public class	JAASRealm Implementation of Realm that authenticates users via the Java Authentication and Authorization Service (JAAS).
public class	JNDIRealm Implementation of Realm that works with a directory server accessed via the Java Naming and Directory Interface (JNDI) APIs.
public class	LockOutRealm This class extends the CombinedRealm (hence it can wrap other Realms) to provide a user lock out mechanism if there are too many failed authentication attempts in a given period of time.
public class	MemoryRealm Simple implementation of Realm that reads an XML file to configure the valid users, passwords, and roles.
public class	MemoryRuleSet RuleSet for recognizing the users defined in the XML file processed by `MemoryRealm`.
pack-priv class	MemoryUserRule Private class used when parsing the XML database file.
public class	MessageDigestCredentialHandler This credential handler supports the following forms of stored passwords: encodedCredential - a hex encoded digest of the password digested using the configured digest {MD5}encodedCredential - a Base64 encoded MD5 digest of the password {SHA}encodedCredential - a Base64 encoded SHA1 digest of the password {SSHA}encodedCredential - 20 byte Base64 encoded SHA1 digest followed by variable length salt. {SSHA}<sha-1 digest:20><salt:n>
public class	NestedCredentialHandler
public class	NullRealm Minimal Realm implementation that always returns null when an attempt is made to validate a user name and password.
public abstract class	RealmBase Simple implementation of Realm that reads an XML file to configure the valid users, passwords, and roles.
public class	SecretKeyCredentialHandler
public class	UserDatabaseRealm Implementation of `org.apache.catalina.Realm` that is based on an implementation of `UserDatabase` made available through the JNDI resources configured for this instance of Catalina.
public class	X509SubjectDnRetriever An X509UsernameRetriever that returns a certificate's entire SubjectDN as the username.

Package org.apache.catalina.realm

Interface Summary

Class Summary