org.codice.ddf.registry.federationadmin.service.internal

Interface FederationAdminService

All Known Implementing Classes:

FederationAdminServiceImpl

public interface FederationAdminService

Service that provides the interface to get and add registry metacards This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
List<String>	addRegistryEntries(List<Metacard> metacards, Set<String> destinations) Add the given metacards to the registry catalog with the provided destinations
String	addRegistryEntry(Metacard metacard) Add the given metacard to the registry catalog
String	addRegistryEntry(Metacard metacard, Set<String> destinations) Add the given metacard to the registry catalog with the provided destinations
String	addRegistryEntry(String xml) Add a registry metacard entry for the xml string provided.
String	addRegistryEntry(String xml, Set<String> destinations) Add a registry metacard entry for the xml string provided.
void	deleteRegistryEntriesByMetacardIds(List<String> metacardIds) * Deletes the registry entry from the registry catalog for each of the provided metacard ids.
void	deleteRegistryEntriesByMetacardIds(List<String> metacardIds, Set<String> destinations) * Deletes the registry entry from the registry catalog for each of the provided metacard ids.
void	deleteRegistryEntriesByRegistryIds(List<String> registryIds) * Deletes the registry entry from the registry catalog for each of the provided registry ids.
void	deleteRegistryEntriesByRegistryIds(List<String> registryIds, Set<String> destinations) Deletes the registry entry from the registry catalog for each of the provided registry ids.
List<Metacard>	getInternalRegistryMetacards() Get a list of internal registry metacards.
List<Metacard>	getInternalRegistryMetacardsByRegistryId(String registryId) Gets a list of internal registry metacards with the matching registry-id
Optional<Metacard>	getLocalRegistryIdentityMetacard() Returns the identity metacard for the local registry node.
List<Metacard>	getLocalRegistryMetacards() Get a list of local registry metacards
List<Metacard>	getLocalRegistryMetacardsByRegistryIds(List<String> ids) Get a list of local registry metacards with the provided registry ids.
List<RegistryPackageType>	getLocalRegistryObjects() Get a list of local registry objects
List<Metacard>	getRegistryMetacards() Get a list of registry metacards
List<Metacard>	getRegistryMetacards(Set<String> destinations) Get a list of registry metacards
List<Metacard>	getRegistryMetacardsByRegistryIds(List<String> ids) Get a list of registry metacards with the provided registry ids.
List<Metacard>	getRegistryMetacardsByRegistryIds(List<String> ids, boolean includeInternal) Get a list of registry metacards with the provided registry ids.
RegistryPackageType	getRegistryObjectByRegistryId(String registryId) Get a registry object by registry id
RegistryPackageType	getRegistryObjectByRegistryId(String registryId, Set<String> sourceIds) Get a registry object by registry id providing a list of source ids to be queried
List<RegistryPackageType>	getRegistryObjects() Get a list of all registry objects
void	updateRegistryEntry(Metacard metacard) * Write the provided metacard to the registry catalog.
void	updateRegistryEntry(Metacard metacard, Set<String> destinations) Write the provided metacard to the registry catalog.
void	updateRegistryEntry(String xml) Update a registry metacard for the xml string provided.
void	updateRegistryEntry(String xml, Set<String> destinations) Update a registry metacard for the xml string provided.

Method Detail

addRegistryEntry

String addRegistryEntry(String xml)
                 throws FederationAdminException

Add a registry metacard entry for the xml string provided. Converts the string to a registry metacard using the RegistryTransformer.

Parameters:

xml - String representation of a registry package xml

Returns:

Id of the created metacard

Throws:

FederationAdminException - If the xml string is blank. If an exception is thrown from the registryTransformer. The CatalogFramework throws an exception trying to the metacard.

addRegistryEntry

String addRegistryEntry(String xml,
                        Set<String> destinations)
                 throws FederationAdminException

Add a registry metacard entry for the xml string provided. Converts the string to a registry metacard using the RegistryTransformer.

Parameters:

xml - String representation of a registry package xml

destinations - Set of destinations to add

Returns:

Id of the created metacard

Throws:

FederationAdminException - If the xml string is blank. If an exception is thrown from the registryTransformer. The CatalogFramework throws an exception trying to add the metacard.

addRegistryEntry

String addRegistryEntry(Metacard metacard)
                 throws FederationAdminException

Add the given metacard to the registry catalog

Parameters:

metacard - Metacard to be stored

Returns:

Id of the created metacard

Throws:

