org.wso2.carbon.device.mgt.jaxrs.api

Interface Certificate

All Known Implementing Classes:

CertificateImpl

public interface Certificate

All the certificate related tasks such as saving certificates, can be done through this endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllCertificates(String acceptHeader, int startIndex, int length) Get all certificates in a paginated manner.
javax.ws.rs.core.Response	getCertificate(String acceptHeader, String serialNumber) Get a certificate when the serial number is given.
javax.ws.rs.core.Response	removeCertificate(String acceptHeader, String serialNumber)
javax.ws.rs.core.Response	saveCertificate(String acceptHeader, EnrollmentCertificate[] enrollmentCertificates) Save a list of certificates and relevant information in the database.

Method Detail

saveCertificate

javax.ws.rs.core.Response saveCertificate(@HeaderParam(value="Accept")
                                        String acceptHeader,
                                        EnrollmentCertificate[] enrollmentCertificates)

Save a list of certificates and relevant information in the database.

Parameters:

enrollmentCertificates - List of all the certificates which includes the tenant id, certificate as a pem and a serial number.

Returns:

Status of the data persist operation.

getCertificate

javax.ws.rs.core.Response getCertificate(@HeaderParam(value="Accept")
                                       String acceptHeader,
                                       String serialNumber)

Get a certificate when the serial number is given.

Parameters:

serialNumber - serial of the certificate needed.

Returns:

certificate response.

getAllCertificates

javax.ws.rs.core.Response getAllCertificates(@HeaderParam(value="Accept")
                                           String acceptHeader,
                                           int startIndex,
                                           int length)
                                             throws MDMAPIException

Get all certificates in a paginated manner.

Parameters:

startIndex - index of the first record to be fetched

length - number of records to be fetched starting from the start index.

Returns:

paginated result of certificate.

Throws:

MDMAPIException

removeCertificate

javax.ws.rs.core.Response removeCertificate(@HeaderParam(value="Accept")
                                          String acceptHeader,
                                          String serialNumber)
                                            throws MDMAPIException

Throws:

MDMAPIException