Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
CoreExtensionScriptService | 41 | 3 | 0% | 3 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.extension.script; | |
21 | ||
22 | import java.util.Collection; | |
23 | ||
24 | import javax.inject.Inject; | |
25 | import javax.inject.Named; | |
26 | import javax.inject.Singleton; | |
27 | ||
28 | import org.xwiki.component.annotation.Component; | |
29 | import org.xwiki.extension.CoreExtension; | |
30 | import org.xwiki.extension.repository.CoreExtensionRepository; | |
31 | ||
32 | /** | |
33 | * Various script APIs related to core extensions. | |
34 | * | |
35 | * @version $Id: 945d5f6651c4e1d53342e7703e1f55256639e3e3 $ | |
36 | * @since 5.3M1 | |
37 | */ | |
38 | @Component | |
39 | @Named(ExtensionManagerScriptService.ROLEHINT + '.' + CoreExtensionScriptService.ID) | |
40 | @Singleton | |
41 | public class CoreExtensionScriptService extends AbstractExtensionScriptService | |
42 | { | |
43 | /** | |
44 | * The identifier of the sub extension {@link org.xwiki.script.service.ScriptService}. | |
45 | */ | |
46 | public static final String ID = "core"; | |
47 | ||
48 | /** | |
49 | * The repository with core modules provided by the platform. | |
50 | */ | |
51 | @Inject | |
52 | private CoreExtensionRepository coreExtensionRepository; | |
53 | ||
54 | /** | |
55 | * @return the core extensions repository | |
56 | */ | |
57 | 666 | public CoreExtensionRepository getRepository() |
58 | { | |
59 | 666 | return safe(this.coreExtensionRepository); |
60 | } | |
61 | ||
62 | /** | |
63 | * Get a list of core extensions provided by the current version of the platform. | |
64 | * | |
65 | * @return a list of read-only handlers corresponding to the core extensions | |
66 | */ | |
67 | 11 | public Collection<CoreExtension> getCoreExtensions() |
68 | { | |
69 | 11 | return safe(this.coreExtensionRepository.getCoreExtensions()); |
70 | } | |
71 | ||
72 | /** | |
73 | * Get the extension handler corresponding to the given core extension ID. The returned handler can be used to get | |
74 | * more information about the extension, such as the authors, an extension description, its license... | |
75 | * | |
76 | * @param feature the extension id or provided feature (virtual extension) of the extension to resolve | |
77 | * @return the read-only handler corresponding to the requested extension, or {@code null} if the extension isn't | |
78 | * provided by the platform | |
79 | */ | |
80 | 58 | public CoreExtension getCoreExtension(String feature) |
81 | { | |
82 | 58 | return safe(this.coreExtensionRepository.getCoreExtension(feature)); |
83 | } | |
84 | } |