---
name: "HTTP::OAI::Identify"
section: "3pm"
platform: "linux"
package: "libhttp-oai-perl"
version: "4.13-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTTP::OAI::Identify"
---

# HTTP::OAI::Identify(3pm)

Provide access to an OAI Identify response

## NAME

HTTP::OAI::Identify - Provide access to an OAI Identify response

## SYNOPSIS

```
        use HTTP::OAI::Identify;
        my $i = new HTTP::OAI::Identify(
                adminEmail=>'billg@microsoft.com',
                baseURL=>'http://www.myarchives.org/oai',
                repositoryName=>'www.myarchives.org'
        );
        for( $i->adminEmail ) {
                print $_, "\n";
        }
```

## METHODS

- $i = new HTTP::OAI::Identify(-baseURL=\>'http://arXiv.org/oai1'\[, adminEmail=\>$email, protocolVersion=\>'2.0', repositoryName=\>'myarchive'\])

  This constructor method returns a new instance of the OAI::Identify module.

- $i-\>version

  Return the original version of the OAI response, according to the given XML namespace.

- $i-\>headers

  Returns an HTTP::Headers object. Use `$headers`-\>header('headername') to retrieve field values.

- $burl = $i-\>baseURL(\[$burl\])

  - $eds = $i-\>earliestDatestamp(\[$eds\])

  - $gran = $i-\>granularity(\[$gran\])

  - $version = $i-\>protocolVersion($version)

  - $name = $i-\>repositoryName($name)

  Returns and optionally sets the relevant header. NOTE: protocolVersion will always be '2.0'. Use `$i`-\>version to find out the protocol version used by the repository.

- @addys = $i-\>adminEmail(\[$email\])

  - @cmps = $i-\>compression(\[$cmp\])

  Returns and optionally adds to the multi-value headers.

- @dl = $i-\>description(\[$d\])

  Returns the description list and optionally appends a new description `$d`. Returns an array ref of HTTP::OAI::Descriptions, or an empty ref if there are no description.

- $d = $i-\>next

  Returns the next description or undef if no more description left.

- $dom = $i-\>toDOM

  Returns a XML::DOM object representing the Identify response.