/ 
Net-EPP-0.24
River stage one • 4 direct dependents • 4 total dependents
/ Net::EPP::Frame::ObjectSpec

NAME

Net::EPP::Frame::ObjectSpec - metadata about EPP object types

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

EPP is the Extensible Provisioning Protocol. EPP (defined in RFC 4930) is an application layer client-server protocol for the provisioning and management of objects stored in a shared central repository. Specified in XML, 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 EPP 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 XML attributes used to specify the object in an EPP <command> or <response> frame.

The objects currently registered are:

  • domain, for domain names.

  • host, for DNS server hosts.

  • contact, for contact objects.

  • secDNS, for DNSSEC information.

Note that secDNS is an extension to the domain object rather than an object in its own right.