GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::EPP::FRAME::OBJECTSPEC (3)

.ds Aq ’

NAME

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

CONTENTS

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:
o domain, for domain names.
o host, for DNS server hosts.
o contact, for contact objects.
o secDNS, for DNSSEC information.
Note that secDNS is an extension to the domain object rather than an object in its own right.

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.

SEE ALSO

o the Net::EPP::Frame module, for constructing valid EPP frames.
o the Net::EPP::Client module, for communicating with EPP servers.
o RFCs 4930 and RFC 4934, available from <http://www.ietf.org/>.
o The CentralNic EPP site at <http://www.centralnic.com/resellers/epp>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 NET::EPP::FRAME::OBJECTSPEC (3) 2015-04-20

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.