org.miloss.fgsms.plugins

Interface PluginCommon

All Known Subinterfaces:

FederationInterface, ReportGeneratorPlugin, SLAActionInterface, SLARuleInterface, StatusProviderInterface

All Known Implementing Classes:

ActionContainsIgnoreCase, ActionEqualsIgnoreCase, AllFaults, AllSuccesses, AMQPAlerter, AvailabilityByService, AverageMessageSizeByService, AverageMessageSizeByServiceByMethod, AverageResponseTimeByService, AverageResponseTimeByServiceByMethod, BaseReportGenerator, BaseWebServiceReport, BrokerQueueSizeGreaterThan, ChangeInAvailabilityStatus, ConsumerContainsIgnoreCase, ConsumerEqualsIgnoreCase, ConsumersByQueueOrTopic, CpuUsageReport, CustomSLAAction, CustomSLARule, DiskIOReport, EmailAlerter, FaultsOverTimeGreaterThan, FaultsOverTimeLessThan, FreeDiskSpace, HighCPUUsage, HighCPUUsageOverTime, HighDiskUsageOverTime, HighMemoryUsage, HighMemoryUsageOverTime, HighNetworkUsageOverTime, HighOpenFileHandles, HighThreadCount, InvocationsByConsumer, InvocationsByConsumerByService, InvocationsByConsumerByServiceByMethod, InvocationsByDataCollector, InvocationsByHostingServer, InvocationsByService, InvocationsByServiceByMethod, InvocationsOverTimeGreatThan, InvocationsOverTimeLessThan, JMSAlerter, LowDiskSpace, MeanTimeBetweenFailureByService, MeanTimeBetweenFailureGreatThan, MeanTimeBetweenFailureLessThan, MemoryUsageReport, NetworkIOReport, OpenFilesByProcess, QueueDepth, QueueOrTopicDoesNotExist, QueueTopicCountByBroker, RequestContentContainsIgnoreCase, RequestMessageSizeGreaterThan, RequestMessageSizeLessThan, ResponseContentContainsIgnoreCase, ResponseMessageSizeGreaterThan, ResponseMessageSizeLessThan, ResponseTimeGreaterThan, ResponseTimeLessThan, ResponseTimeOverTime, ServiceLevelAgreementReport, SimpleMulticastAlerter, SLAActionLog, SLAActionRestart, SLAActionRunScript, StaleData, SuccessFailureCountByHostingServer, SuccessFailureCountByService, SuccessFailureCountByServiceByMethod, ThreadCount, ThroughputByHostingServer, ThroughputByService, ThroughputByServiceByMethod, TotalMessageSizeByServiceByMethod, TotalMessageSizesByService, TransactionalAgentMemoContainsIgnoreCase, UddiPublisher, UpdateUddiRegistration, WSNotificationAlerter, XPathExpression

public interface PluginCommon

Author:

AO

Method Summary

Methods

Modifier and Type	Method and Description
List<PolicyType>	GetAppliesTo() Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything.
String	GetDisplayName() end user facing display name
String	GetHtmlFormattedHelp() returns html formatted help to guide users towards proper usage.
List<NameValuePair>	GetOptionalParameters() returns a list of optional parameters
List<NameValuePair>	GetRequiredParameters() returns a list of required parameters

Method Detail

GetDisplayName

String GetDisplayName()

end user facing display name

Returns:

Since:

6.3

GetHtmlFormattedHelp

String GetHtmlFormattedHelp()

returns html formatted help to guide users towards proper usage. Always include the following fields

• Applies to - what policies types it applies to
• Required and optional parameters
• Description
• State if this is processed as data comes in, or periodically (some aggregated data)

Html is allowed, javascript is not

Returns:

Since:

6.3

GetRequiredParameters

List<NameValuePair> GetRequiredParameters()

returns a list of required parameters

Returns:

Since:

6.3

GetOptionalParameters

List<NameValuePair> GetOptionalParameters()

returns a list of optional parameters

Returns:

Since:

6.3

GetAppliesTo

List<PolicyType> GetAppliesTo()

Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything. Also Utility.IsContains()

Returns: