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

Interface EntityFilter<E extends Entity>

All Superinterfaces:

java.lang.Comparable<EntityFilter>

All Known Implementing Classes:

CassandraConnectionFilter, ClusterPropertyFilter, EncassFilter, FolderFilter, IdentityProviderFilter, JDBCConnectionFilter, ListenPortFilter, PolicyBackedServiceFilter, PolicyFilter, PrivateKeyFilter, ServiceFilter, StoredPasswordFilter, TrustedCertificateFilter

public interface EntityFilter<E extends Entity>
extends java.lang.Comparable<EntityFilter>

Method Summary

Modifier and Type	Method	Description
default int	compareTo(@NotNull EntityFilter e)	Compares this entity filter to another entity filter.
java.util.List<E>	filter(java.lang.String folderPath, FilterConfiguration filterConfiguration, Bundle bundle, 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.
static boolean	isDependency(EntityFilter entityFilter, java.util.Collection<java.lang.Class<? extends EntityFilter>> entityFilters)	Checks is the given entity filter depends on an entity filter in the given collection.

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

compareTo

default int compareTo(@NotNull
                      @NotNull EntityFilter e)

Compares this entity filter to another entity filter. Returns 0 if they are the same instance. -1 if this filter is a dependency of the given one. 1 otherwise

Specified by:

compareTo in interface java.lang.Comparable<E extends Entity>

Parameters:

e - The entity filter to compare to

Returns:

0 if they are the same instance. -1 if this filter is a dependency of the given one. 1 otherwise

isDependency

static boolean isDependency(EntityFilter entityFilter,
                            java.util.Collection<java.lang.Class<? extends EntityFilter>> entityFilters)

Checks is the given entity filter depends on an entity filter in the given collection.

Parameters:

entityFilter - The entity filter to check if it is a dependency

entityFilters - The entity filters to scan for dependencies

Returns:

true if the given entity filter is a dependency of the entity filters in the given collection. false otherwise

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,
                         Bundle bundle,
                         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.