public class StateAdvisoryDefinition
extends java.lang.Object
Title: Service Event Fabric Core
Description: The Advisory Definition
object holds all critical settings for a service's
state notification.
State advisories are typically used to relay critical information about a service's state. The actual implementation
of a notification is up to the service implementer. The specific mechanism by which a service hosting environment
publishes notifications and presents notifications is up to the implementer. A State Advisory
is technically
considered a Structured Data Object
and will appear in the catalog of system objects as a Semantic Type
.
However this internal object is used by the fabric to represent serialized state notifications that are typically sent to
advisory listeners or query mechanisms. The actual engine for emitting notifications is an implementation of StateAdvisoryFactory
.
Advisories typically follow a hirarchical naming convention that uses a dotted notation to separate the elements. For example
Advisory.System.Memory
is an example of a container-level system metric that contains memory related information.
While any number of hirarchies may be specificed in this fashion, node levels deeper then 4 levels are usually impractical. To
specify leaf-level details about memory related metrics a developer may specify something similar to the following:
advisory.service.Start
advisory.service.Timeout
StateAdvisoryDefinition
event
datagram and load this datagram into the given container's context. The actual implementation is defined by the
Copyright: Copyright (c) 2009
Company: StreamScape Technologies
Constructor and Description |
---|
StateAdvisoryDefinition() |
StateAdvisoryDefinition(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
void |
addProperty(java.lang.String name,
java.lang.String value) |
java.lang.Object |
clone() |
java.lang.String |
getDescription() |
java.lang.String |
getName() |
java.util.HashMap |
getProperties() |
java.lang.String |
getProperty(java.lang.String name) |
java.util.Iterator |
getPropertyNames() |
StateAdvisoryType |
getType() |
void |
removeProperty(java.lang.String prop) |
void |
setDescription(java.lang.String desc) |
void |
setName(java.lang.String name) |
void |
setType(StateAdvisoryType type) |
public StateAdvisoryDefinition()
public StateAdvisoryDefinition(java.lang.String name)
public void setName(java.lang.String name)
public java.lang.String getName()
public void setType(StateAdvisoryType type)
public StateAdvisoryType getType()
public void setDescription(java.lang.String desc)
public java.lang.String getDescription()
public void addProperty(java.lang.String name, java.lang.String value)
public void removeProperty(java.lang.String prop)
public java.lang.String getProperty(java.lang.String name)
public java.util.HashMap getProperties()
public java.util.Iterator getPropertyNames()
public java.lang.Object clone()
clone
in class java.lang.Object
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.