org.codice.ddf.registry.federationadmin.impl

Class FederationAdmin

java.lang.Object

org.codice.ddf.registry.federationadmin.impl.FederationAdmin

All Implemented Interfaces:

FederationAdminMBean, org.osgi.service.event.EventHandler

public class FederationAdmin
extends Object
implements FederationAdminMBean, org.osgi.service.event.EventHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_MODE
static String	FILTER_INVERTED
static String	SUMMARY_FILTERED
static String	SUMMARY_IDENTITY_NODE
static String	SUMMARY_LOCAL_NODE
static String	SUMMARY_METACARD_ID
static String	SUMMARY_NAME
static String	SUMMARY_REGISTRY_ID
static String	SUMMARY_REPORT_ACTION

Fields inherited from interface org.codice.ddf.registry.federationadmin.internal.FederationAdminMBean

OBJECT_NAME

Constructor Summary

Constructors

Constructor and Description
FederationAdmin(AdminHelper helper)

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'.
void	bindEndpoint(org.osgi.framework.ServiceReference reference)
String	createLocalEntry(Map<String,Object> registryMap) Create a local entry in the registry catalog for the given object map.
String	createLocalEntry(String base64EncodedXmlData) 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.
void	destroy()
protected org.osgi.framework.BundleContext	getContext()
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	handleEvent(org.osgi.service.event.Event event)
void	init()
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	setFederationAdminService(FederationAdminService federationAdminService)
void	setMetacardMarshaller(MetacardMarshaller metacardMarshaller)
void	setRegistryActionProvider(MultiActionProvider provider)
void	setRegistryMapConverter(RegistryPackageWebConverter registryMapConverter)
void	setRegistryTransformer(InputTransformer inputTransformer)
void	setRegistryTypeConverter(RegistryPackageTypeConverter registryTypeConverter)
void	setSlotHelper(SlotTypeHelper slotHelper)
void	setSourceConfigRefresh(RegistrySourceConfiguration sourceConfigRefresh)
void	unbindEndpoint(org.osgi.framework.ServiceReference reference)
void	updateLocalEntry(Map<String,Object> registryObjectMap) Update a local entry in the registry catalog for the given object map.

Methods inherited from class java.lang.Object

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

Field Detail

SUMMARY_METACARD_ID

public static final String SUMMARY_METACARD_ID

See Also:

Constant Field Values

SUMMARY_REGISTRY_ID

public static final String SUMMARY_REGISTRY_ID

See Also:

Constant Field Values

SUMMARY_NAME

public static final String SUMMARY_NAME

See Also:

Constant Field Values

SUMMARY_LOCAL_NODE

public static final String SUMMARY_LOCAL_NODE

See Also:

Constant Field Values

SUMMARY_IDENTITY_NODE

public static final String SUMMARY_IDENTITY_NODE

See Also:

Constant Field Values

SUMMARY_REPORT_ACTION

public static final String SUMMARY_REPORT_ACTION

See Also:

Constant Field Values

SUMMARY_FILTERED

public static final String SUMMARY_FILTERED

See Also:

Constant Field Values

FILTER_INVERTED

public static final String FILTER_INVERTED

See Also:

Constant Field Values

CLIENT_MODE

public static final String CLIENT_MODE

See Also:

Constant Field Values

Constructor Detail

FederationAdmin

public FederationAdmin(AdminHelper helper)

Method Detail

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

createLocalEntry

public String createLocalEntry(Map<String,Object> registryMap)
                        throws FederationAdminException

Description copied from interface: FederationAdminMBean

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.

Specified by:

createLocalEntry in interface FederationAdminMBean

Returns:

Id of the created metacard.

Throws:

FederationAdminException - Passes exception thrown by FederationAdminServiceImpl

createLocalEntry

public String createLocalEntry(String base64EncodedXmlData)
                        throws FederationAdminException

Description copied from interface: FederationAdminMBean

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.

Specified by:

createLocalEntry in interface FederationAdminMBean

Parameters:

base64EncodedXmlData - 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

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

Description copied from interface: FederationAdminMBean

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.

Specified by:

updateLocalEntry in interface FederationAdminMBean

Parameters:

registryObjectMap - A map of the registry object to update

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

deleteLocalEntry

public void deleteLocalEntry(List<String> ids)
                      throws FederationAdminException

Description copied from interface: FederationAdminMBean

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

Specified by:

deleteLocalEntry in interface FederationAdminMBean

Parameters:

ids - List of registry ids to be deleted

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

getLocalNodes

public Map<String,Object> getLocalNodes()
                                 throws FederationAdminException

Description copied from interface: FederationAdminMBean

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.

Specified by:

getLocalNodes in interface FederationAdminMBean

Returns:

Map

Throws:

FederationAdminException - Passes exception thrown byFederationAdminServiceImpl

registryStatus

public boolean registryStatus(String servicePID)

Specified by:

registryStatus in interface FederationAdminMBean

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

public List<Service> allRegistryInfo()

Specified by:

allRegistryInfo in interface FederationAdminMBean

Returns:

the list of registry metatypes

allRegistryMetacards

public Map<String,Object> allRegistryMetacards()

Description copied from interface: FederationAdminMBean

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.

Specified by:

allRegistryMetacards in interface FederationAdminMBean

Returns:

Map

registryMetacard

public Map<String,Object> registryMetacard(String registryId)

Description copied from interface: FederationAdminMBean

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.

Specified by:

registryMetacard in interface FederationAdminMBean

Parameters:

registryId - The registry id of the node to retrieve.

Returns:

Map

allRegistryMetacardsSummary

public Map<String,Object> allRegistryMetacardsSummary()

Description copied from interface: FederationAdminMBean

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.

Specified by:

allRegistryMetacardsSummary in interface FederationAdminMBean

Returns:

Map

regenerateRegistrySources

public void regenerateRegistrySources(List<String> ids)

Description copied from interface: FederationAdminMBean

Regenerates registry sources for the given registry-ids

Specified by:

regenerateRegistrySources in interface FederationAdminMBean

Parameters:

ids - registry-ids to regenerate

nodeFilterProperties

public void nodeFilterProperties(Map<String,Object> properties)

Description copied from interface: FederationAdminMBean

Sets the properties associated with the registry filter/policy

Specified by:

nodeFilterProperties in interface FederationAdminMBean

destroy

public void destroy()

init

public void init()

bindEndpoint

public void bindEndpoint(org.osgi.framework.ServiceReference reference)

unbindEndpoint

public void unbindEndpoint(org.osgi.framework.ServiceReference reference)

getContext

protected org.osgi.framework.BundleContext getContext()

setFederationAdminService

public void setFederationAdminService(FederationAdminService federationAdminService)

setMetacardMarshaller

public void setMetacardMarshaller(MetacardMarshaller metacardMarshaller)

setRegistryTransformer

public void setRegistryTransformer(InputTransformer inputTransformer)

setRegistryTypeConverter

public void setRegistryTypeConverter(RegistryPackageTypeConverter registryTypeConverter)

setRegistryMapConverter

public void setRegistryMapConverter(RegistryPackageWebConverter registryMapConverter)

setSlotHelper

public void setSlotHelper(SlotTypeHelper slotHelper)

setSourceConfigRefresh

public void setSourceConfigRefresh(RegistrySourceConfiguration sourceConfigRefresh)

setRegistryActionProvider

public void setRegistryActionProvider(MultiActionProvider provider)