| Net-EPP documentation | Contained in the Net-EPP distribution. |
Net::EPP::Frame::ObjectSpec - metadata about EPP object types
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;
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.
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.CentralNic Ltd (http://www.centralnic.com/).
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.
| Net-EPP documentation | Contained in the Net-EPP distribution. |
#! $Id: ObjectSpec.pm,v 1.2 2007/12/03 11:44:51 gavin Exp $ package Net::EPP::Frame::ObjectSpec; use vars qw($SPEC); use strict; our $SPEC = { 'domain' => [ 'urn:ietf:params:xml:ns:domain-1.0', 'urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd' ], 'contact' => [ 'urn:ietf:params:xml:ns:contact-1.0', 'urn:ietf:params:xml:ns:contact-1.0 contact-1.0.xsd' ], 'host' => [ 'urn:ietf:params:xml:ns:host-1.0', 'urn:ietf:params:xml:ns:host-1.0 host-1.0.xsd' ], 'secDNS' => [ 'urn:ietf:params:xml:ns:secDNS-1.0', 'urn:ietf:params:xml:ns:secDNS-1.0 secDNS-1.0.xsd' ], }; sub spec { my $type = $_[1]; return (!defined($SPEC->{$type}) ? undef : ($type, @{$SPEC->{$type}})); }
1;