@ThreadSafe public class EntityFilterStage extends BaseIteratingStage<Element>
Modifier and Type | Field and Description |
---|---|
private Collection<String> |
designatedEntities
Entities which are white/black listed depending on the value of
whitelistingEntities . |
private Logger |
log
Class logger.
|
private boolean |
removingEntitylessEntitiesDescriptor
Whether EntitiesDescriptor that do not contain EntityDescriptors should be removed.
|
private boolean |
whitelistingEntities
Whether
designatedEntities should be considered a whitelist or a blacklist. |
Constructor and Description |
---|
EntityFilterStage() |
Modifier and Type | Method and Description |
---|---|
protected void |
doDestroy() |
protected boolean |
doExecute(Item<Element> item)
Processes a given Item.
|
Collection<String> |
getDesignatedEntities()
Gets the list of designated entity IDs.
|
boolean |
isRemovingEntitylessEntitiesDescriptor()
Gets whether EntitiesDescriptor that do not contain EntityDescriptors should be removed.
|
boolean |
isWhitelistingEntities()
Whether the list of designated entities should be considered a whitelist.
|
protected boolean |
processEntitiesDescriptor(Element entitiesDescriptor)
Iterates over all child EntitiesDescriptor, passing each to
processEntitiesDescriptor(Element) , and
EntityDescriptor, passing each to processEntityDescriptor(Element) . |
protected boolean |
processEntityDescriptor(Element entityDescriptor)
Filters the given entity descriptor.
|
void |
setDesignatedEntities(Collection<String> ids)
Sets the list of designated entity IDs.
|
void |
setRemovingEntitylessEntitiesDescriptor(boolean remove)
Sets whether EntitiesDescriptor that do not contain EntityDescriptors should be removed.
|
void |
setWhitelistingEntities(boolean whitelisting)
Sets whether the list of designated entities should be considered a whitelist.
|
doExecute
execute, getCollectionPredicate, setCollectionPredicate
setId
doInitialize, getId
destroy, initialize, isDestroyed, isInitialized
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
destroy, isDestroyed
private final Logger log
private Collection<String> designatedEntities
whitelistingEntities
.private boolean whitelistingEntities
designatedEntities
should be considered a whitelist or a blacklist. Default value: falseprivate boolean removingEntitylessEntitiesDescriptor
@Nonnull @NonnullElements @Unmodifiable public Collection<String> getDesignatedEntities()
public void setDesignatedEntities(@Nullable@NullableElements Collection<String> ids)
ids
- list of designated entity IDspublic boolean isWhitelistingEntities()
public void setWhitelistingEntities(boolean whitelisting)
whitelisting
- true if the designated entities should be considered a whitelist, false otherwisepublic boolean isRemovingEntitylessEntitiesDescriptor()
public void setRemovingEntitylessEntitiesDescriptor(boolean remove)
remove
- whether EntitiesDescriptor that do not contain EntityDescriptors should be removedprotected void doDestroy()
doDestroy
in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
protected boolean doExecute(@Nonnull Item<Element> item)
doExecute
in class BaseIteratingStage<Element>
item
- Item on which to operateprotected boolean processEntitiesDescriptor(@Nonnull Element entitiesDescriptor)
processEntitiesDescriptor(Element)
, and
EntityDescriptor, passing each to processEntityDescriptor(Element)
. If
isRemovingEntitylessEntitiesDescriptor()
is true and the EntitiesDescriptor contains no child
EntitiesDescriptors or EntityDescriptors it is removed.entitiesDescriptor
- EntitiesDescriptor being processedCopyright © 1999–2016. All rights reserved.