org.codice.ddf.registry.federationadmin.internal

Interface FederationAdminMBean

All Known Implementing Classes:

FederationAdmin

public interface FederationAdminMBean

This is the external facing interface for the FederationAdminService. This is what should be used by the UI, for example, to interact with the FederationAdminService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_NAME

Method Summary

Modifier and Type	Method and Description
List<Service>	allRegistryInfo()
Map<String,Object>	allRegistryMetacards() Returns a Map of RegistryPackageType objects as converted using RegistryPackageWebConverter List of node maps representing all registry entries can be found in the returned map using the key 'nodes'.
Map<String,Object>	allRegistryMetacardsSummary() Returns a Map of node maps representing all registry entries which can be found in the returned map using the key 'nodes'.
String	createLocalEntry(Map<String,Object> registryObjectMap) Create a local entry in the registry catalog for the given object map.
String	createLocalEntry(String base64EncodedXmlString) Create a local entry in the registry catalog for the given string.
void	deleteLocalEntry(List<String> ids) Deletes a local entry in the registry catalog for each of the ids provided.
Map<String,Object>	getLocalNodes() Returns a Map of RegistryPackageType objects as converted using RegistryPackageWebConverter List of node maps representing local registry entries can be found in the returned map using the key 'nodes'.
void	nodeFilterProperties(Map<String,Object> properties) Sets the properties associated with the registry filter/policy
void	regenerateRegistrySources(List<String> ids) Regenerates registry sources for the given registry-ids
Map<String,Object>	registryMetacard(String registryId) Returns a Map of RegistryPackageType object as converted using RegistryPackageWebConverter A map of the registry node identified by the given registry id.
boolean	registryStatus(String servicePID)
void	updateLocalEntry(Map<String,Object> registryObjectMap) Update a local entry in the registry catalog for the given object map.

Field Detail

OBJECT_NAME

static final String OBJECT_NAME

See Also:

Constant Field Values

Method Detail

createLocalEntry

String createLocalEntry(Map<String,Object> registryObjectMap)
                 throws FederationAdminException

Create a local entry in the registry catalog for the given object map. The map will be converted to a RegistryPackageType using the RegistryPackageWebConverter. The resulting RegistryPackageType will be passed to FederationAdminService#addLocalEntry to create the entry.

Parameters:

RegistryObjectMap - A map of the registry object to create

Returns:

Id of the created metacard.

Throws:

FederationAdminException - Passes exception thrown by FederationAdminServiceImpl

createLocalEntry

String createLocalEntry(String base64EncodedXmlString)
                 throws FederationAdminException

Create a local entry in the registry catalog for the given string. The String provided is an Base64 encoded representation of a registry package xml. The RegistryTransformer transforms the Base64 decode stream into a registry metacard.

Parameters:

base64EncodedXmlString - Base64 encoded registry package xml.

Returns:

Id of the created metacard

Throws:

FederationAdminException - If Base64 decoding of the string fails If the RegistryTransformer can't convert the stream into a metacard Passes exceptions thrown by FederationAdminServiceImpl

updateLocalEntry

void updateLocalEntry(Map<String,Object> registryObjectMap)
               throws FederationAdminException

Update a local entry in the registry catalog for the given object map. The map will be converted to a RegistryPackageType using the RegistryPackageWebConverter. The resulting RegistryPackageType will be passed to FederationAdminService#addLocalEntry to update the entry.

Parameters:

registryObjectMap - A map of the registry object to update

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

deleteLocalEntry

void deleteLocalEntry(List<String> ids)
               throws FederationAdminException

Deletes a local entry in the registry catalog for each of the ids provided.

Parameters:

ids - List of registry ids to be deleted

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

getLocalNodes

Map<String,Object> getLocalNodes()
                          throws FederationAdminException

Returns a Map of RegistryPackageType objects as converted using RegistryPackageWebConverter List of node maps representing local registry entries can be found in the returned map using the key 'nodes'. Additional information about the nodes/registry is also included in the map.

Returns:

Map

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

registryStatus

boolean registryStatus(String servicePID)

Parameters:

servicePID - - The PID of the registry which will have the status checked

Returns:

the status of a single registry as a boolean, true if available, false otherwise

allRegistryInfo

List<Service> allRegistryInfo()

Returns:

the list of registry metatypes

allRegistryMetacards

Map<String,Object> allRegistryMetacards()

Returns a Map of RegistryPackageType objects as converted using RegistryPackageWebConverter List of node maps representing all registry entries can be found in the returned map using the key 'nodes'. Additional information about the nodes/registry is also included in the map.

Returns:

Map

registryMetacard

Map<String,Object> registryMetacard(String registryId)

Returns a Map of RegistryPackageType object as converted using RegistryPackageWebConverter A map of the registry node identified by the given registry id. Additional information about the node is also included in the map.

Parameters:

registryId - The registry id of the node to retrieve.

Returns:

Map

allRegistryMetacardsSummary

Map<String,Object> allRegistryMetacardsSummary()

Returns a Map of node maps representing all registry entries which can be found in the returned map using the key 'nodes'. Additional information about the nodes/registry is also included in the map.

Returns:

Map

regenerateRegistrySources

void regenerateRegistrySources(List<String> ids)

Regenerates registry sources for the given registry-ids

Parameters:

ids - registry-ids to regenerate

nodeFilterProperties

void nodeFilterProperties(Map<String,Object> properties)

Sets the properties associated with the registry filter/policy

Parameters:

properties -