FederationAdminException - If the metacard provided was null. The CatalogFramework.create call throws IngestException or SourceUnavailableException

addRegistryEntry

String addRegistryEntry(Metacard metacard,
                        Set<String> destinations)
                 throws FederationAdminException

Add the given metacard to the registry catalog with the provided destinations

Parameters:

metacard - Metacard to be stored

destinations - Set of destinations to add

Returns:

Id of the created metacard

Throws:

FederationAdminException - If the metacard provided was null. The CatalogFramework.create call throws IngestException or SourceUnavailableException

addRegistryEntries

List<String> addRegistryEntries(List<Metacard> metacards,
                                Set<String> destinations)
                         throws FederationAdminException

Add the given metacards to the registry catalog with the provided destinations

Parameters:

metacards - Metacards to be stored

destinations - Set of destinations to add

Returns:

List of Id's for the created metacards

Throws:

FederationAdminException - If the metacard provided was null. The CatalogFramework.create call throws IngestException or SourceUnavailableException

deleteRegistryEntriesByRegistryIds

void deleteRegistryEntriesByRegistryIds(List<String> registryIds)
                                 throws FederationAdminException

* Deletes the registry entry from the registry catalog for each of the provided registry ids.

Parameters:

registryIds - The list of registry ids to be deleted.

Throws:

FederationAdminException - If the list of ids provided is empty. If IngestException or Source UnavailableException was thrown by CatalogFramework.delete

deleteRegistryEntriesByRegistryIds

void deleteRegistryEntriesByRegistryIds(List<String> registryIds,
                                        Set<String> destinations)
                                 throws FederationAdminException

Deletes the registry entry from the registry catalog for each of the provided registry ids. A set of destinations is sent in the delete request

Parameters:

registryIds - The list of registry ids to be deleted.

destinations - Set of destinations to add

Throws:

FederationAdminException - If the list of ids provided is empty. If IngestException or Source UnavailableException was thrown by CatalogFramework.delete

deleteRegistryEntriesByMetacardIds

void deleteRegistryEntriesByMetacardIds(List<String> metacardIds)
                                 throws FederationAdminException

* Deletes the registry entry from the registry catalog for each of the provided metacard ids.

Parameters:

metacardIds - The list of metacard ids to be deleted.

Throws:

FederationAdminException - If the list of ids provided is empty. If IngestException or Source UnavailableException was thrown by CatalogFramework.delete

deleteRegistryEntriesByMetacardIds

void deleteRegistryEntriesByMetacardIds(List<String> metacardIds,
                                        Set<String> destinations)
                                 throws FederationAdminException

* Deletes the registry entry from the registry catalog for each of the provided metacard ids. A set of destinations is sent in the delete request

Parameters:

metacardIds - The list of metacard ids to be deleted.

destinations - The set of destinations to be added

Throws:

FederationAdminException - If the list of ids provided is empty. If IngestException or Source UnavailableException was thrown by CatalogFramework.delete

updateRegistryEntry

void updateRegistryEntry(Metacard metacard)
                  throws FederationAdminException

* Write the provided metacard to the registry catalog. Updating the metacard currently stored.

Parameters:

metacard - Metacard with updates to be stored in the registry catalog

Throws:

FederationAdminException - If the provided metacard doesn't have an id. If CatalogFramework.update call throws IngestException or SourceUnavailableException

updateRegistryEntry

void updateRegistryEntry(Metacard metacard,
                         Set<String> destinations)
                  throws FederationAdminException

Write the provided metacard to the registry catalog. Updating the metacard currently stored with the provided destinations.

Parameters:

metacard - Metacard with updates to be stored in the registry catalog

destinations - Set of destinations to add

Throws:

FederationAdminException - If the provided metacard doesn't have an id. If CatalogFramework.update call throws IngestException or SourceUnavailableException

updateRegistryEntry

void updateRegistryEntry(String xml)
                  throws FederationAdminException

Update a registry metacard for the xml string provided. The string will be converted to a registry metacard using the RegistryTransformer.

Parameters:

xml - String representation of a registry package xml

Throws:

FederationAdminException - If the provided metacard doesn't have an id. If an exception is thrown from the RegistryTransformer If CatalogFramework.update call throws IngestException or SourceUnavailableException

updateRegistryEntry

void updateRegistryEntry(String xml,
                         Set<String> destinations)
                  throws FederationAdminException

Update a registry metacard for the xml string provided. The string will be converted to a registry metacard using the RegistryTransformer. The metacard will be updated with the provided destinations

Parameters:

