Wombat::Realm - internal realm interface

- NAME
- SYNOPSIS
- DESCRIPTION
- ACCESSOR METHODS
- PUBLIC METHODS
- SEE ALSO
- AUTHOR

# NAME

Wombat::Realm - internal realm interface

# SYNOPSIS

# DESCRIPTION

This is a read-only interface for an underlying security realm used to authenticate individual users and to identify the security roles associated with those users. Realms can be attached at any Container level but will typically only be attached to an Application or higher level Container.

# ACCESSOR METHODS

`getContainer()`
  Return the Container associated with this Realm.

`setContainer($container)`
  Set the Container associated with this Realm.

  Parameters:

  $container
    the Wombat::Container associated with this Realm

# PUBLIC METHODS

authenticate ($username, $credentials)
  Return the Principal associated with the specified username and credentials, if there is one, or `undef` otherwise.

  Parameters

  $username
    username of the principal to be looked up

  $credentials
    password or other credentials to use in authenticating this username

hasRole($principal, $role)
  Return true if the specified Principal has the specified security role within the context of this Realm, or false otherwise.

  Parameters:

  $principal
    the Servlet::Util::Principal for whom the role is to be checked

  $role
    the name of the security role to be checked

# SEE ALSO

the Servlet::Util::Principal manpage, the Wombat::Container manpage

# AUTHOR

Brian Moseley, bcm@maz.org