com.softlayer.api.service.security.certificate.Request 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
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service.security.certificate;

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.billing.Order;
import com.softlayer.api.service.billing.order.Item;
import com.softlayer.api.service.container.product.order.security.Certificate;
import com.softlayer.api.service.security.certificate.request.Status;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Security_Certificate_Request data type is used to view details about your SSL certificate order. This contains data that is required by a Certificate Authority to place an SSL certificate order. 
 *
 * @see SoftLayer_Security_Certificate_Request
 */
@ApiType("SoftLayer_Security_Certificate_Request")
public class Request extends Entity {

    /**
     * The account to which a SSL certificate request belongs.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The order contains the information related to a SSL certificate request.
     */
    @ApiProperty
    protected Order order;

    public Order getOrder() {
        return order;
    }

    public void setOrder(Order order) {
        this.order = order;
    }

    /**
     * The associated order item for this SSL certificate request.
     */
    @ApiProperty
    protected Item orderItem;

    public Item getOrderItem() {
        return orderItem;
    }

    public void setOrderItem(Item orderItem) {
        this.orderItem = orderItem;
    }

    /**
     * The status of a SSL certificate request.
     */
    @ApiProperty
    protected Status status;

    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    /**
     * This is a reference to your SoftLayer account.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * The email address of a person who will approve your SSL certificate order. This is usually an email address of your domain administrator.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String approverEmailAddress;

    public String getApproverEmailAddress() {
        return approverEmailAddress;
    }

    public void setApproverEmailAddress(String approverEmailAddress) {
        approverEmailAddressSpecified = true;
        this.approverEmailAddress = approverEmailAddress;
    }

    protected boolean approverEmailAddressSpecified;

    public boolean isApproverEmailAddressSpecified() {
        return approverEmailAddressSpecified;
    }

    public void unsetApproverEmailAddress() {
        approverEmailAddress = null;
        approverEmailAddressSpecified = false;
    }

    /**
     * A Certificate Signing Request (CSR) string
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String certificateSigningRequest;

    public String getCertificateSigningRequest() {
        return certificateSigningRequest;
    }

    public void setCertificateSigningRequest(String certificateSigningRequest) {
        certificateSigningRequestSpecified = true;
        this.certificateSigningRequest = certificateSigningRequest;
    }

    protected boolean certificateSigningRequestSpecified;

    public boolean isCertificateSigningRequestSpecified() {
        return certificateSigningRequestSpecified;
    }

    public void unsetCertificateSigningRequest() {
        certificateSigningRequest = null;
        certificateSigningRequestSpecified = false;
    }

    /**
     * A domain name of a SSL certificate request
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String commonName;

    public String getCommonName() {
        return commonName;
    }

    public void setCommonName(String commonName) {
        commonNameSpecified = true;
        this.commonName = commonName;
    }

    protected boolean commonNameSpecified;

    public boolean isCommonNameSpecified() {
        return commonNameSpecified;
    }

    public void unsetCommonName() {
        commonName = null;
        commonNameSpecified = false;
    }

    /**
     * The date a SSL certificate request was created.
     */
    @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;
    }

    /**
     * The date of your SSL certificate went into effect
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar effectiveDate;

    public GregorianCalendar getEffectiveDate() {
        return effectiveDate;
    }

    public void setEffectiveDate(GregorianCalendar effectiveDate) {
        effectiveDateSpecified = true;
        this.effectiveDate = effectiveDate;
    }

    protected boolean effectiveDateSpecified;

    public boolean isEffectiveDateSpecified() {
        return effectiveDateSpecified;
    }

    public void unsetEffectiveDate() {
        effectiveDate = null;
        effectiveDateSpecified = false;
    }

    /**
     * The expiration date of your SSL certificate
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar expirationDate;

    public GregorianCalendar getExpirationDate() {
        return expirationDate;
    }

    public void setExpirationDate(GregorianCalendar expirationDate) {
        expirationDateSpecified = true;
        this.expirationDate = expirationDate;
    }

    protected boolean expirationDateSpecified;

    public boolean isExpirationDateSpecified() {
        return expirationDateSpecified;
    }

    public void unsetExpirationDate() {
        expirationDate = null;
        expirationDateSpecified = false;
    }

    /**
     * The internal identifier of an SSL certificate request
     */
    @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;
    }

    /**
     * The date a SSL certificate request was last modified.
     */
    @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 status id reflecting the state of a SSL certificate request
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long statusId;

    public Long getStatusId() {
        return statusId;
    }

    public void setStatusId(Long statusId) {
        statusIdSpecified = true;
        this.statusId = statusId;
    }

    protected boolean statusIdSpecified;

    public boolean isStatusIdSpecified() {
        return statusIdSpecified;
    }

    public void unsetStatusId() {
        statusId = null;
        statusIdSpecified = false;
    }

    /**
     * The technical contact email address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String technicalContactEmailAddress;

    public String getTechnicalContactEmailAddress() {
        return technicalContactEmailAddress;
    }

    public void setTechnicalContactEmailAddress(String technicalContactEmailAddress) {
        technicalContactEmailAddressSpecified = true;
        this.technicalContactEmailAddress = technicalContactEmailAddress;
    }

    protected boolean technicalContactEmailAddressSpecified;

    public boolean isTechnicalContactEmailAddressSpecified() {
        return technicalContactEmailAddressSpecified;
    }

    public void unsetTechnicalContactEmailAddress() {
        technicalContactEmailAddress = null;
        technicalContactEmailAddressSpecified = 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());
    }

    /**
     * SoftLayer_Security_Certificate_Request holds your SSL certificate request data. This data is used to manage your SSL certificate order with a Certificate Authority. 

     * 

     * To create an SSL certificate order, pass a completed SoftLayer_Container_Product_Order_Security_Certificate to SoftLayer_Product_Order::placeOrder. 
     *
     * @see SoftLayer_Security_Certificate_Request
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Security_Certificate_Request")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Cancels a pending SSL certificate order at the Certificate Authority 
         *
         * @see SoftLayer_Security_Certificate_Request::cancelSslOrder
         */
        @ApiMethod(instanceRequired = true)
        public Boolean cancelSslOrder();

        /**
         * Gets the email domains that can be used to validate a certificate to a domain. 
         *
         * @see SoftLayer_Security_Certificate_Request::getAdministratorEmailDomains
         */
        @ApiMethod
        public List getAdministratorEmailDomains(String commonName);

        /**
         * Gets the email accounts that can be used to validate a certificate to a domain. 
         *
         * @see SoftLayer_Security_Certificate_Request::getAdministratorEmailPrefixes
         */
        @ApiMethod
        public List getAdministratorEmailPrefixes();

        /**
         * @see SoftLayer_Security_Certificate_Request::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Request getObject();

        /**
         * Returns previous SSL certificate order data. You can use this data for to place a renewal order for a completed SSL certificate. 
         *
         * @see SoftLayer_Security_Certificate_Request::getPreviousOrderData
         */
        @ApiMethod(instanceRequired = true)
        public Certificate getPreviousOrderData();

        /**
         * Returns all the SSL certificate requests. 
         *
         * @see SoftLayer_Security_Certificate_Request::getSslCertificateRequests
         */
        @ApiMethod
        public List getSslCertificateRequests(Long accountId);

        /**
         * A Certificate Authority sends out various emails to your domain administrator or your technical contact. Use this service to have these emails re-sent. 
         *
         * @see SoftLayer_Security_Certificate_Request::resendEmail
         */
        @ApiMethod(instanceRequired = true)
        public Boolean resendEmail(String emailType);

        /**
         * Allows you to validate a Certificate Signing Request (CSR) required for an SSL certificate with the certificate authority (CA).  This method sends the CSR, the length of the subscription in months, the certificate type, and the server type for validation against requirements of the CA.  Returns true if valid. 

         * 

         * More information on CSR generation can be found at: [http://en.wikipedia.org/wiki/Certificate_signing_request Wikipedia] [https://www.digicert.com/csr-creation.htm DigiCert] 
         *
         * @see SoftLayer_Security_Certificate_Request::validateCsr
         */
        @ApiMethod
        public Boolean validateCsr(String csr, Long validityMonths, Long itemId, String serverType);

        /**
         * The account to which a SSL certificate request belongs.
         *
         * @see SoftLayer_Security_Certificate_Request::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * The order contains the information related to a SSL certificate request.
         *
         * @see SoftLayer_Security_Certificate_Request::getOrder
         */
        @ApiMethod(instanceRequired = true)
        public Order getOrder();

        /**
         * The associated order item for this SSL certificate request.
         *
         * @see SoftLayer_Security_Certificate_Request::getOrderItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getOrderItem();

        /**
         * The status of a SSL certificate request.
         *
         * @see SoftLayer_Security_Certificate_Request::getStatus
         */
        @ApiMethod(instanceRequired = true)
        public Status getStatus();

    }

    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#cancelSslOrder}
         */
        public Future cancelSslOrder();

        public Future cancelSslOrder(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAdministratorEmailDomains}
         */
        public Future> getAdministratorEmailDomains(String commonName);

        public Future getAdministratorEmailDomains(String commonName, ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAdministratorEmailPrefixes}
         */
        public Future> getAdministratorEmailPrefixes();

        public Future getAdministratorEmailPrefixes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPreviousOrderData}
         */
        public Future getPreviousOrderData();

        public Future getPreviousOrderData(ResponseHandler callback);

        /**
         * Async version of {@link Service#getSslCertificateRequests}
         */
        public Future> getSslCertificateRequests(Long accountId);

        public Future getSslCertificateRequests(Long accountId, ResponseHandler> callback);

        /**
         * Async version of {@link Service#resendEmail}
         */
        public Future resendEmail(String emailType);

        public Future resendEmail(String emailType, ResponseHandler callback);

        /**
         * Async version of {@link Service#validateCsr}
         */
        public Future validateCsr(String csr, Long validityMonths, Long itemId, String serverType);

        public Future validateCsr(String csr, Long validityMonths, Long itemId, String serverType, 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#getOrder}
         */
        public Future getOrder();

        /**
         * Async callback version of {@link Service#getOrder}
         */
        public Future getOrder(ResponseHandler callback);

        /**
         * Async version of {@link Service#getOrderItem}
         */
        public Future getOrderItem();

        /**
         * Async callback version of {@link Service#getOrderItem}
         */
        public Future getOrderItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getStatus}
         */
        public Future getStatus();

        /**
         * Async callback version of {@link Service#getStatus}
         */
        public Future getStatus(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.billing.Order.Mask order() {
            return withSubMask("order", com.softlayer.api.service.billing.Order.Mask.class);
        }

        public com.softlayer.api.service.billing.order.Item.Mask orderItem() {
            return withSubMask("orderItem", com.softlayer.api.service.billing.order.Item.Mask.class);
        }

        public com.softlayer.api.service.security.certificate.request.Status.Mask status() {
            return withSubMask("status", com.softlayer.api.service.security.certificate.request.Status.Mask.class);
        }

        public Mask accountId() {
            withLocalProperty("accountId");
            return this;
        }

        public Mask approverEmailAddress() {
            withLocalProperty("approverEmailAddress");
            return this;
        }

        public Mask certificateSigningRequest() {
            withLocalProperty("certificateSigningRequest");
            return this;
        }

        public Mask commonName() {
            withLocalProperty("commonName");
            return this;
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask effectiveDate() {
            withLocalProperty("effectiveDate");
            return this;
        }

        public Mask expirationDate() {
            withLocalProperty("expirationDate");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask modifyDate() {
            withLocalProperty("modifyDate");
            return this;
        }

        public Mask statusId() {
            withLocalProperty("statusId");
            return this;
        }

        public Mask technicalContactEmailAddress() {
            withLocalProperty("technicalContactEmailAddress");
            return this;
        }

    }

}