.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::EPP::Frame::ObjectSpec 3pm"
.TH Net::EPP::Frame::ObjectSpec 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::EPP::Frame::ObjectSpec \- metadata about EPP object types
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        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(\*(Aqdomain\*(Aq);
\&
\&        # create an object:
\&        my $domain = $check\->addObject(@spec);
\&
\&        # set the attributes:
\&        my $name = $check\->createElement(\*(Aqdomain:name\*(Aq);
\&        $name\->addText(\*(Aqexample.tld\*(Aq);
\&
\&        # assemble the frame:
\&        $domain\->appendChild($name);
\&        $check\->getCommandNode\->appendChild($domain);
\&
\&        print $check\->toString;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1EPP\s0 is the Extensible Provisioning Protocol. \s-1EPP\s0 (defined in \s-1RFC 4930\s0) is an
application layer client-server protocol for the provisioning and management of
objects stored in a shared central repository. Specified in \s-1XML,\s0 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.
.PP
Net::EPP::Frame::ObjectSpec is a simple module designed to provide easy access to
metadata for the object types defined in the \s-1EPP\s0 specification.
.SH "USAGE"
.IX Header "USAGE"
.Vb 1
\&        my @spec = Net::EPP::Frame::ObjectSpec\->spec($type);
.Ve
.PP
This function returns an array containing metadata for the given object type.
If no metadata is registered then the function returns undef.
.PP
The array contains three members:
.PP
.Vb 5
\&        @spec = (
\&                $type,
\&                $xmlns,
\&                $schemaLocation,
\&        );
.Ve
.PP
\&\f(CW$type\fR is the same as the supplied argument, and the other two members
correspond to the \s-1XML\s0 attributes used to specify the object in an \s-1EPP\s0
\&\f(CW\*(C`<command>\*(C'\fR or \f(CW\*(C`<response>\*(C'\fR frame.
.PP
The objects currently registered are:
.IP "\(bu" 4
\&\f(CW\*(C`domain\*(C'\fR, for domain names.
.IP "\(bu" 4
\&\f(CW\*(C`host\*(C'\fR, for \s-1DNS\s0 server hosts.
.IP "\(bu" 4
\&\f(CW\*(C`contact\*(C'\fR, for contact objects.
.IP "\(bu" 4
\&\f(CW\*(C`secDNS\*(C'\fR, for \s-1DNSSEC\s0 information.
.PP
Note that secDNS is an extension to the domain object rather than an
object in its own right.
.SH "AUTHOR"
.IX Header "AUTHOR"
CentralNic Ltd (http://www.centralnic.com/).
.SH "COPYRIGHT"
.IX Header "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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
the Net::EPP::Frame module, for constructing valid \s-1EPP\s0 frames.
.IP "\(bu" 4
the Net::EPP::Client module, for communicating with \s-1EPP\s0 servers.
.IP "\(bu" 4
RFCs 4930 and \s-1RFC 4934,\s0 available from <http://www.ietf.org/>.
.IP "\(bu" 4
The CentralNic \s-1EPP\s0 site at <http://www.centralnic.com/resellers/epp>.