Package ddf.catalog.util

Interface Maskable

All Superinterfaces:

Describable, org.codice.ddf.platform.services.common.Describable

All Known Subinterfaces:

CatalogProvider, ConnectedSource

public interface Maskable
extends Describable

Used to specify an item whose ID is to be masked when it reports its ID externally, e.g., in a query response. Refer to ConnectedSource for an example of a source that is Maskable.

For example, say DDF is configured to have a site name of "ddf" and a remote source as its catalog provider, and this source has a site name of source-123. Since the catalog provider and DDF are considered a single entity, the site name reported in query results from the source-123 provider will be "ddf" since the remote catalog provider's ID is masked to be DDF's site name.

See Also:

• ConnectedSource

Method Summary

Modifier and Type	Method	Description
void	maskId(String id)	Instructs this source of the id to use when reporting an id externally.

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Method Details

maskId

void maskId(String id)

Instructs this source of the id to use when reporting an id externally. When instructed, the provided ID must be used and can not be overridden.

Parameters:

id - the new id to use