com.ca.apim.gateway.cagatewayexport.tasks.explode.filter

Interface EntityFilter<E extends com.ca.apim.gateway.cagatewayconfig.beans.GatewayEntity>

All Known Implementing Classes:

CassandraConnectionFilter, ClusterPropertyFilter, EncassFilter, FolderFilter, GenericEntityFilter, IdentityProviderFilter, JDBCConnectionFilter, JmsDestinationFilter, ListenPortFilter, PolicyBackedServiceFilter, PolicyFilter, PrivateKeyFilter, ScheduledTaskFilter, ServiceFilter, SsgActiveConnectorFilter, StoredPasswordFilter, TrustedCertificateFilter, UnsupportedEntityFilter

public interface EntityFilter<E extends com.ca.apim.gateway.cagatewayconfig.beans.GatewayEntity>

Method Summary

Modifier and Type	Method and Description
java.util.List<E>	filter(java.lang.String folderPath, FilterConfiguration filterConfiguration, com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle, com.ca.apim.gateway.cagatewayconfig.beans.Bundle filteredBundle) Filters entities in the bundle and returns the list of filtered entities.
@NotNull java.util.Collection<java.lang.Class<? extends EntityFilter>>	getDependencyEntityFilters()
static EntityFilter	getEntityFilterFromClass(java.lang.Class<? extends EntityFilter> filterClass) Loads an instance of an entity filter of the given class type.
default java.lang.String	getFilterableEntityName() The filterable entity name.

Method Detail

getDependencyEntityFilters

@NotNull
@NotNull java.util.Collection<java.lang.Class<? extends EntityFilter>> getDependencyEntityFilters()

Returns:

the position of the entity filter, has to be non null and not conflicting

getEntityFilterFromClass

static EntityFilter getEntityFilterFromClass(java.lang.Class<? extends EntityFilter> filterClass)

Loads an instance of an entity filter of the given class type.

Parameters:

filterClass - The entity filter class

Returns:

an instance of the entity filter

filter

java.util.List<E> filter(java.lang.String folderPath,
                         FilterConfiguration filterConfiguration,
                         com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle,
                         com.ca.apim.gateway.cagatewayconfig.beans.Bundle filteredBundle)

Filters entities in the bundle and returns the list of filtered entities. Filtered entities are entities that are meant to be kept.

Parameters:

folderPath - The folder path that will be filtered

filterConfiguration - This is the filter configuration.

bundle - The bundle to filter entities from

filteredBundle - The filtered bundle containing already filtered entities.

Returns:

The list of entities filtered from the bundle

getFilterableEntityName

default java.lang.String getFilterableEntityName()

The filterable entity name. This is used to validate the filter configuration only container filterable configurations

Returns:

The name of the filterable entity. The empty string if it isn't filterable from a filter configuration.