xml - String representation of a registry package xml

destinations - Set of destinations to add

Throws:

FederationAdminException - If the provided metacard doesn't have an id. If an exception is thrown from the RegistryTransformer If CatalogFramework.update call throws IngestException or SourceUnavailableException

getRegistryMetacards

List<Metacard> getRegistryMetacards()
                             throws FederationAdminException

Get a list of registry metacards

Returns:

List

Throws:

FederationAdminException - If any exception was thrown

getInternalRegistryMetacards

List<Metacard> getInternalRegistryMetacards()
                                     throws FederationAdminException

Get a list of internal registry metacards.

Returns:

List

Throws:

FederationAdminException - If any exception was thrown

getInternalRegistryMetacardsByRegistryId

List<Metacard> getInternalRegistryMetacardsByRegistryId(String registryId)
                                                 throws FederationAdminException

Gets a list of internal registry metacards with the matching registry-id

Parameters:

registryId - registry-id to match

Returns:

List

Throws:

FederationAdminException

getRegistryMetacards

List<Metacard> getRegistryMetacards(Set<String> destinations)
                             throws FederationAdminException

Get a list of registry metacards

Parameters:

destinations - Set of destinations to query from

Returns:

List

Throws:

FederationAdminException - If any exception was thrown by the call to CatalogFramework.query()

getLocalRegistryMetacards

List<Metacard> getLocalRegistryMetacards()
                                  throws FederationAdminException

Get a list of local registry metacards

Returns:

List

Throws:

FederationAdminException - If any exception was thrown by the call to CatalogFramework.query()

getRegistryMetacardsByRegistryIds

List<Metacard> getRegistryMetacardsByRegistryIds(List<String> ids)
                                          throws FederationAdminException

Get a list of registry metacards with the provided registry ids. It won't run the query if the list provided is empty.

Parameters:

ids - List of IDs to to get metacards for

Returns:

List

Throws:

FederationAdminException - If empty list of registry ids is provided If the list of id filters isn't created If any exception was thrown by the call to CatalogFramework.query()

getRegistryMetacardsByRegistryIds

List<Metacard> getRegistryMetacardsByRegistryIds(List<String> ids,
                                                 boolean includeInternal)
                                          throws FederationAdminException

Get a list of registry metacards with the provided registry ids. It won't run the query if the list provided is empty.

Parameters:

ids - List of IDs to to get metacards for

includeInternal - boolean indicating whether the internal representation metacards should be included

Returns:

List

Throws:

FederationAdminException - If empty list of registry ids is provided If the list of id filters isn't created If any exception was thrown by the call to CatalogFramework.query()

getLocalRegistryMetacardsByRegistryIds

List<Metacard> getLocalRegistryMetacardsByRegistryIds(List<String> ids)
                                               throws FederationAdminException

Get a list of local registry metacards with the provided registry ids. It won't run the query if the list provided is empty.

Parameters:

ids - List of IDs to to get metacards for

Returns:

List

Throws:

FederationAdminException - If empty list of registry ids is provided If the list of id filters isn't created If any exception was thrown by the call to CatalogFramework.query()

getLocalRegistryObjects

List<RegistryPackageType> getLocalRegistryObjects()
                                           throws FederationAdminException

Get a list of local registry objects

Returns:

List

Throws:

FederationAdminException - If an exception is thrown trying to unmarshal the xml

getRegistryObjects

List<RegistryPackageType> getRegistryObjects()
                                      throws FederationAdminException

Get a list of all registry objects

Returns:

List

Throws:

FederationAdminException - If an exception is thrown trying to unmarshal the xml

getRegistryObjectByRegistryId

RegistryPackageType getRegistryObjectByRegistryId(String registryId)
                                           throws FederationAdminException

Get a registry object by registry id

Returns:

List

Throws:

FederationAdminException - If an exception is thrown trying to unmarshal the xml

getRegistryObjectByRegistryId

RegistryPackageType getRegistryObjectByRegistryId(String registryId,
                                                  Set<String> sourceIds)
                                           throws FederationAdminException

Get a registry object by registry id providing a list of source ids to be queried

Returns:

List

Throws:

FederationAdminException - If an exception is thrown trying to unmarshal the xml

getLocalRegistryIdentityMetacard

Optional<Metacard> getLocalRegistryIdentityMetacard()
                                             throws FederationAdminException

Returns the identity metacard for the local registry node.

Returns:

Optional containing the Identity Metacard

Throws:

FederationAdminException - if more than one metacard was found