summaryrefslogtreecommitdiffstats
path: root/logger_service/server/include/ss_logger_fs_directory.h
blob: 7e8da15cf6bdd79b0e50ae810dc57bc642fae3de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

///////////////////////////////////////////////////////////////////////////////
/// \ingroup  tag_SS_LoggerService
/// \brief    This file contains declaration of class CFSDirectory.
///
///////////////////////////////////////////////////////////////////////////////
#ifndef LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_
#define LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_
#include <native_service/frameworkunified_types.h>
#include<string>

// Class to provide file system directory operations like create,delete etc.
class CFSDirectory {
 public:
  ////////////////////////////////////////////////////////////////////////////////////////////////
  /// CFSDirectory
  /// Constructor of CFSDirectory class
  ///
  /// \param
  ///
  /// \return
  ///
  ////////////////////////////////////////////////////////////////////////////////////////////////
  CFSDirectory();

  ////////////////////////////////////////////////////////////////////////////////////////////////
  /// ~CFSDirectory
  /// Destructor of CFSDirectory class
  ///
  /// \param
  ///
  /// \return
  ///
  ////////////////////////////////////////////////////////////////////////////////////////////////
  ~CFSDirectory();

  ////////////////////////////////////////////////////////////////////////////////////////////
  /// This method is used to check if the directory exists.
  ///
  /// \param [in] f_cDirPath
  ///         std::string - Path of the directory to delete.
  ///
  /// \return status
  ///         EFrameworkunifiedStatus - success or error
  ////////////////////////////////////////////////////////////////////////////////////////////
  static BOOL DoesDirectoryExist(std::string &f_cDirPath);  // NOLINT (runtime/references)

  ////////////////////////////////////////////////////////////////////////////////////////////
  /// This method is used to create a directory.
  ///
  /// \param [in] f_cDirPath
  ///         std::string - Path of the directory to delete.
  ///
  /// \return status
  ///         EFrameworkunifiedStatus - success or error
  ////////////////////////////////////////////////////////////////////////////////////////////
  static EFrameworkunifiedStatus CreateDirectory(std::string &f_cDirPath);  // NOLINT (runtime/references)

  ////////////////////////////////////////////////////////////////////////////////////////////
  /// This method is used to verify directory.
  ///
  /// \param [in] f_cPath
  ///         std::string - Path of the directory to delete.
  ///
  /// \return status
  ///         EFrameworkunifiedStatus - success or error
  ////////////////////////////////////////////////////////////////////////////////////////////
  static BOOL IsDirectory(std::string &f_cPath);  // NOLINT (runtime/references)

  ////////////////////////////////////////////////////////////////////////////////////////////
  /// This method is used to delete directory.
  ///
  /// \param [in] f_cPath
  ///         std::string - Path of the directory to delete.
  ///
  /// \return status
  ///         EFrameworkunifiedStatus - success or error
  ////////////////////////////////////////////////////////////////////////////////////////////
  static BOOL RemoveDirectory(std::string &f_cPath);  // NOLINT (runtime/references)

  ////////////////////////////////////////////////////////////////////////////////////////////
  /// This method is used to delete file in direcotry.
  ///
  /// \param [in] f_cPath
  ///         std::string - Path of the directory to delete.
  ///
  /// \return status
  ///         EFrameworkunifiedStatus - success or error
  ////////////////////////////////////////////////////////////////////////////////////////////
  static BOOL RemoveSubDirectory(std::string &f_cPath);  // NOLINT (runtime/references)
};

#endif  // LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_