Package org.apache.maven.index.creator

Class OsgiArtifactIndexCreator

java.lang.Object
org.apache.maven.index.creator.AbstractIndexCreator
org.apache.maven.index.creator.OsgiArtifactIndexCreator
All Implemented Interfaces:
IndexCreator
@Singleton @Named("osgi-metadatas") public class OsgiArtifactIndexCreator extends AbstractIndexCreator
This indexCreator will index some OSGI metadatas.
All jars are indexed and not only the ones with packaging bundle.

OSGI metadatas indexed :

  • Bundle-SymbolicName
  • Bundle-Version
  • Export-Package
  • Export-Service

Since:
4.1.2
Author:
Olivier Lamy

  • Field Details

    • ID

      public static final String ID
      See Also:

    • FLD_SHA256

      public static final IndexerField FLD_SHA256

    • FLD_BUNDLE_SYMBOLIC_NAME

      public static final IndexerField FLD_BUNDLE_SYMBOLIC_NAME

    • FLD_BUNDLE_VERSION

      public static final IndexerField FLD_BUNDLE_VERSION

    • FLD_BUNDLE_EXPORT_PACKAGE

      public static final IndexerField FLD_BUNDLE_EXPORT_PACKAGE

    • FLD_BUNDLE_EXPORT_SERVIVE

      @Deprecated public static final IndexerField FLD_BUNDLE_EXPORT_SERVIVE
      Deprecated.

    • FLD_BUNDLE_DESCRIPTION

      public static final IndexerField FLD_BUNDLE_DESCRIPTION

    • FLD_BUNDLE_NAME

      public static final IndexerField FLD_BUNDLE_NAME

    • FLD_BUNDLE_LICENSE

      public static final IndexerField FLD_BUNDLE_LICENSE

    • FLD_BUNDLE_DOCURL

      public static final IndexerField FLD_BUNDLE_DOCURL

    • FLD_BUNDLE_IMPORT_PACKAGE

      public static final IndexerField FLD_BUNDLE_IMPORT_PACKAGE

    • FLD_BUNDLE_REQUIRE_BUNDLE

      public static final IndexerField FLD_BUNDLE_REQUIRE_BUNDLE

    • FLD_BUNDLE_PROVIDE_CAPABILITY

      public static final IndexerField FLD_BUNDLE_PROVIDE_CAPABILITY

    • FLD_BUNDLE_REQUIRE_CAPABILITY

      public static final IndexerField FLD_BUNDLE_REQUIRE_CAPABILITY

    • FLD_BUNDLE_FRAGMENT_HOST

      public static final IndexerField FLD_BUNDLE_FRAGMENT_HOST

    • FLD_BUNDLE_REQUIRED_EXECUTION_ENVIRONMENT

      public static final IndexerField FLD_BUNDLE_REQUIRED_EXECUTION_ENVIRONMENT

  • Constructor Details

    • OsgiArtifactIndexCreator

      public OsgiArtifactIndexCreator()

  • Method Details

    • getIndexerFields

      public Collection<IndexerField> getIndexerFields()
      Description copied from interface: IndexCreator
      Returns the indexer fields that this IndexCreator introduces to index.
      Returns:

    • populateArtifactInfo

      public void populateArtifactInfo(ArtifactContext artifactContext) throws IOException
      Description copied from interface: IndexCreator
      Populate an ArtifactContext with information about corresponding artifact.
      Throws:
      IOException

    • updateDocument

      public void updateDocument(ArtifactInfo artifactInfo, org.apache.lucene.document.Document document)
      Description copied from interface: IndexCreator
      Update Lucene Document from a given ArtifactInfo.

    • updateArtifactInfo

      public boolean updateArtifactInfo(org.apache.lucene.document.Document document, ArtifactInfo artifactInfo)
      Description copied from interface: IndexCreator
      Update an ArtifactInfo from given Lucene Document.
      Returns:
      true is artifact info has been updated

    • toString

      public String toString()
      Overrides:
      toString in class Object