org.codice.ddf.catalog.resource.cache

Interface ResourceCache

All Known Implementing Classes:

ResourceCacheImpl

public interface ResourceCache

Interface that defines the operations related to the resource cache.

This code is experimental. While this interface is functional and tested, it may change or be removed in the future.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Metacard metacard) Determines if the resource associated with the Metacard is present in the cache
boolean	contains(Metacard metacard, ResourceRequest resourceRequest) Determines if the resource associated with the Metacard is present in the cache
Optional<Resource>	get(Metacard metacard) Gets the default resource associated with the Metacard provided.
Optional<Resource>	get(Metacard metacard, ResourceRequest resourceRequest) Gets a specific resource associated with the Metacard provided based on the attributes of the ResourceRequest.

Method Detail

get

Optional<Resource> get(Metacard metacard)

Gets the default resource associated with the Metacard provided.

Parameters:

metacard - metacard that corresponds to the resource that was requested

Returns:

resource associated with the Metacard provided, if any

get

Optional<Resource> get(Metacard metacard,
                       ResourceRequest resourceRequest)

Gets a specific resource associated with the Metacard provided based on the attributes of the ResourceRequest.

Parameters:

metacard - metacard that corresponds to the resource that was requested

resourceRequest - request object that was used to retrieve the resource. Will be used to determine the type of resource that will be returned.

Returns:

resource associated with the Metacard provided, if any

contains

boolean contains(Metacard metacard)

Determines if the resource associated with the Metacard is present in the cache

Parameters:

metacard - metacard to use to find a matching resource

Returns:

true only if the default resource associated currently exists in the cache

contains

boolean contains(Metacard metacard,
                 ResourceRequest resourceRequest)

Determines if the resource associated with the Metacard is present in the cache

Parameters:

metacard - metacard to use to find a matching resource

resourceRequest - request object that was used to retrieve the resource. Will be used to determine the type of resource to look up.

Returns:

true only if the resource of the given type associated currently exists in the cache