public interface EventIdentityPlugin extends CloneableObject
Title: Open Service Framework
Description: Defines an Event Identity Plugin.
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
void |
acceptDatagramIdentity(EventDatagram datagram)
Accepts a datagram's Event Identity allowing the plugin to manipulate
it's elements or use them as seed values for
EventIdentity . |
void |
acceptIdentity(EventIdentity identity)
Accepts an identity object that may be used as seed values for the plugin's values.
|
EventIdentityPlugin |
clone()
Clones the plugin.
|
java.lang.String |
getDescription()
Returns a description of this plugin.
|
EventIdentity |
getIdentity()
Returns an Event Identity object that represents the current state of the identity manager plugin.
|
java.lang.String |
getName()
Returns a user-friendly name of this plugin.
|
java.lang.String |
getPluginName()
Returns an unique name of the plugin.
|
void |
init(ServiceContext context)
Initializes the Event Identity plugin.
|
void |
setDatagramIdentity(EventDatagram datagram)
Sets an Event Identity of a given datagram using the plugin's values.
|
void |
setExceptionIdentity(ExceptionEventDatagram exception)
Sets an Event Identity of a given exception using the plugin's values.
|
void |
unload()
Unloads the Event Identity plugin.
|
void init(ServiceContext context)
context
- the context of the associated service.void unload()
void acceptIdentity(EventIdentity identity)
identity
- the specified identity.void acceptDatagramIdentity(EventDatagram datagram)
EventIdentity
.datagram
- the specified datagram.void setDatagramIdentity(EventDatagram datagram)
datagram
- the specified datagram.void setExceptionIdentity(ExceptionEventDatagram exception)
exception
- the specified exception.EventIdentity getIdentity()
java.lang.String getName()
java.lang.String getPluginName()
java.lang.String getDescription()
EventIdentityPlugin clone()
This method is important and must be implemented correctly.
Typically a user can inherit a custom plugin from CloneableDataObject
.
clone
in interface CloneableObject
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.