Envelope object combines a status value, an identification object
and a scope name. The Envelope object allows the use of standard Java
types when a Producer service can produce more than one kind of object. The
Envelope object allows the Consumer service to recognize the kind of
object that is received. For example, a door lock could be represented by a
Boolean object. If the Producer service would send such a
Boolean object, then the Consumer service would not know what door
the Boolean object represented. The Envelope object contains
an identification object so the Consumer service can discriminate between
different kinds of values. The identification object may be a simple
String object, but it can also be a domain specific object that is
mutually agreed by the Producer and the Consumer service. This object can
then contain relevant information that makes the identification easier.
The scope name of the envelope is used for security. The Wire object must
verify that any Envelope object send through the update
method or coming from the poll method has a scope name that matches
the permissions of both the Producer service and the Consumer service
involved. The wireadmin package also contains a class BasicEnvelope
that implements the methods of this interface.
WirePermission, BasicEnvelope
| Modifier and Type | Method and Description |
|---|---|
| public Object | Returns: an object which identifies the status item in the address space of the composite producer, must not be null.Return the identification of this |
| public String | Returns: the security scope for the status item, must not be null.Return the scope name of this |
| public Object | Returns: the value of the status item, ornull when no item is
associated with this object.Return the value associated with this |
| getIdentification | back to summary |
|---|---|
| public Object getIdentification() Return the identification of this
| |
| getScope | back to summary |
|---|---|
| public String getScope() Return the scope name of this
| |
| getValue | back to summary |
|---|---|
| public Object getValue() Return the value associated with this
| |