Package org.apache.sling.feature.scanner
Class Scanner
java.lang.Object
org.apache.sling.feature.scanner.Scanner
The scanner is a service that scans items and provides descriptions for
these. The following items can be scanned individually
- A bundle artifact
- A feature (requires
ExtensionScanner
s) - A framework (requires
FrameworkScanner
s)
-
Constructor Summary
ConstructorsConstructorDescriptionScanner
(org.apache.sling.feature.builder.ArtifactProvider artifactProvider) Create a new scanner and use the service loader to find the scannersScanner
(org.apache.sling.feature.builder.ArtifactProvider artifactProvider, List<ExtensionScanner> extensionScanners, List<FrameworkScanner> frameworkScanners) Create a new scanner -
Method Summary
Modifier and TypeMethodDescriptionScan a frameworkscan
(org.apache.sling.feature.Feature feature) Scan a featurescanBundle
(org.apache.sling.feature.Artifact bundle) Scan a bundle
-
Constructor Details
-
Scanner
public Scanner(org.apache.sling.feature.builder.ArtifactProvider artifactProvider, List<ExtensionScanner> extensionScanners, List<FrameworkScanner> frameworkScanners) throws IOException Create a new scanner- Parameters:
artifactProvider
- The artifact providerextensionScanners
- A list of extension scannersframeworkScanners
- A list of framework scanners- Throws:
IOException
- If something goes wrong
-
Scanner
public Scanner(org.apache.sling.feature.builder.ArtifactProvider artifactProvider) throws IOException Create a new scanner and use the service loader to find the scanners- Parameters:
artifactProvider
- The artifact provider- Throws:
IOException
- If something goes wrong
-
-
Method Details
-
scanBundle
Scan a bundle- Parameters:
bundle
- The bundle artifact- Returns:
- The bundle descriptor
- Throws:
IOException
- If something goes wrong or the provided artifact is not a bundle.
-
scan
Scan a feature- Parameters:
feature
- The feature- Returns:
- The feature descriptor
- Throws:
IOException
- If something goes wrong or a scanner is missing
-
scan
public BundleDescriptor scan(org.apache.sling.feature.ArtifactId framework, Map<String, String> props) throws IOExceptionScan a framework- Parameters:
framework
- The frameworkprops
- framework properties to launch the framework- Returns:
- The framework descriptor
- Throws:
IOException
- If something goes wrong or a scanner is missing
-