Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Net::EPP::Frame::ObjecUsercContributed Perl DocuNet::EPP::Frame::ObjectSpec(3)

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:

       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) 2016 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>.

perl v5.32.1			  2016-04-06	Net::EPP::Frame::ObjectSpec(3)

NAME | SYNOPSIS | DESCRIPTION | USAGE | AUTHOR | COPYRIGHT | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Net::EPP::Frame::ObjectSpec&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help