Package com.softlayer.api.service.security

Interface Certificate.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Certificate

@ApiService("SoftLayer_Security_Certificate")
public static interface Certificate.Service
extends Service

See Also:

SoftLayer_Security_Certificate

Method Summary

Modifier and Type	Method	Description
Certificate.ServiceAsync	asAsync()	Get an async version of this service
Certificate	createObject(Certificate templateObject)	Add a certificate to your account for your records, or for use with various services.
Boolean	deleteObject()	Remove a certificate from your account.
Boolean	editObject(Certificate templateObject)	Update a certificate.
List<Certificate>	findByCommonName(String commonName)	Locate certificates by their common name, traditionally a domain name.
Long	getAssociatedServiceCount()	The number of services currently associated with the certificate.
List<Listener>	getLbaasListeners()	Cloud Load Balancer [LBaaS] listeners currently associated with the certificate.
List<VirtualIpAddress>	getLoadBalancerVirtualIpAddresses()	The load balancers virtual IP addresses currently associated with the certificate.
Certificate	getObject()
String	getPemFormat()	Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses.
void	setMask(Certificate.Mask mask)
Certificate.Mask	withMask()	Use the existing mask on this service or create it if not present
Certificate.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

Certificate.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Certificate.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

Certificate.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(Certificate.Mask mask)

createObject

@ApiMethod
Certificate createObject(Certificate templateObject)

Add a certificate to your account for your records, or for use with various services. Only the certificate and private key are usually required. If your issuer provided an intermediate certificate, you must also provide that certificate. Details will be extracted from the certificate. Validation will be performed between the certificate and the private key as well as the certificate and the intermediate certificate, if provided.

The certificate signing request is not required, but can be provided for your records.

See Also:

SoftLayer_Security_Certificate::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

Remove a certificate from your account. You may not remove a certificate with associated services.

See Also:

SoftLayer_Security_Certificate::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Certificate templateObject)

Update a certificate. Modifications are restricted to the note and CSR if the are any services associated with the certificate. There are no modification restrictions for a certificate with no associated services.

See Also:

SoftLayer_Security_Certificate::editObject

findByCommonName

@ApiMethod
List<Certificate> findByCommonName(String commonName)

Locate certificates by their common name, traditionally a domain name.

See Also:

SoftLayer_Security_Certificate::findByCommonName

getObject

@ApiMethod(instanceRequired=true)
Certificate getObject()

See Also:

SoftLayer_Security_Certificate::getObject

getPemFormat

@ApiMethod(instanceRequired=true)
String getPemFormat()

Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses.

See Also:

SoftLayer_Security_Certificate::getPemFormat

getAssociatedServiceCount

@ApiMethod(instanceRequired=true)
Long getAssociatedServiceCount()

The number of services currently associated with the certificate.

See Also:

SoftLayer_Security_Certificate::getAssociatedServiceCount

getLbaasListeners

@ApiMethod(instanceRequired=true)
List<Listener> getLbaasListeners()

Cloud Load Balancer [LBaaS] listeners currently associated with the certificate.

See Also:

SoftLayer_Security_Certificate::getLbaasListeners

getLoadBalancerVirtualIpAddresses

@ApiMethod(instanceRequired=true)
List<VirtualIpAddress> getLoadBalancerVirtualIpAddresses()

The load balancers virtual IP addresses currently associated with the certificate.

See Also:

SoftLayer_Security_Certificate::getLoadBalancerVirtualIpAddresses