Revise Tizen::Io doxygen
[platform/framework/native/appfw.git] / inc / FSecCertX509CertificateStore.h
old mode 100755 (executable)
new mode 100644 (file)
index 15c1139..61dcf20
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
 //
 
 /**
- * @if VISPARTNER
  * @file               FSecCertX509CertificateStore.h
  * @brief              This is the header file for the %X509CertificateStore class.
  *
  * This header file contains the declarations of the %X509CertificateStore class.
- *
- * @endif
  */
 #ifndef _FSEC_CERT_X509_CERTIFICATE_STORE_H_
 #define _FSEC_CERT_X509_CERTIFICATE_STORE_H_
@@ -39,16 +35,12 @@ namespace Tizen { namespace Security { namespace Cert
 class _CertMgrSvcProxy;
 
 /**
- *  @if VISPARTNER
  *     @class  X509CertificateStore
  *     @brief  This class is used for retrieving and managing certificates from a repository.
  *
  *     @since  2.0
  *
- *     @visibility     partner
- *
  *     The %X509CertificateStore class is used for retrieving and managing certificates from a repository.
- *     @endif
  */
 class _OSP_EXPORT_ X509CertificateStore
        : public virtual ICertificateStore
@@ -71,29 +63,26 @@ public:
        virtual ~X509CertificateStore(void);
 
        /**
-        *      @if VISPARTNER
         *      Gets the name of the current certificate store.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.read
         *
         *      @return                 An error code
         *      @param[out]             name                            The name of the certificate store
         *      @exception              E_SUCCESS                       The method is successful.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *      @endif
         */
        virtual result GetName(Tizen::Base::String& name) const;
 
        /**
-        *      @if VISPARTNER
         *      Sets a list of certificates that match the specified @c selector.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.read
         *
         *      @return                 An error code
@@ -104,34 +93,30 @@ public:
         *                                                                              The IPC operation has failed.
         *      @exception              E_INVALID_ARG           The specified @c selector is invalid.
         *      @exception              E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
-        *      @endif
         */
        virtual result SetCertificateSelector(const Tizen::Security::Cert::ICertificateSelector& selector);
 
        /**
-        *      @if VISPARTNER
         *      Gets a count of certificates that match the specified selector.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.read
         *
         *      @return                 An error code
         *      @param[out]             count                                   The count of certificates
         *      @exception              E_SUCCESS                               The method is successful.
         *      @exception              E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
-        *      @endif
         */
        virtual result GetCertificateCount(int& count) const;
 
        /**
-        *      @if VISPARTNER
         *      Gets each certificate that matches the specified selector.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.read
         *
         *      @return                 The certificates that matches the specified selector
@@ -141,21 +126,19 @@ public:
         *      @exception              E_SYSTEM                        A system error has occurred. @n
         *                                                                              The Tizen::Base::ByteBuffer operation has failed.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *  @endif
         */
        virtual Tizen::Security::Cert::ICertificate* GetNextCertificateN(void) const;
 
        /**
-        *      @if VISPARTNER
         *      Inserts the certificate into the certificate store.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.write
         *
         *      @return                 An error code
-        *      @param[in]              certificateType         The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN)
+        *      @param[in]              certificateType         The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN)
         *      @param[in]              certificate                     A reference to the certificate to insert
         *      @exception              E_SUCCESS                       The method is successful.
         *      @exception              E_OUT_OF_MEMORY         The memory is insufficient.
@@ -164,21 +147,19 @@ public:
         *      @exception              E_SYSTEM                        A system error has occurred. @n
         *                                      Either the IPC operation or the file operation or the DB operation has failed.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *  @endif
         */
        virtual result Insert(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate);
 
        /**
-        *  @if VISPARTNER
         *  Updates the certificate in the certificate store.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.write
         *
         *      @return                 An error code
-        *      @param[in]              certificateType         The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN)
+        *      @param[in]              certificateType         The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN)
         *      @param[in]              oldCert                         A reference to the old certificate
         *      @param[in]              newCert                         A reference to the new certificate
         *      @exception              E_SUCCESS                       The method is successful.
@@ -189,21 +170,19 @@ public:
         *      @exception              E_SYSTEM                        A system error has occurred. @n
         *                                      Either the IPC operation or the file operation or the DB operation has failed.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *      @endif
         */
        virtual result Update(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& oldCert, const Tizen::Security::Cert::ICertificate& newCert);
 
        /**
-        *  @if VISPARTNER
         *  Removes the certificate from the certificate store.
         *
         *      @since                  2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.write
         *
         *      @return                 An error code
-        *      @param[in]              certificateType         The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, TRUSTED_THIRD_PARTY_DOMAIN)
+        *      @param[in]              certificateType         The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, @c TRUSTED_THIRD_PARTY_DOMAIN)
         *      @param[in]              certificate                     A reference to the certificate to remove
         *      @exception              E_SUCCESS                       The method is successful.
         *      @exception              E_OUT_OF_MEMORY         The memory is insufficient.
@@ -213,17 +192,15 @@ public:
         *      @exception              E_SYSTEM                        A system error has occurred. @n
         *                                      Either the IPC operation or the file operation or the DB operation has failed.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *      @endif
         */
        virtual result Remove(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate);
 
        /**
-        *      @if VISPARTNER
         *  Inserts the user certificate of PKCS 12 format into the certificate store.
         *
         *      @since 2.0
         *
-        *      @visibility             partner
+        *      @privlevel              partner
         *      @privilege              %http://tizen.org/privilege/certificate.write
         *
         *      @return                 An error code
@@ -232,8 +209,8 @@ public:
         *      @exception              E_SUCCESS                       The method is successful.
         *      @exception              E_INVALID_ARG           The specified @c certificate or the certificate data is invalid.
         *      @exception              E_SYSTEM                        The method cannot proceed due to a severe system error.
+        *      @exception              E_DATA_NOT_FOUND        A root CA certificate does not exist.
         *      @exception              E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        *  @endif
         */
        result InsertPkcs12(const Tizen::Base::String& filePath, const Tizen::Base::String& password);