Difference between revisions of "Freeside:3:Documentation:Developer/FS/part export/domreg net dri"

Latest revision as of 20:08, 27 June 2012

NAME

FS::part_export::domreg_net_dri - Register or transfer domains with Net::DRI

DESCRIPTION

This module handles registering and transferring domains with select registrars or registries supported by Net::DRI.

As a part_export, this module can be designated for use with svc_domain services. When the svc_domain object is inserted into the Freeside database, registration or transferring of the domain may be initiated, depending on the setting of the svc_domain's action field. Further operations can be performed from the View Domain screen.

Logging information is written to the Freeside log folder.

For correct operation you must add name/value pairs to the protcol and transport options fields. The setttings depend on the domain registry driver (DRD) selected.

N - Register the domain; M - Transfer the domain; I - Ignore the domain for registration purposes

get_portfolio_credentials

Returns, in list context, the user name and password for the domain portfolio.

This is currently specified via the username and password keys in the protocol options.

format_tel

Reformats a phone number according to registry rules. Currently Freeside stores phone numbers in NANPA format and most registries prefer "+CCC.NPANPXNNNN"

validate_contact_set

Attempts to validate contact data for the domain based on OpenSRS rules.

Returns undef if the contact data is acceptable, an error message if the contact data lacks one or more required fields.

split_textarea_options

Split textarea contents into lines, split lines on =, and then trim the results;

get_protocol_options

Return a hash of protocol options

get_transport_options

Return a hash of transport options

is_supported_domain

Return undef if the domain name uses a TLD or SLD that is supported by this registrar. Otherwise return an error message explaining what's wrong.

get_dri; get_status

Returns a reference to a hashref containing information on the domain's status. The keys defined depend on the status.

'unregistered' means the domain is not registered.

Otherwise, if the domain is in an asynchronous operation such as a transfer, returns the state of that operation.

Otherwise returns a value indicating if the domain can be managed through our reseller account.

register

Attempts to register the domain through the reseller account associated with this export.

Like most export functions, returns an error message on failure or undef on success.

transfer

Attempts to transfer the domain into the reseller account associated with this export.

Like most export functions, returns an error message on failure or undef on success.

renew

Attempts to renew the domain for the specified number of years.

Like most export functions, returns an error message on failure or undef on success.

revoke

Attempts to revoke the domain registration. Only succeeds if invoked during the DRI grace period immediately after registration.

Like most export functions, returns an error message on failure or undef on success.

registrar

Should return a full-blown object representing the Net::DRI DRD, but current just returns a hashref containing the registrar name.

SEE ALSO

FS::part_export_option, FS::export_svc, FS::svc_domain, FS::Record, schema.html from the base documentation.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 151:

'=item' outside of any '=over'

Around line 606:

You forgot a '=back' before '=head1'