Package org.gcube.application.cms.sdi.plugins

Class SDIIndexerPlugin

  • All Implemented Interfaces:
    org.gcube.application.cms.plugins.IndexerPluginInterface, org.gcube.application.cms.plugins.InitializablePlugin, org.gcube.application.cms.plugins.Plugin
    public class SDIIndexerPlugin
extends SDIAbstractPlugin
implements org.gcube.application.cms.plugins.IndexerPluginInterface
    The Class SDIIndexerPlugin.
    Author:
    created by Fabio Sinibaldi, new architect and maintainer - Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it Apr 28, 2023

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.gcube.application.cms.plugins.reports.IndexDocumentReport deindex​(org.gcube.application.cms.plugins.requests.IndexDocumentRequest request)
      Deindex.
      org.gcube.application.geoportal.common.model.plugins.PluginDescriptor getDescriptor()
      Gets the descriptor.
      org.gcube.application.geoportal.common.model.configuration.Index getIndex​(org.gcube.application.cms.plugins.requests.BaseRequest request)
      Expected parameters : workspace indexName.
      org.gcube.application.cms.plugins.reports.IndexDocumentReport index​(org.gcube.application.cms.plugins.requests.IndexDocumentRequest request)
      Expected parameters : - indexName (unique) - workspace - flagInternalIndex as Boolean; boolean - centroidRecord (OPT).
      org.gcube.application.cms.plugins.reports.InitializationReport initInContext()
      Inits the in context.

      • Methods inherited from class org.gcube.application.cms.plugins.implementations.AbstractPlugin

        getConfigurationFromProfile, getMultipleDeclarationsFromProfile

      • Methods inherited from interface org.gcube.application.cms.plugins.InitializablePlugin

        init, shutdown

    • Constructor Detail

      • SDIIndexerPlugin

        public SDIIndexerPlugin()

    • Method Detail

      • getDescriptor

        public org.gcube.application.geoportal.common.model.plugins.PluginDescriptor getDescriptor()
        Gets the descriptor.
        Specified by:
        getDescriptor in interface org.gcube.application.cms.plugins.Plugin
        Returns:
        the descriptor

      • initInContext

        public org.gcube.application.cms.plugins.reports.InitializationReport initInContext()
                                                                             throws org.gcube.application.cms.plugins.faults.InitializationException
        Inits the in context.
        Specified by:
        initInContext in interface org.gcube.application.cms.plugins.InitializablePlugin
        Returns:
        the initialization report
        Throws:
        org.gcube.application.cms.plugins.faults.InitializationException - the initialization exception

      • index

        public org.gcube.application.cms.plugins.reports.IndexDocumentReport index​(org.gcube.application.cms.plugins.requests.IndexDocumentRequest request)
                                                                    throws org.gcube.application.cms.plugins.faults.InvalidPluginRequestException
        Expected parameters : - indexName (unique) - workspace - flagInternalIndex as Boolean; boolean - centroidRecord (OPT).
        Specified by:
        index in interface org.gcube.application.cms.plugins.IndexerPluginInterface
        Parameters:
        request - the request
        Returns:
        the index document report
        Throws:
        org.gcube.application.cms.plugins.faults.InvalidPluginRequestException - the invalid plugin request exception

      • deindex

        public org.gcube.application.cms.plugins.reports.IndexDocumentReport deindex​(org.gcube.application.cms.plugins.requests.IndexDocumentRequest request)
                                                                      throws org.gcube.application.cms.plugins.faults.InvalidPluginRequestException
        Deindex.
        Specified by:
        deindex in interface org.gcube.application.cms.plugins.IndexerPluginInterface
        Parameters:
        request - the request
        Returns:
        the index document report
        Throws:
        org.gcube.application.cms.plugins.faults.InvalidPluginRequestException - the invalid plugin request exception

      • getIndex

        public org.gcube.application.geoportal.common.model.configuration.Index getIndex​(org.gcube.application.cms.plugins.requests.BaseRequest request)
                                                                          throws org.gcube.application.geoportal.common.model.rest.ConfigurationException
        Expected parameters : workspace indexName.
        Specified by:
        getIndex in interface org.gcube.application.cms.plugins.IndexerPluginInterface
        Parameters:
        request - the request
        Returns:
        the index
        Throws:
        org.gcube.application.geoportal.common.model.rest.ConfigurationException - the configuration exception