org.apache.sling.feature.scanner

Class Scanner

java.lang.Object

org.apache.sling.feature.scanner.Scanner

public class Scanner
extends Object

The scanner is a service that scans items and provides descriptions for these. The following items can be scanned individually

• A bundle artifact
• An extension (requires ExtensionScanners)
• A feature (requires ExtensionScanners)
• A framework (requires FrameworkScanners)
• An application (requires all scanner types)

Constructor Summary

Constructors

Constructor and Description
Scanner(org.apache.sling.feature.io.ArtifactManagerConfig amConfig) Create a new scanner and use the service loader to find the scanners
Scanner(org.apache.sling.feature.io.ArtifactManagerConfig amConfig, List<ExtensionScanner> extensionScanners, List<FrameworkScanner> frameworkScanners) Create a new scanner

Method Summary

Modifier and Type	Method and Description
ApplicationDescriptor	scan(org.apache.sling.feature.Application app) Scan an application
BundleDescriptor	scan(org.apache.sling.feature.Artifact bundle, int startLevel) Scan a bundle
FeatureDescriptor	scan(org.apache.sling.feature.Feature feature) Scan a feature

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scanner

public Scanner(org.apache.sling.feature.io.ArtifactManagerConfig amConfig,
               List<ExtensionScanner> extensionScanners,
               List<FrameworkScanner> frameworkScanners)
        throws IOException

Create a new scanner

Parameters:

amConfig - The artifact manager configuration

extensionScanners - A list of extension scanners

frameworkScanners - A list of framework scanners

Throws:

IOException - If something goes wrong

Scanner

public Scanner(org.apache.sling.feature.io.ArtifactManagerConfig amConfig)
        throws IOException

Create a new scanner and use the service loader to find the scanners

Parameters:

amConfig - The artifact manager configuration

Throws:

IOException - If something goes wrong

Method Detail

scan

public BundleDescriptor scan(org.apache.sling.feature.Artifact bundle,
                             int startLevel)
                      throws IOException

Scan a bundle

Parameters:

bundle - The bundle artifact

startLevel - The start level of the bundle

Returns:

The bundle descriptor

Throws:

IOException - If something goes wrong or the provided artifact is not a bundle.

scan

public FeatureDescriptor scan(org.apache.sling.feature.Feature feature)
                       throws IOException

Scan a feature

Parameters:

feature - The feature

Returns:

The feature descriptor

Throws:

IOException - If something goes wrong or a scanner is missing

scan

public ApplicationDescriptor scan(org.apache.sling.feature.Application app)
                           throws IOException

Scan an application

Parameters:

app - The application

Returns:

The application descriptor

Throws:

IOException - If something goes wrong or a scanner is missing