Uses of Interface
org.jsecurity.realm.Realm

Packages that use Realm

org.jsecurity.authc.pam	Support for PAM, or Pluggable Authentication Modules, which is the capability to authenticate a user against multiple configurable (pluggable) modules (JSecurity calls these Realms).
org.jsecurity.authz	Core interfaces and exceptions supporting Authorization (access control).
org.jsecurity.mgt	Provides the master SecurityManager interface and a default implementation hierarchy for managing all aspects of JSecurity's functionality in an application.
org.jsecurity.realm	Components and sub-packages used in supporting the core Realm interface.
org.jsecurity.realm.activedirectory	Realms that acquire security data from a Microsoft Active Directory.
org.jsecurity.realm.jdbc	Realms that acquire security data from an RDBMS (Relational Database Management System) using the JDBC API.
org.jsecurity.realm.jndi	Support for acquiring Realms from JNDI, particularly useful for configuring JSecurity in JEE or EJB environments.
org.jsecurity.realm.ldap	Realms that acquire security data from an LDAP (Lightweight Directory Access Protocol) server utilizing LDAP/Naming APIs.
org.jsecurity.realm.text	Realms that acquire security data from text-based data sources such as Files or text streams.
org.jsecurity.web	Framework support for any web-enabled application.

Uses of Realm in org.jsecurity.authc.pam

Methods in org.jsecurity.authc.pam that return types with arguments of type Realm

protected Collection<Realm>

ModularRealmAuthenticator.getRealms() Returns the realm(s) used by this Authenticator during an authentication attempt.

Methods in org.jsecurity.authc.pam with parameters of type Realm

AuthenticationInfo	ModularAuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t) Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication, allowing post-authentication-attempt logic for that realm only.
AuthenticationInfo	AllSuccessfulModularAuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info, AuthenticationInfo aggregate, Throwable t) Merges the specified info into the aggregate argument and returns it (just as the parent implementation does), but additionally ensures the following: if the Throwable argument is not null, re-throws it to immediately cancel the authentication process, since this strategy requires all realms to authenticate successfully.
AuthenticationInfo	AbstractAuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t) Base implementation that will aggregate the specified singleRealmInfo into the aggregateInfo and then returns the aggregate.
AuthenticationInfo	ModularAuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data, allowing pre-authentication-attempt logic for that realm only.
AuthenticationInfo	AllSuccessfulModularAuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info) Because all realms in this strategy must complete successfully, this implementation ensures that the given Realm supports the given token argument.
AuthenticationInfo	AbstractAuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) Simply returns the aggregate method argument, without modification.
protected AuthenticationInfo	ModularRealmAuthenticator.doSingleRealmAuthentication(Realm realm, AuthenticationToken token) Performs the authentication attempt by interacting with the single configured realm, which is significantly simpler than performing multi-realm logic.
void	ModularRealmAuthenticator.setRealm(Realm realm) Convenience setter for single-realm environments (fairly common).

Method parameters in org.jsecurity.authc.pam with type arguments of type Realm

AuthenticationInfo	ModularAuthenticationStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token) Method invoked by the ModularAuthenticator signifying that the authentication process is about to begin for the specified token - called before any Realm is actually invoked.
AuthenticationInfo	FirstSuccessfulAuthenticationStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token) Returns null immediately, relying on this class's merge implementation to return only the first info object it encounters, ignoring all subsequent ones.
AuthenticationInfo	AbstractAuthenticationStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token) Simply returns new SimpleAuthenticationInfo();, which supports aggregating account data across realms.
protected AuthenticationInfo	ModularRealmAuthenticator.doMultiRealmAuthentication(Collection<Realm> realms, AuthenticationToken token) Performs the multi-realm authentication attempt by calling back to a ModularAuthenticationStrategy object as each realm is consulted for AuthenticationInfo for the specified token.
void	ModularRealmAuthenticator.setRealms(Collection<Realm> realms) Sets all realms used by this Authenticator, providing PAM (Pluggable Authentication Module) configuration.

Constructors in org.jsecurity.authc.pam with parameters of type Realm

ModularRealmAuthenticator(Realm realm)
Constructor which initializes this Authenticator with a single realm to use during an authentiation attempt.

Constructor parameters in org.jsecurity.authc.pam with type arguments of type Realm

ModularRealmAuthenticator(List<Realm> realms)
Constructor which initializes this Authenticator with multiple realms that will be consulted during an authentication attempt, effectively enabling PAM (Pluggable Authentication Module) behavior according to the configured ModularAuthenticationStrategy.

Uses of Realm in org.jsecurity.authz

Fields in org.jsecurity.authz with type parameters of type Realm

protected Collection<Realm>

ModularRealmAuthorizer.realms The realms to consult during any authorization check.

Methods in org.jsecurity.authz that return types with arguments of type Realm

