public class AdvisoryEvents extends CloneableDataObject implements AdvisoriesConfiguration
Title: Open Service Framework
Description: A table containing registered advisory events.
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
DEFAULT_SERIAL_VERSION_ID
Constructor and Description |
---|
AdvisoryEvents() |
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. |
java.lang.Object |
clone()
Clones the object.
|
boolean |
existsAdvisory(java.lang.String eventId)
Returns
true if the specific advisory event is registered. |
StateAdvisoryDefinition |
getStateAdvisoryDefinition(java.lang.String eventId)
Get State Advisory definition object from the Service Configuration.
|
java.util.List |
getStateAdvisoryDefinitions()
Returns an enumeration of configured state advisory definitions.
|
boolean |
hasAdvisories()
Returns
true if the component has advisory events. |
java.util.List |
listAdvisories()
Returns list of all advisory prototypes exposed by
this component.
|
void |
removeAdvisory(java.lang.String eventId)
Removes the advisory from the Service Configuration.
|
void |
removeAllAdvisories()
Removes all advisories from the Service Configuration.
|
getSerialVersionUID
public void addStateAdvisory(StateAdvisoryDefinition advisory) throws ServiceConfigurationException
AdvisoriesConfiguration
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.addStateAdvisory
in interface AdvisoriesConfiguration
advisory
- StateAdvisoryDefinitionServiceConfigurationException
public void addAdvisory(java.lang.String eventId) throws ServiceConfigurationException
AdvisoriesConfiguration
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.addAdvisory
in interface AdvisoriesConfiguration
eventId
- StringServiceConfigurationException
public void removeAdvisory(java.lang.String eventId) throws ServiceConfigurationException
AdvisoriesConfiguration
removeAdvisory
in interface AdvisoriesConfiguration
eventId
- StringServiceConfigurationException
public StateAdvisoryDefinition getStateAdvisoryDefinition(java.lang.String eventId) throws ServiceConfigurationException
AdvisoriesConfiguration
getStateAdvisoryDefinition
in interface AdvisoriesConfiguration
eventId
- StringServiceConfigurationException
public void removeAllAdvisories()
AdvisoriesConfiguration
removeAllAdvisories
in interface AdvisoriesConfiguration
public boolean hasAdvisories()
FabricEventAdvisorySource
true
if the component has advisory events.hasAdvisories
in interface FabricEventAdvisorySource
public java.util.List listAdvisories()
FabricEventAdvisorySource
The prototypes for such events are added to the advisory registry. This interface allows public, component level visibility to all such advisories that may be used by a component.
listAdvisories
in interface FabricEventAdvisorySource
public boolean existsAdvisory(java.lang.String eventId)
FabricEventAdvisorySource
true
if the specific advisory event is registered.existsAdvisory
in interface FabricEventAdvisorySource
eventId
- Stringpublic java.util.List getStateAdvisoryDefinitions()
AdvisoriesConfiguration
getStateAdvisoryDefinitions
in interface AdvisoriesConfiguration
public java.lang.Object clone()
CloneableDataObject
clone
in interface CloneableObject
clone
in class CloneableDataObject
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.