xref: /aosp_15_r20/system/apex/apexd/apex_classpath.h (revision 33f3758387333dbd2962d7edbd98681940d895da)
1*33f37583SAndroid Build Coastguard Worker /*
2*33f37583SAndroid Build Coastguard Worker  * Copyright (C) 2021 The Android Open Source Project
3*33f37583SAndroid Build Coastguard Worker  *
4*33f37583SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*33f37583SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*33f37583SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*33f37583SAndroid Build Coastguard Worker  *
8*33f37583SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*33f37583SAndroid Build Coastguard Worker  *
10*33f37583SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*33f37583SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*33f37583SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*33f37583SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*33f37583SAndroid Build Coastguard Worker  * limitations under the License.
15*33f37583SAndroid Build Coastguard Worker  */
16*33f37583SAndroid Build Coastguard Worker 
17*33f37583SAndroid Build Coastguard Worker #ifndef ANDROID_APEXD_APEX_CLASSPATH_H_
18*33f37583SAndroid Build Coastguard Worker #define ANDROID_APEXD_APEX_CLASSPATH_H_
19*33f37583SAndroid Build Coastguard Worker 
20*33f37583SAndroid Build Coastguard Worker #include <android-base/result.h>
21*33f37583SAndroid Build Coastguard Worker 
22*33f37583SAndroid Build Coastguard Worker #include <set>
23*33f37583SAndroid Build Coastguard Worker #include <string>
24*33f37583SAndroid Build Coastguard Worker 
25*33f37583SAndroid Build Coastguard Worker namespace android {
26*33f37583SAndroid Build Coastguard Worker namespace apex {
27*33f37583SAndroid Build Coastguard Worker 
28*33f37583SAndroid Build Coastguard Worker /**
29*33f37583SAndroid Build Coastguard Worker  * An utility class that contains logic to extract classpath fragments
30*33f37583SAndroid Build Coastguard Worker  * information from mounted APEX.
31*33f37583SAndroid Build Coastguard Worker  *
32*33f37583SAndroid Build Coastguard Worker  * The bulk of the work is done by derive_classpath binary, which is found
33*33f37583SAndroid Build Coastguard Worker  * inside sdkext module. This class is a wrapper for calling that binary and
34*33f37583SAndroid Build Coastguard Worker  * parsing its string output into a structured object.
35*33f37583SAndroid Build Coastguard Worker  */
36*33f37583SAndroid Build Coastguard Worker class ClassPath {
37*33f37583SAndroid Build Coastguard Worker   static constexpr const char* kSdkExtModuleName = "com.android.sdkext";
38*33f37583SAndroid Build Coastguard Worker 
39*33f37583SAndroid Build Coastguard Worker  public:
40*33f37583SAndroid Build Coastguard Worker   static android::base::Result<ClassPath> DeriveClassPath(
41*33f37583SAndroid Build Coastguard Worker       const std::vector<std::string>& temp_mounted_apex_paths,
42*33f37583SAndroid Build Coastguard Worker       const std::string& sdkext_module_name = kSdkExtModuleName);
43*33f37583SAndroid Build Coastguard Worker 
44*33f37583SAndroid Build Coastguard Worker   bool HasClassPathJars(const std::string& package);
45*33f37583SAndroid Build Coastguard Worker 
46*33f37583SAndroid Build Coastguard Worker   // Exposed for testing only
47*33f37583SAndroid Build Coastguard Worker   static android::base::Result<ClassPath> ParseFromFile(
48*33f37583SAndroid Build Coastguard Worker       const std::string& file_path);
49*33f37583SAndroid Build Coastguard Worker 
50*33f37583SAndroid Build Coastguard Worker  private:
51*33f37583SAndroid Build Coastguard Worker   void AddPackageWithClasspathJars(const std::string& package);
52*33f37583SAndroid Build Coastguard Worker 
53*33f37583SAndroid Build Coastguard Worker   std::set<std::string> packages_with_classpath_jars;
54*33f37583SAndroid Build Coastguard Worker };
55*33f37583SAndroid Build Coastguard Worker 
56*33f37583SAndroid Build Coastguard Worker }  // namespace apex
57*33f37583SAndroid Build Coastguard Worker }  // namespace android
58*33f37583SAndroid Build Coastguard Worker 
59*33f37583SAndroid Build Coastguard Worker #endif  // ANDROID_APEXD_APEXD_CHECKPOINT_H_
60