NAME

Net::RDAP::Values - interface to the RDAP values registry.

DESCRIPTION

The RDAP JSON Values Registry was defined in RFC 7483 and lists the permitted values of certain RDAP object properties. This class implements an interface to that registry.

Ironically, since the registry is only available in CSV and XML formats, this module has to use XML::LibXML in order to access the registry data that it retrieves from the IANA web server.

METHODS

check()

        Net::RDAP::Values->check($value, $type);

        Net::RDAP::Values->check('add period', RDAP_TYPE_STATUS);

        Net::RDAP::Values->check('registration', RDAP_TYPE_EVENT_ACTION);

The check() function allows you to determine if a given value is present in the registry. You must also specify the type of the value using one of the RDAP_TYPE_* constants.

If the value is registered in the registry, this method returns a true value, otherwise it returns undef.

values()

        @values = Net::RDAP::Values->values($type);

        @values = Net::RDAP::Values->values(RDAP_TYPE_ROLE);

The values() function returns a list of the permitted values for the given value type. If you specify an invalid type, an exception is raised.

types()

        @types = Net::RDAP::Values->types;

The types() function returns a list of all possible RDAP value types.

description()

        $description = Net::RDAP::Values->description($value, $type);

        $description = Net::RDAP::Values->description('registration', RDAP_TYPE_EVENT_ACTION);

        use Net::RDAP::EPPStatusMap;
        $description = Net::RDAP::Values->description(epp2rdap('serverHold'), RDAP_TYPE_STATUS);

The description() function returns a textual description (in English) of the value in the registry, suitable for display to the user.

EXPORTED CONSTANTS

Net::RDAP::Values exports the following constants, which correspond to the permitted types of RDAP values:

  • RDAP_TYPE_NOTICE_OR_REMARK_TYPE

  • RDAP_TYPE_STATUS

  • RDAP_TYPE_ROLE

  • RDAP_TYPE_EVENT_ACTION

  • RDAP_TYPE_DOMAIN_VARIANT_RELATION

COPYRIGHT

Copyright 2019 CentralNic Ltd. All rights reserved.

LICENSE

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.