net::epp::frame::objectspec(3pm) [debian man page]

Net::EPP::Frame::ObjectSpec(3pm)			User Contributed Perl Documentation			  Net::EPP::Frame::ObjectSpec(3pm)

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.

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

perl v5.14.2							    2008-12-04					  Net::EPP::Frame::ObjectSpec(3pm)

Check Out this Related Man Page

Net::EPP::Frame::Command::Create::Contact(3pm)		User Contributed Perl Documentation	    Net::EPP::Frame::Command::Create::Contact(3pm)

NAME

       Net::EPP::Frame::Command::Create::Contact - an instance of Net::EPP::Frame::Command::Create for contact objects.

SYNOPSIS

	       use Net::EPP::Frame::Command::Create::Contact;
	       use strict;

	       my $create = Net::EPP::Frame::Command::Create::Contact->new;
	       $create->setContact('contact-id);

	       print $create->toString(1);

       This results in an XML document like this:

	       <?xml version="1.0" encoding="UTF-8"?>
	       <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
		 epp-1.0.xsd">
		   <command>
		     <check>
		       <contact:create
			 xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
			 xsi:schemaLocation="urn:ietf:params:xml:ns:contact-1.0
			 contact-1.0.xsd">
			   <contact:id>example-1.tldE<lt>/contact:id>
		       </contact:create>
		     </check>
		     <clTRID>0cf1b8f7e14547d26f03b7641660c641d9e79f45</clTRIDE<gt>
		   </command>
	       </epp>

OBJECT HIERARCHY

	   L<XML::LibXML::Node>
	   +----L<XML::LibXML::Document>
	       +----L<Net::EPP::Frame>
		   +----L<Net::EPP::Frame::Command>
		       +----L<Net::EPP::Frame::Command::Create>
			   +----L<Net::EPP::Frame::Command::Create::Contact>

METHODS

	       my $element = $frame->setContact($contact_id);

       This sets the contact ID of the object to be created. Returns the "<contact:name>" element.

AUTHOR

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

COPYRIGHT

       This module is (c) 2012 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   Net::EPP::Frame

perl v5.14.2							    2012-04-23			    Net::EPP::Frame::Command::Create::Contact(3pm)

Linux and UNIX Man Pages

net::epp::frame::objectspec(3pm) [debian man page]

Check Out this Related Man Page