Collection<Realm>

ModularRealmAuthorizer.getRealms() Returns the realms wrapped by this Authorizer which are consulted during an authorization check.

Method parameters in org.jsecurity.authz with type arguments of type Realm

void	ModularRealmAuthorizer.setRealms(Collection<Realm> realms) Sets the realms wrapped by this Authorizer which are consulted during an authorization check.

Constructor parameters in org.jsecurity.authz with type arguments of type Realm

ModularRealmAuthorizer(Collection<Realm> realms)
Constructor that accepts the Realms to consult during an authorization check.

Uses of Realm in org.jsecurity.mgt

Fields in org.jsecurity.mgt with type parameters of type Realm

protected Collection<Realm>

RealmSecurityManager.realms Internal collection of Realms used for all authentication and authorization operations.

Methods in org.jsecurity.mgt that return Realm

protected Realm

RealmSecurityManager.createDefaultRealm() Creates a default Realm implementation to use in lazy-initialization use cases.

Methods in org.jsecurity.mgt that return types with arguments of type Realm

Collection<Realm>

RealmSecurityManager.getRealms() Returns the Realms managed by this SecurityManager instance.

Methods in org.jsecurity.mgt with parameters of type Realm

void	RealmSecurityManager.setRealm(Realm realm) Convenience method for applications using a single realm that merely wraps the realm in a list and then invokes the RealmSecurityManager.setRealms(java.util.Collection) method.

Method parameters in org.jsecurity.mgt with type arguments of type Realm

void	RealmSecurityManager.setRealms(Collection<Realm> realms) Sets the realms managed by this SecurityManager instance.
void	AuthorizingSecurityManager.setRealms(Collection<Realm> realms) First calls super.realms and then sets these same Realm objects on this instance's Authorizer.
void	AuthenticatingSecurityManager.setRealms(Collection<Realm> realms) Immediately calls super.setRealms and then additionally passes on those realms to the internal delegate Authenticator instance so that it may use them during authentication attempts.

Constructors in org.jsecurity.mgt with parameters of type Realm

DefaultSecurityManager(Realm singleRealm)
Supporting constructor for a single-realm application.

Constructor parameters in org.jsecurity.mgt with type arguments of type Realm

DefaultSecurityManager(Collection<Realm> realms)
Supporting constructor for multiple realms.

Uses of Realm in org.jsecurity.realm

Classes in org.jsecurity.realm that implement Realm

class	AuthenticatingRealm A top-level abstract implementation of the Realm interface that only implements authentication support (log-in) operations and leaves authorization (access control) behavior to subclasses.
class	AuthorizingRealm An AuthorizingRealm extends the AuthenticatingRealm's capabilities by adding Authorization (access control) support.
class	CachingRealm A very basic abstract extension point for the Realm interface that provides logging and caching support.
class	SimpleAccountRealm A simple implementation of the Realm interface that uses a set of configured user accounts and roles to support authentication and authorization.

Methods in org.jsecurity.realm that return types with arguments of type Realm

Collection<Realm>

RealmFactory.getRealms() Returns a collection of Realm instances that will be used to construct the application's SecurityManager instance.

Uses of Realm in org.jsecurity.realm.activedirectory

Classes in org.jsecurity.realm.activedirectory that implement Realm

class

ActiveDirectoryRealm An Realm that authenticates with an active directory LDAP server to determine the roles for a particular user.

Uses of Realm in org.jsecurity.realm.jdbc

Classes in org.jsecurity.realm.jdbc that implement Realm

class

JdbcRealm Realm that allows authentication and authorization via JDBC calls.

Uses of Realm in org.jsecurity.realm.jndi

Methods in org.jsecurity.realm.jndi that return types with arguments of type Realm

Collection<Realm>

JndiRealmFactory.getRealms() Performs the JNDI lookups for each specified JNDI name and returns all discovered Realms in an ordered collection.

Uses of Realm in org.jsecurity.realm.ldap

Classes in org.jsecurity.realm.ldap that implement Realm

class

AbstractLdapRealm A Realm that authenticates with an LDAP server to build the Subject for a user.

Uses of Realm in org.jsecurity.realm.text

Classes in org.jsecurity.realm.text that implement Realm

class	PropertiesRealm A subclass of SimpleAccountRealm that defers all logic to the parent class, but just enables Properties based configuration in addition to the parent class's String configuration.
class	TextConfigurationRealm a SimpleAccountRealm that enables text-based configuration of the initial User, Role, and Permission objects created at startup.

Uses of Realm in org.jsecurity.web

Constructors in org.jsecurity.web with parameters of type Realm

DefaultWebSecurityManager(Realm singleRealm)

Constructor parameters in org.jsecurity.web with type arguments of type Realm

DefaultWebSecurityManager(Collection<Realm> realms)