public interface AdvisoriesConfiguration extends FabricEventAdvisorySource
Title: Open Service Framework
Description: This interface defines a mechanism for configuring Service state notification events in the
State Advisory Registry
.
A Service that has been configured to produce Advisories
will attempt to register
the
advisories with the Service component context. The component will use its Advisories Factory
to initialize
the runtime advisory prototypes. Users must use the runtime API to populate the runtime advisory events. Note that
the Advisory Factory
and it's support indicators are initialized at Service start-up by the
Container Context
. The advisory factory provides a mechanism for configuring and instantiating the
advisory prototypes of a service. To raise an advisory the user must call ServiceContextImpl.raiseAdvisory(com.streamscape.sdo.AdvisoryEventDatagram)
.
The advisory prototype will be verified against those registered.
Copyright: Copyright (c) 2008
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
void |
addAdvisory(java.lang.String eventId)
This method adds a standard
Advisory to the configuration. |
void |
addStateAdvisory(StateAdvisoryDefinition advisory)
This method adds a
State Advisory to the Service Configuration. |
StateAdvisoryDefinition |
getStateAdvisoryDefinition(java.lang.String advisoryName)
Get State Advisory definition object from the Service Configuration.
|
java.util.List |
getStateAdvisoryDefinitions()
Returns an enumeration of configured state advisory definitions.
|
void |
removeAdvisory(java.lang.String advisoryName)
Removes the advisory from the Service Configuration.
|
void |
removeAllAdvisories()
Removes all advisories from the Service Configuration.
|
existsAdvisory, hasAdvisories, listAdvisories
void addStateAdvisory(StateAdvisoryDefinition advisory) throws ServiceConfigurationException
State Advisory
to the Service Configuration. An advisory consists of a
name and type of notification based on StateAdvisoryType
, properties and a text message.
Properties are text based name/value pairs and may further provide additional information about the event, such as
Event Identity Tracking Information
or similar information such as return codes or event source identifiers.
The actual notification object is an instance of StateAdvisory
based on a StateAdvisoryDefinition
. The
event definition is used by the advisory factory to initialize an instance of the event object.advisory
- StateAdvisoryDefinitionServiceConfigurationException
void addAdvisory(java.lang.String eventId) throws ServiceConfigurationException
Advisory
to the configuration. This method is typically used
internally by the configuration logic to add or remove advisories that may be raised by various conditions.
However users may register any advisories they need by supplying their associate prototype. Unregistered
advisories may not be raised.eventId
- StringServiceConfigurationException
void removeAdvisory(java.lang.String advisoryName) throws ServiceConfigurationException
advisoryName
- StringServiceConfigurationException
StateAdvisoryDefinition getStateAdvisoryDefinition(java.lang.String advisoryName) throws ServiceConfigurationException
advisoryName
- StringServiceConfigurationException
java.util.List getStateAdvisoryDefinitions()
void removeAllAdvisories()
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.