com.capitalone.dashboard.service.CollectorService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core package shared by API layer and Microservices
There is a newer version: 4.0.2
package com.capitalone.dashboard.service;

import com.capitalone.dashboard.misc.HygieiaException;
import com.capitalone.dashboard.model.Cmdb;
import com.capitalone.dashboard.model.Collector;
import com.capitalone.dashboard.model.CollectorItem;
import com.capitalone.dashboard.model.CollectorType;
import org.bson.types.ObjectId;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

import java.util.List;
import java.util.Map;
import java.util.Set;

public interface CollectorService {

    /**
     * Fetches all collectors, sorted by name
     *
     * @return all collectors
     */
     Iterable all();

    /**
     * Finds all Collectors of a given type.
     *
     * @param collectorType collector type
     * @return Collectors matching the specified type
     */
     List  collectorsByType(CollectorType collectorType);


    /**
     * Finds all Collectors of given id
     *
     * @param id
     * @return Collectors matching the specified type
     */
     List collectorsById(ObjectId id);

    /**
     * Finds paged results of CollectorItems of a given type.
     *
     * @param collectorType collector type
     * @param {@link org.springframework.data.domain.Pageable} object to determine which page to return
     * @return CollectorItems matching the specified type
     */
     Page collectorItemsByTypeWithFilter(CollectorType collectorType, String descriptionFilter, Pageable pageable);

    /**
     * Finds paged results of CollectorItems of a given type.
     *
     * @param collectorType collector type and search field
     * @param descriptionFilter search value
     * @param searchField search field
     * @param pageable pageable
     * @return CollectorItems matching the specified type
     */
     Page collectorItemsByTypeWithFilter(CollectorType collectorType, String descriptionFilter, String searchField,Pageable pageable);

    /**
     * Find a CollectorItem by it's id.
     *
     * @param id id
     * @return CollectorItem
     */
     CollectorItem getCollectorItem(ObjectId id) throws HygieiaException;

    /**
     * Creates a new CollectorItem. If a CollectorItem already exists with the
     * same collector id and options, that CollectorItem will be returned instead
     * of creating a new CollectorItem.
     *
     * @param item CollectorItem to create
     * @return created CollectorItem
     */
     CollectorItem createCollectorItem(CollectorItem item);

    /**
     * Creates a new CollectorItem. If a CollectorItem already exists with the
     * same collector id and niceName, that CollectorItem will be returned instead
     * of creating a new CollectorItem.
     *
     * @param item CollectorItem to create
     * @return created CollectorItem
     */
     CollectorItem createCollectorItemByNiceNameAndJobName(CollectorItem item, String jobName) throws HygieiaException;


    // This is to handle scenarios where the option contains user credentials etc. We do not want to create a new collector item -
    // just update the new credentials.
     CollectorItem createCollectorItemSelectOptions(CollectorItem item, Map allOptions, Map selectOptions);
     CollectorItem createCollectorItemSelectOptions(CollectorItem item, Collector collector, Map allOptions, Map selectOptions);


    /**
     * Creates a new CollectorItem. If a CollectorItem already exists with the
     * same collector id and niceName, that CollectorItem will be returned instead
     * of creating a new CollectorItem.
     *
     * @param item CollectorItem to create
     * @return created CollectorItem
     */
     CollectorItem createCollectorItemByNiceNameAndProjectId(CollectorItem item, String projectId) throws HygieiaException;

    /**
     * Creates a new Collector.
     * @param collector Collector to create
     * @return created Collector
     */
     Collector createCollector(Collector collector);

    /**
     * Gets a list of collectorItems for a given component id
     * @param id id
     * @return List of collectorItems
     */
     List getCollectorItemForComponent (String id, String type);

    /**
     * Delete CollectorItem and remove association from component.
     * @param id
     * @param deleteFromComponent
     */
     void deleteCollectorItem(String id, boolean deleteFromComponent) throws HygieiaException;

    /**
     * Delete properties section of Collector
     * @param id
     */
     void deletePropertiesInCollectorById(String id);

    /**
     * Get cmdb of static analysis project
     */
     Set getCmdbByStaticAnalysis(String collectorName, String projectName) throws HygieiaException;
}