org.miloss.fgsms.plugins.federation

Interface FederationInterface

All Superinterfaces:

PluginCommon

All Known Implementing Classes:

UddiPublisher

public interface FederationInterface
extends PluginCommon

Implementors provide the ability to publish summarized data from fgsms to an external system on a periodic basis. Non periodic federation publishers (such as a web service MUST also implement this interface. In this case, the Publish method does nothing. Constructor functions should be non blocking.

Author:

AO

Method Summary

Methods

Modifier and Type	Method and Description
void	Publish(boolean pooled, QuickStatWrapper data, ServicePolicy sp, FederationPolicy fp) Called by a Quartz timer job
boolean	ValidateConfiguration(FederationPolicy fp, AtomicReference<String> outMessage) This is called by both the user interface as well as whenever someone attempts to add or change a service policy containing this federation target.

Methods inherited from interface org.miloss.fgsms.plugins.PluginCommon

GetAppliesTo, GetDisplayName, GetHtmlFormattedHelp, GetOptionalParameters, GetRequiredParameters

Method Detail

ValidateConfiguration

boolean ValidateConfiguration(FederationPolicy fp,
                            AtomicReference<String> outMessage)

This is called by both the user interface as well as whenever someone attempts to add or change a service policy containing this federation target.

Parameters:

fp - the proposed federation policy

outMessage - returns the error message, if any. Null or empty string can be returned if there is no error. The message should be a human readable reason for why the policy is invalid or misconfigured.

Returns:

True if the configuration is valid, false otherwise

Publish

void Publish(boolean pooled,
           QuickStatWrapper data,
           ServicePolicy sp,
           FederationPolicy fp)

Called by a Quartz timer job

Parameters:

pooled - indicates where or not we are using pooled database connections

data - represents the last known data set for a web service, availability info for all policy types

sp - the complete service policy of the thing we are publishing

fp - the federation policy, which should allow users to dictate implementation specific parameters and settings

See Also:

org.miloss.fgsms.common.Utility.GetConfigurationDBConnection