Package com.softlayer.api.service.security.certificate

Interface Request.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Request

@ApiService("SoftLayer_Security_Certificate_Request")
public static interface Request.Service
extends Service

SoftLayer_Security_Certificate_Request holds your SSL certificate request data. This data is used to place an SSL certificate order with a Certificate Authority.

To create an SSL certificate order, pass a completed [[SoftLayer_Container_Product_Order_Security_Certificate|SSL order container]] to the [[SoftLayer_Product_Order::placeOrder|SoftLayer ordering service]].

See Also:

SoftLayer_Security_Certificate_Request

Method Summary

Modifier and Type	Method	Description
Request.ServiceAsync	asAsync()	Get an async version of this service
Boolean	cancelSslOrder()	Cancels a pending SSL certificate order at the Certificate Authority
Account	getAccount()	The account to which a SSL certificate request belongs.
List<String>	getAdministratorEmailDomains(String commonName)	Gets the email domains that can be used to validate a certificate to a domain.
List<String>	getAdministratorEmailPrefixes()	Gets the email accounts that can be used to validate a certificate to a domain.
Request	getObject()
Order	getOrder()	The order contains the information related to a SSL certificate request.
Item	getOrderItem()	The associated order item for this SSL certificate request.
Certificate	getPreviousOrderData()	Returns previous SSL certificate order data.
List<Request>	getSslCertificateRequests(Long accountId)	Returns all the SSL certificate requests.
Status	getStatus()	The status of a SSL certificate request.
Boolean	resendEmail(String emailType)	A Certificate Authority sends out various emails to your domain administrator or your technical contact.
void	setMask(Request.Mask mask)
Boolean	validateCsr(String csr, Long validityMonths, Long itemId, String serverType)	Allows you to validate a Certificate Signing Request (CSR) required for an SSL certificate with the certificate authority (CA).
Request.Mask	withMask()	Use the existing mask on this service or create it if not present
Request.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Request.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Request.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Request.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Request.Mask mask)

cancelSslOrder

@ApiMethod(instanceRequired=true)
Boolean cancelSslOrder()

Cancels a pending SSL certificate order at the Certificate Authority

See Also:

SoftLayer_Security_Certificate_Request::cancelSslOrder

getAdministratorEmailDomains

@ApiMethod
List<String> getAdministratorEmailDomains(String commonName)

Gets the email domains that can be used to validate a certificate to a domain.

See Also:

SoftLayer_Security_Certificate_Request::getAdministratorEmailDomains

getAdministratorEmailPrefixes

@ApiMethod
List<String> getAdministratorEmailPrefixes()

Gets the email accounts that can be used to validate a certificate to a domain.

See Also:

SoftLayer_Security_Certificate_Request::getAdministratorEmailPrefixes

getObject

@ApiMethod(instanceRequired=true)
Request getObject()

See Also:

SoftLayer_Security_Certificate_Request::getObject

getPreviousOrderData

@ApiMethod(instanceRequired=true)
Certificate getPreviousOrderData()

Returns previous SSL certificate order data. You can use this data for to place a renewal order for a completed SSL certificate.

See Also:

SoftLayer_Security_Certificate_Request::getPreviousOrderData

getSslCertificateRequests

@ApiMethod
List<Request> getSslCertificateRequests(Long accountId)

Returns all the SSL certificate requests.

See Also:

SoftLayer_Security_Certificate_Request::getSslCertificateRequests

resendEmail

@ApiMethod(instanceRequired=true)
Boolean resendEmail(String emailType)

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 Also:

SoftLayer_Security_Certificate_Request::resendEmail

validateCsr

@ApiMethod
Boolean validateCsr(String csr,
                    Long validityMonths,
                    Long itemId,
                    String serverType)

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 Also:

SoftLayer_Security_Certificate_Request::validateCsr

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account to which a SSL certificate request belongs.

See Also:

SoftLayer_Security_Certificate_Request::getAccount

getOrder

@ApiMethod(instanceRequired=true)
Order getOrder()

The order contains the information related to a SSL certificate request.

See Also:

SoftLayer_Security_Certificate_Request::getOrder

getOrderItem

@ApiMethod(instanceRequired=true)
Item getOrderItem()

The associated order item for this SSL certificate request.

See Also:

SoftLayer_Security_Certificate_Request::getOrderItem

getStatus

@ApiMethod(instanceRequired=true)
Status getStatus()

The status of a SSL certificate request.

See Also:

SoftLayer_Security_Certificate_Request::getStatus