=head1 NAME

Apache::Access - A Perl API for Apache request object




=head1 Synopsis

META: needs to be completed

  use Apache::Access ();



=head1 Description

C<Apache::Access> provides the Perl API for Apache request object.




=head1 API

C<Apache::Access> provides the following functions and/or methods:




=head2 C<allow_options>

META: Autogenerated - needs to be reviewed/completed

Retrieve the value of Options for this request

  $ret = $r->allow_options();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: C<$ret> (integer)

the Options bitmask

=back





=head2 C<allow_overrides>

META: Autogenerated - needs to be reviewed/completed

Retrieve the value of the AllowOverride for this request

  $ret = $r->allow_overrides();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: C<$ret> (integer)

the overrides bitmask

=back





=head2 C<get_remote_logname>

META: Autogenerated - needs to be reviewed/completed

Retrieve the login name of the remote user.  Undef if it could not be
determined

  $ret = $r->get_remote_logname();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: C<$ret> (string)

The user logged in to the client machine

=back





=head2 C<note_auth_failure>

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate
itself the next time, if an authentication request failed.  This function
works for both basic and digest authentication

  $r->note_auth_failure();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: no return value

=back





=head2 C<note_basic_auth_failure>

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate
itself the next time, if an authentication request failed.  This function
works only for basic authentication

  $r->note_basic_auth_failure();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: no return value

=back





=head2 C<note_digest_auth_failure>

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate
itself the next time, if an authentication request failed.  This function
works only for digest authentication

  $r->note_digest_auth_failure();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: no return value

=back





=head2 C<satisfies>

META: Autogenerated - needs to be reviewed/completed

How the requires lines must be met.

  $ret = $r->satisfies();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: C<$ret> (integer)

How the requirements must be met.  One of:

  Apache::SATISFY_ANY    -- any of the requirements must be met.
  Apache::SATISFY_ALL    -- all of the requirements must be met.
  Apache::SATISFY_NOSPEC -- There are no applicable satisfy lines

=back





=head2 C<some_auth_required>

META: Autogenerated - needs to be reviewed/completed

Can be used within any handler to determine if any authentication
is required for the current request

  $ret = $r->some_auth_required();

=over 4

=item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)

The current request

=item ret: C<$ret> (integer)

1 if authentication is required, 0 otherwise

=back




=head1 See Also

L<mod_perl 2.0 documentation|docs::2.0::index>.




=head1 Copyright

mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 1.1.




=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut

