Corrected @file tags and restored 'Files' section.
[platform/upstream/iotivity.git] / resource / include / OCSecurityModel.h
1 //******************************************************************
2 //
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20
21 /**
22  * @file
23  *
24  * This file contains the declaration of classes and its members required to
25  * provide security model support.
26  */
27
28 #ifndef __OCSECURITYMODEL_H
29 #define __OCSECURITYMODEL_H
30
31 #include "OCApi.h"
32
33 namespace OC
34 {
35         /**
36         * @brief        This class provides the required security model to 
37         *                       access a service or a particular resource.
38         */
39         class OCSecurityModel
40         {
41         public:
42                 OCSecurityModel(void);
43
44                 virtual ~OCSecurityModel(void);
45
46                 /**
47                 * @fn   checks the security access
48                 * 
49                 * @param sourceURI - source URI 
50                 * @param destinationURI - destination URI of the resoruce to access 
51                 * @param encryptionLevel - Encryption level
52                 * @param remoteIdentity - remote identity
53                 */
54                 void checkAccess(URI sourceURI, URI destinationURI, int encryptionLevel, int remoteIdentity);
55         };
56 }
57
58 #endif //__OCSECURITYMODEL_H