com.softlayer.api.service.dns.domain.Registration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.dns.domain;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.dns.domain.registration.Contact;
import com.softlayer.api.service.container.dns.domain.registration.ExtendedAttribute;
import com.softlayer.api.service.container.dns.domain.registration.Lookup;
import com.softlayer.api.service.container.dns.domain.registration.Nameserver;
import com.softlayer.api.service.container.dns.domain.registration.registrant.verification.StatusDetail;
import com.softlayer.api.service.container.dns.domain.registration.transfer.Information;
import com.softlayer.api.service.dns.domain.registration.registrant.verification.Status;
import com.softlayer.api.service.service.Provider;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Dns_Domain_Registration data type represents a domain registration record.
*
* @see SoftLayer_Dns_Domain_Registration
*/
@ApiType("SoftLayer_Dns_Domain_Registration")
public class Registration extends Entity {
/**
* The SoftLayer customer account that the domain is registered to.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* The domain registration status.
*/
@ApiProperty
protected com.softlayer.api.service.dns.domain.registration.Status domainRegistrationStatus;
public com.softlayer.api.service.dns.domain.registration.Status getDomainRegistrationStatus() {
return domainRegistrationStatus;
}
public void setDomainRegistrationStatus(com.softlayer.api.service.dns.domain.registration.Status domainRegistrationStatus) {
this.domainRegistrationStatus = domainRegistrationStatus;
}
/**
* The registrant verification status.
*/
@ApiProperty
protected Status registrantVerificationStatus;
public Status getRegistrantVerificationStatus() {
return registrantVerificationStatus;
}
public void setRegistrantVerificationStatus(Status registrantVerificationStatus) {
this.registrantVerificationStatus = registrantVerificationStatus;
}
@ApiProperty
protected Provider serviceProvider;
public Provider getServiceProvider() {
return serviceProvider;
}
public void setServiceProvider(Provider serviceProvider) {
this.serviceProvider = serviceProvider;
}
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long domainRegistrationStatusId;
public Long getDomainRegistrationStatusId() {
return domainRegistrationStatusId;
}
public void setDomainRegistrationStatusId(Long domainRegistrationStatusId) {
domainRegistrationStatusIdSpecified = true;
this.domainRegistrationStatusId = domainRegistrationStatusId;
}
protected boolean domainRegistrationStatusIdSpecified;
public boolean isDomainRegistrationStatusIdSpecified() {
return domainRegistrationStatusIdSpecified;
}
public void unsetDomainRegistrationStatusId() {
domainRegistrationStatusId = null;
domainRegistrationStatusIdSpecified = false;
}
/**
* The date that the domain registration will expire.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar expireDate;
public GregorianCalendar getExpireDate() {
return expireDate;
}
public void setExpireDate(GregorianCalendar expireDate) {
expireDateSpecified = true;
this.expireDate = expireDate;
}
protected boolean expireDateSpecified;
public boolean isExpireDateSpecified() {
return expireDateSpecified;
}
public void unsetExpireDate() {
expireDate = null;
expireDateSpecified = false;
}
/**
* A domain record's internal identifier.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* Indicates whether a domain is locked or unlocked.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long lockedFlag;
public Long getLockedFlag() {
return lockedFlag;
}
public void setLockedFlag(Long lockedFlag) {
lockedFlagSpecified = true;
this.lockedFlag = lockedFlag;
}
protected boolean lockedFlagSpecified;
public boolean isLockedFlagSpecified() {
return lockedFlagSpecified;
}
public void unsetLockedFlag() {
lockedFlag = null;
lockedFlagSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* A domain's name, for example "example.com".
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String name;
public String getName() {
return name;
}
public void setName(String name) {
nameSpecified = true;
this.name = name;
}
protected boolean nameSpecified;
public boolean isNameSpecified() {
return nameSpecified;
}
public void unsetName() {
name = null;
nameSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long registrantVerificationStatusId;
public Long getRegistrantVerificationStatusId() {
return registrantVerificationStatusId;
}
public void setRegistrantVerificationStatusId(Long registrantVerificationStatusId) {
registrantVerificationStatusIdSpecified = true;
this.registrantVerificationStatusId = registrantVerificationStatusId;
}
protected boolean registrantVerificationStatusIdSpecified;
public boolean isRegistrantVerificationStatusIdSpecified() {
return registrantVerificationStatusIdSpecified;
}
public void unsetRegistrantVerificationStatusId() {
registrantVerificationStatusId = null;
registrantVerificationStatusIdSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long serviceProviderId;
public Long getServiceProviderId() {
return serviceProviderId;
}
public void setServiceProviderId(Long serviceProviderId) {
serviceProviderIdSpecified = true;
this.serviceProviderId = serviceProviderId;
}
protected boolean serviceProviderIdSpecified;
public boolean isServiceProviderIdSpecified() {
return serviceProviderIdSpecified;
}
public void unsetServiceProviderId() {
serviceProviderId = null;
serviceProviderIdSpecified = false;
}
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* Registration and management of domain names and domain related services.
*
* @see SoftLayer_Dns_Domain_Registration
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Dns_Domain_Registration")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist.
*
* @see SoftLayer_Dns_Domain_Registration::addNameserversToDomain
*/
@ApiMethod(instanceRequired = true)
public Boolean addNameserversToDomain(List nameservers);
/**
* The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain
*
* @see SoftLayer_Dns_Domain_Registration::deleteRegisteredNameserver
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteRegisteredNameserver(String nameserver);
/**
* The getAuthenticationCode method retrieves the authentication code for the domain.
*
* @see SoftLayer_Dns_Domain_Registration::getAuthenticationCode
*/
@ApiMethod(instanceRequired = true)
public String getAuthenticationCode();
/**
* The getDomainInformation method retrieves all the information for a domain.
*
* @see SoftLayer_Dns_Domain_Registration::getDomainInformation
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.container.dns.domain.registration.Information getDomainInformation();
/**
* The getDomainNameservers method retrieve nameservers information for domain.
*
* @see SoftLayer_Dns_Domain_Registration::getDomainNameservers
*/
@ApiMethod(instanceRequired = true)
public List getDomainNameservers();
/**
* The getExtendedAttributes method determines if a country code top level domain requires extended attributes.
*
* @see SoftLayer_Dns_Domain_Registration::getExtendedAttributes
*/
@ApiMethod
public List getExtendedAttributes(String domainName);
/**
* getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service.
*
* @see SoftLayer_Dns_Domain_Registration::getObject
*/
@ApiMethod(instanceRequired = true)
public Registration getObject();
/**
* The getRegisteredNameserver method retrieves registered nameservers.
*
* @see SoftLayer_Dns_Domain_Registration::getRegisteredNameserver
*/
@ApiMethod(instanceRequired = true)
public Nameserver getRegisteredNameserver();
/**
* When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method returns the current state of the verification request.
*
* @see SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatusDetail
*/
@ApiMethod(instanceRequired = true)
public StatusDetail getRegistrantVerificationStatusDetail();
/**
* The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request.
*
* @see SoftLayer_Dns_Domain_Registration::getTransferInformation
*/
@ApiMethod
public Information getTransferInformation(String domainName);
/**
* The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited:
* * Transferring of the domain name
* * Deletion of the domain name
*
* @see SoftLayer_Dns_Domain_Registration::lockDomain
*/
@ApiMethod(instanceRequired = true)
public Boolean lockDomain();
/**
* The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well.
*
* @see SoftLayer_Dns_Domain_Registration::lookupDomain
*/
@ApiMethod
public List lookupDomain(String domainName);
/**
* The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain.
*
* @see SoftLayer_Dns_Domain_Registration::modifyContact
*/
@ApiMethod(instanceRequired = true)
public Boolean modifyContact(Contact contact);
/**
* The modifyRegisteredNameserver method modifies a nameserver that was registered.
*
* @see SoftLayer_Dns_Domain_Registration::modifyRegisteredNameserver
*/
@ApiMethod(instanceRequired = true)
public Boolean modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress);
/**
* The registerNameserver method creates a nameserver for the domain.
*
* @see SoftLayer_Dns_Domain_Registration::registerNameserver
*/
@ApiMethod(instanceRequired = true)
public Boolean registerNameserver(String nameserver, String ipAddress);
/**
* The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it.
*
* @see SoftLayer_Dns_Domain_Registration::removeNameserversFromDomain
*/
@ApiMethod(instanceRequired = true)
public Boolean removeNameserversFromDomain(List nameservers);
/**
* The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain.
*
* @see SoftLayer_Dns_Domain_Registration::sendAuthenticationCode
*/
@ApiMethod(instanceRequired = true)
public Boolean sendAuthenticationCode();
/**
* When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method sends the verification email to the registrant.
*
* @see SoftLayer_Dns_Domain_Registration::sendRegistrantVerificationEmail
*/
@ApiMethod(instanceRequired = true)
public Boolean sendRegistrantVerificationEmail();
/**
* The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted
*
* @see SoftLayer_Dns_Domain_Registration::sendTransferApprovalEmail
*/
@ApiMethod(instanceRequired = true)
public Boolean sendTransferApprovalEmail();
/**
* The setAuthenticationCode method sets the authentication code for the domain. The authentication code is a transfer key and provides an extra level of security, safeguarding domain names from unauthorized transfers.
*
* @see SoftLayer_Dns_Domain_Registration::setAuthenticationCode
*/
@ApiMethod(instanceRequired = true)
public Boolean setAuthenticationCode(String authenticationCode);
/**
* The unlockDomain method unlocks a domain
*
* @see SoftLayer_Dns_Domain_Registration::unlockDomain
*/
@ApiMethod(instanceRequired = true)
public Boolean unlockDomain();
/**
* The SoftLayer customer account that the domain is registered to.
*
* @see SoftLayer_Dns_Domain_Registration::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* The domain registration status.
*
* @see SoftLayer_Dns_Domain_Registration::getDomainRegistrationStatus
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.dns.domain.registration.Status getDomainRegistrationStatus();
/**
* The registrant verification status.
*
* @see SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatus
*/
@ApiMethod(instanceRequired = true)
public Status getRegistrantVerificationStatus();
/**
* @see SoftLayer_Dns_Domain_Registration::getServiceProvider
*/
@ApiMethod(instanceRequired = true)
public Provider getServiceProvider();
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#addNameserversToDomain}
*/
public Future addNameserversToDomain(List nameservers);
public Future addNameserversToDomain(List nameservers, ResponseHandler callback);
/**
* Async version of {@link Service#deleteRegisteredNameserver}
*/
public Future deleteRegisteredNameserver(String nameserver);
public Future deleteRegisteredNameserver(String nameserver, ResponseHandler callback);
/**
* Async version of {@link Service#getAuthenticationCode}
*/
public Future getAuthenticationCode();
public Future getAuthenticationCode(ResponseHandler callback);
/**
* Async version of {@link Service#getDomainInformation}
*/
public Future getDomainInformation();
public Future getDomainInformation(ResponseHandler callback);
/**
* Async version of {@link Service#getDomainNameservers}
*/
public Future> getDomainNameservers();
public Future getDomainNameservers(ResponseHandler> callback);
/**
* Async version of {@link Service#getExtendedAttributes}
*/
public Future> getExtendedAttributes(String domainName);
public Future getExtendedAttributes(String domainName, ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getRegisteredNameserver}
*/
public Future getRegisteredNameserver();
public Future getRegisteredNameserver(ResponseHandler callback);
/**
* Async version of {@link Service#getRegistrantVerificationStatusDetail}
*/
public Future getRegistrantVerificationStatusDetail();
public Future getRegistrantVerificationStatusDetail(ResponseHandler callback);
/**
* Async version of {@link Service#getTransferInformation}
*/
public Future getTransferInformation(String domainName);
public Future getTransferInformation(String domainName, ResponseHandler callback);
/**
* Async version of {@link Service#lockDomain}
*/
public Future lockDomain();
public Future lockDomain(ResponseHandler callback);
/**
* Async version of {@link Service#lookupDomain}
*/
public Future> lookupDomain(String domainName);
public Future lookupDomain(String domainName, ResponseHandler> callback);
/**
* Async version of {@link Service#modifyContact}
*/
public Future modifyContact(Contact contact);
public Future modifyContact(Contact contact, ResponseHandler callback);
/**
* Async version of {@link Service#modifyRegisteredNameserver}
*/
public Future modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress);
public Future modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress, ResponseHandler callback);
/**
* Async version of {@link Service#registerNameserver}
*/
public Future registerNameserver(String nameserver, String ipAddress);
public Future registerNameserver(String nameserver, String ipAddress, ResponseHandler callback);
/**
* Async version of {@link Service#removeNameserversFromDomain}
*/
public Future removeNameserversFromDomain(List nameservers);
public Future removeNameserversFromDomain(List nameservers, ResponseHandler callback);
/**
* Async version of {@link Service#sendAuthenticationCode}
*/
public Future sendAuthenticationCode();
public Future sendAuthenticationCode(ResponseHandler callback);
/**
* Async version of {@link Service#sendRegistrantVerificationEmail}
*/
public Future sendRegistrantVerificationEmail();
public Future sendRegistrantVerificationEmail(ResponseHandler callback);
/**
* Async version of {@link Service#sendTransferApprovalEmail}
*/
public Future sendTransferApprovalEmail();
public Future sendTransferApprovalEmail(ResponseHandler callback);
/**
* Async version of {@link Service#setAuthenticationCode}
*/
public Future setAuthenticationCode(String authenticationCode);
public Future setAuthenticationCode(String authenticationCode, ResponseHandler callback);
/**
* Async version of {@link Service#unlockDomain}
*/
public Future unlockDomain();
public Future unlockDomain(ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getDomainRegistrationStatus}
*/
public Future getDomainRegistrationStatus();
/**
* Async callback version of {@link Service#getDomainRegistrationStatus}
*/
public Future getDomainRegistrationStatus(ResponseHandler callback);
/**
* Async version of {@link Service#getRegistrantVerificationStatus}
*/
public Future getRegistrantVerificationStatus();
/**
* Async callback version of {@link Service#getRegistrantVerificationStatus}
*/
public Future getRegistrantVerificationStatus(ResponseHandler callback);
/**
* Async version of {@link Service#getServiceProvider}
*/
public Future getServiceProvider();
/**
* Async callback version of {@link Service#getServiceProvider}
*/
public Future getServiceProvider(ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public com.softlayer.api.service.Account.Mask account() {
return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
}
public com.softlayer.api.service.dns.domain.registration.Status.Mask domainRegistrationStatus() {
return withSubMask("domainRegistrationStatus", com.softlayer.api.service.dns.domain.registration.Status.Mask.class);
}
public com.softlayer.api.service.dns.domain.registration.registrant.verification.Status.Mask registrantVerificationStatus() {
return withSubMask("registrantVerificationStatus", com.softlayer.api.service.dns.domain.registration.registrant.verification.Status.Mask.class);
}
public com.softlayer.api.service.service.Provider.Mask serviceProvider() {
return withSubMask("serviceProvider", com.softlayer.api.service.service.Provider.Mask.class);
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask domainRegistrationStatusId() {
withLocalProperty("domainRegistrationStatusId");
return this;
}
public Mask expireDate() {
withLocalProperty("expireDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask lockedFlag() {
withLocalProperty("lockedFlag");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
public Mask registrantVerificationStatusId() {
withLocalProperty("registrantVerificationStatusId");
return this;
}
public Mask serviceProviderId() {
withLocalProperty("serviceProviderId");
return this;
}
}
}