SYNOPSIS

        use Net::EPP::Frame;
        use strict;

        # create an EPP frame:
        my $check = Net::EPP::Frame::Command::Check->new;

        # get the spec:
        my @spec = Net::EPP::Frame::ObjectSpec->spec('domain');

        # create an object:
        my $domain = $check->addObject(@spec);

        # set the attributes:
        my $name = $check->createElement('domain:name');
        $name->addText('example.tld');

        # assemble the frame:
        $domain->appendChild($name);
        $check->getCommandNode->appendChild($domain);

        print $check->toString;

DESCRIPTION

\s-1EPP\s0 is the Extensible Provisioning Protocol. \s-1EPP\s0 (defined in \s-1RFC\s0 4930) is an application layer client-server protocol for the provisioning and management of objects stored in a shared central repository. Specified in \s-1XML\s0, the protocol defines generic object management operations and an extensible framework that maps protocol operations to objects. As of writing, its only well-developed application is the provisioning of Internet domain names, hosts, and related contact details.

Net::EPP::Frame::ObjectSpec is a simple module designed to provide easy access to metadata for the object types defined in the \s-1EPP\s0 specification.

USAGE

my @spec = Net::EPP::Frame::ObjectSpec->spec($type);

This function returns an array containing metadata for the given object type. If no metadata is registered then the function returns undef.

The array contains three members:

@spec = ( $type, $xmlns, $schemaLocation, );

$type is the same as the supplied argument, and the other two members correspond to the \s-1XML\s0 attributes used to specify the object in an \s-1EPP\s0 \*(C`<command>\*(C' or \*(C`<response>\*(C' frame.

The objects currently registered are:

  • \*(C`domain\*(C', for domain names.

  • \*(C`host\*(C', for \s-1DNS\s0 server hosts.

  • \*(C`contact\*(C', for contact objects.

  • \*(C`secDNS\*(C', for \s-1DNSSEC\s0 information.

AUTHOR

CentralNic Ltd (http://www.centralnic.com/).

COPYRIGHT

This module is (c) 2007 CentralNic Ltd. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

RELATED TO Net::EPP::Frame::ObjectSpec…

  • the Net::EPP::Frame module, for constructing valid \s-1EPP\s0 frames.

  • the Net::EPP::Client module, for communicating with \s-1EPP\s0 servers.

  • RFCs 4930 and \s-1RFC\s0 4934, available from <http://www.ietf.org/>.

  • The CentralNic \s-1EPP\s0 site at <http://www.centralnic.com/resellers/epp>.