Package de.hybris.platform.util

Class StrandedItemsRegistry.StrandedItemsResolutionHandler<T>

java.lang.Object

de.hybris.platform.util.StrandedItemsRegistry.StrandedItemsResolutionHandler<T>

Direct Known Subclasses:

CronJobManager.DefaultStrandedCronJobsResolutionHandler, StrandedItemsRegistryTest.TestStrandedItemsResolutionHandler

Enclosing class:

StrandedItemsRegistry

public abstract static class StrandedItemsRegistry.StrandedItemsResolutionHandler<T>
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
StrandedItemsResolutionHandler()

Method Summary

Modifier and Type	Method	Description
abstract java.util.List<T>	filterItemsToResolve(java.util.Set<PK> itemsToResolve, StrandedItemsRegistry.StrandedItemContextProvider contextProvider)	The method to filter the items that are marked as stranded and should be resolved.
abstract PK	getItemPk(T item)	Method to obtain the PK of item returned by filterItemsToResolve(Set, StrandedItemContextProvider)
abstract java.util.Set<PK>	resolveStrandedItems(java.util.List<T> itemsToResolve, StrandedItemsRegistry.StrandedItemContextProvider contextProvider)	The method to resolve the stranded items.

Methods inherited from class java.lang.Object

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

Constructor Detail

StrandedItemsResolutionHandler

public StrandedItemsResolutionHandler()

Method Detail

getItemPk

public abstract PK getItemPk(T item)

Method to obtain the PK of item returned by filterItemsToResolve(Set, StrandedItemContextProvider)

Parameters:

item -

Returns:

filterItemsToResolve

public abstract java.util.List<T> filterItemsToResolve(java.util.Set<PK> itemsToResolve,
                                                       StrandedItemsRegistry.StrandedItemContextProvider contextProvider)

The method to filter the items that are marked as stranded and should be resolved. The items that are marked as stranded and should not be resolved (ex. other mechanism has resolved the problem or the marking was too excessive) should be filtered out (should not be returned in a result of this method's invocation).

Parameters:

itemsToResolve - items to check whether indeed should be resolved

contextProvider - the context provided that can be used to get additional data for given item (if provided when marking the item as stranded)

Returns:

the items that should be resolved. The items passed in itemsToResolve and not returned by this method will be marked as checked (removed from stranded items registry)

resolveStrandedItems

public abstract java.util.Set<PK> resolveStrandedItems(java.util.List<T> itemsToResolve,
                                                       StrandedItemsRegistry.StrandedItemContextProvider contextProvider)

The method to resolve the stranded items.

Parameters:

itemsToResolve - items to resolve

contextProvider - the context provided that can be used to get additional data for given item (if provided when marking the item as stranded)

Returns:

the collection of items' PKs that has been successfully resolved. The items returned by this method wiil be marked as checked (removed from stranded items registry). The items not retuned by this method but passed in itemsToResolve will NOT be removed from stranded items registry and could be checked again during one of next executions of this method.