net.shibboleth.metadata

Class AbstractCompositeItemIdentificationStrategy

java.lang.Object

net.shibboleth.metadata.AbstractCompositeItemIdentificationStrategy

All Implemented Interfaces:

ItemIdentificationStrategy

Direct Known Subclasses:

FirstItemIdItemIdentificationStrategy

@ThreadSafe
public abstract class AbstractCompositeItemIdentificationStrategy
extends Object
implements ItemIdentificationStrategy

Abstract class implementing a generic two-part strategy for item identification. Generating the two components of the identifier is delegated to subclasses. The basic and extra identifiers are then combined into a composite identifier for display. If the basic identifier is null, a configured default is used. If the extra identifier is null, only the basic identifier is used.

Field Summary

Fields

Modifier and Type	Field and Description
private String	noItemIdIdentifier Identifier to use if an Item does not have an ItemId.

Constructor Summary

Constructors

Constructor and Description
AbstractCompositeItemIdentificationStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) abstract String	getBasicIdentifier(Item<?> item) Get a basic identifier for the Item.
(package private) abstract String	getExtraIdentifier(Item<?> item) Get an extra identifier for the Item.
String	getItemIdentifier(Item<?> item) Gets an identifier for the item.
String	getNoItemIdIdentifier() Gets the identifier to use if an Item does not have an ItemId.
void	setNoItemIdIdentifier(String identifier) Sets the identifier to use if an Item does not have an ItemId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

noItemIdIdentifier

private String noItemIdIdentifier

Identifier to use if an Item does not have an ItemId. Default value: "unidentified"

Constructor Detail

AbstractCompositeItemIdentificationStrategy

public AbstractCompositeItemIdentificationStrategy()

Method Detail

getNoItemIdIdentifier

public String getNoItemIdIdentifier()

Gets the identifier to use if an Item does not have an ItemId.

Returns:

identifier to use if an Item does not have an ItemId

setNoItemIdIdentifier

public void setNoItemIdIdentifier(@Nonnull@NotEmpty
                         String identifier)

Sets the identifier to use if an Item does not have an ItemId.

Parameters:

identifier - identifier to use if an Item does not have an ItemId

getBasicIdentifier

@Nullable
abstract String getBasicIdentifier(@Nonnull
                                 Item<?> item)

Get a basic identifier for the Item.

Parameters:

item - Item to extract a basic identifier from

Returns:

a basic identifier for the Item, or null

getExtraIdentifier

@Nullable
abstract String getExtraIdentifier(@Nonnull
                                 Item<?> item)

Get an extra identifier for the Item.

Parameters:

item - Item to extract an extra identifier from

Returns:

an extra identifier for the Item, or null

getItemIdentifier

@Nonnull
public String getItemIdentifier(@Nonnull
                               Item<?> item)

Description copied from interface: ItemIdentificationStrategy

Gets an identifier for the item.

Specified by:

getItemIdentifier in interface ItemIdentificationStrategy

Parameters:

item - the item

Returns:

the identifier, never null