File Coverage

blib/lib/Net/OAI/Error.pm

Criterion	Covered	Total	%
statement	57	61	93.4
branch	27	32	84.3
condition	1	3	33.3
subroutine	11	12	91.6
pod	9	9	100.0
total	105	117	89.7

package Net::OAI::Error;

use strict;
use warnings;
use base qw( XML::SAX::Base Exporter );
our @EXPORT = (
);


=head1 NAME

Net::OAI::Error - OAI-PMH errors.

=head1 SYNOPSIS

=head1 DESCRIPTION

Note: Actually this class implements the SAX filter which processes
(and forwards) all top-level OAI-PMH elements.

Specifically the following events are not forwarded: OAI-PMH itself,
request, responseDate and error.

Thus only events for the elements corresponding to the individual
OAI-PMH verbs are forwarded.


=head1 METHODS

=head2 new()

=cut

sub new {
    my ( $class, %opts ) = @_;
    my $self = bless \%opts, ref( $class ) || $class;
    $self->{ tagStack } = [];
    $self->{ errorCode } = '' if ! exists( $self->{ errorCode } );
    $self->{ errorString }  = '' if ! exists( $self->{ errorString } );
# do not initialize $self->{ HTTPError } and $self->{ HTTPRetryAfter }
    return( $self );
}

=head2 errorCode()

Returns an OAI error if one was encountered, or the empty string if no errors
were associated with the OAI request.

=over 4

=item

badArgument

=item

badResumptionToken

=item

badVerb

=item

cannotDisseminateFormat

=item

idDoesNotExist

=item

noRecordsMatch

=item

noMetadataFormats

=item

noSetHierarchy

=item

xmlParseError

=item

xmlContentError

=item

numerical HTTP status code

=back

For more information about these error codes see:
L.

=cut

sub errorCode {
    my ( $self, $code ) = @_;
    if ( $code ) { $self->{ errorCode } = $code; }
    return( $self->{ errorCode } );
}

=head2 errorString()

Returns a textual description of the error that was encountered, or an empty
string if there was no error associated with the OAI request.

=cut

sub errorString {
    my ( $self, $str ) = @_;
    if ( $str ) { $self->{ errorString } = $str; }
    return( $self->{ errorString } );
}

=head2 HTTPError()

In case of HTTP level errors, returns the associated HTTP::Response object.
Otherwise C.


=cut

sub HTTPError {
    my ( $self ) = @_;
    return exists $self->{ HTTPError } ? $self->{ HTTPError } : undef;
}


=head2 HTTPRetryAfter()

In case of HTTP level errors, returns the Retry-After header of the HTTP Response object,
or the empty string if no such header is persent. Otherwise C.


=cut

sub HTTPRetryAfter {
    my ( $self ) = @_;
    return exists $self->{ HTTPRetryAfter } ? $self->{ HTTPRetryAfter } : undef;
}


=head1 TODO

=head1 SEE ALSO

=over 4

=back

=head1 AUTHORS

Ed Summers

=cut

## internal stuff

## all children of Net::OAI::Base should call this to make sure
## certain object properties are set

sub start_prefix_mapping {
  my ($self, $mapping) = @_;
  return $self->SUPER::start_prefix_mapping( $mapping );
}

sub start_element {
    my ( $self, $element ) = @_;
    return $self->SUPER::start_element($element) unless $element->{NamespaceURI} eq Net::OAI::Harvester::XMLNS_OAI;  # should be error?

    my $tagName = $element->{ LocalName };
    if ( $tagName eq 'request' ) {
        Net::OAI::Harvester::debug( "caught request" );
	$self->{ _requestAttrs } = {};
        foreach ( values %{$element->{ Attributes }} ) {
            next if $_->{ Prefix };
            $self->{ _requestAttrs }->{ $_->{ Name } } = $_->{ Value };
          }
	$self->{ _insideSelf } = "";
      }
    elsif ( $tagName eq 'responseDate' ) {
        Net::OAI::Harvester::debug( "caught responseDate" );
	$self->{ _insideSelf } = "";
      }
    elsif ( $tagName eq 'error' ) {
        Net::OAI::Harvester::debug( "caught error" );
	$self->{ errorCode } = $element->{ Attributes }{ '{}code' }{ Value };
	$self->{ _insideSelf } = "";
    }
    else {
	$self->SUPER::start_element( $element );
    }
}

sub end_element {
    my ( $self, $element ) = @_;
    return $self->SUPER::end_element($element) unless $element->{NamespaceURI} eq Net::OAI::Harvester::XMLNS_OAI;  # should be error?

    my $tagName = $element->{ LocalName };
    if ( $tagName eq 'request' ) {
	$self->{ _requestContent } = $self->{ _insideSelf };
	delete $self->{ _insideSelf };
      }
    elsif ( $tagName eq 'responseDate' ) {
	$self->{ _responseDate } = $self->{ _insideSelf };
	delete $self->{ _insideSelf };
      }
    elsif ( $tagName eq 'error' ) {
	$self->{ errorString } = $self->{ _insideSelf };
	delete $self->{ _insideSelf };
    }
    else {
	$self->SUPER::end_element( $element );
    }
}

sub characters {
    my ( $self, $characters ) = @_;
    if ( exists $self->{ _insideSelf } ) {
	$self->{ _insideSelf } .= $characters->{ Data };
    } else {
	$self->SUPER::characters( $characters );
    }
}

1;