org.omg.DsEventLogAdmin
Interface EventLogFactoryOperations
- All Superinterfaces:
- ConsumerAdminOperations, LogMgrOperations
- All Known Subinterfaces:
- EventLogFactory
public interface EventLogFactoryOperations
- extends LogMgrOperations, ConsumerAdminOperations
Generate log creation events when a log is successfully created. Each log
also generates events and forwards them to its log factory so event consumers can
receive all or filtered events from the log factory.
Event consumers can subscribe to receive events via the ConsumerAdmin
interface. Events are untyped and unfiltered.
Method Summary |
EventLog |
create_with_id(int id,
short full_action,
long max_size,
short[] thresholds)
Create EventLog with id. |
EventLog |
create(short full_action,
long max_size,
short[] thresholds,
IntHolder id)
Create EventLog. |
create_with_id
EventLog create_with_id(int id,
short full_action,
long max_size,
short[] thresholds)
throws LogIdAlreadyExists,
InvalidLogFullAction,
InvalidThreshold
- Create EventLog with id. An ObjectCreation event is generated whenever a log is created.
- Parameters:
id
- The id of the log.full_action
- The action that will be taken when the
maximum size of the log has been reached.max_size
- The size of the log measured in number of bytes.thresholds
- A sequence of value that specifies, as a
percentage of max log size, the points at which a ThresholdAlarm
event will be generated.
- Returns:
- the reference to the created event log.
- Throws:
DsLogAdmin::LogIdAlreadyExists
- if this log id exists within the
scope of the log factory
org.omg.DsLogAdmin::InvalidLogFullAction
- raised if the full_action specified is not
valid.
org.omg.DsLogAdmin::InvalidThreshold
- if the threshold list passed to the operation
contains invalid values.
LogIdAlreadyExists
InvalidLogFullAction
InvalidThreshold
create
EventLog create(short full_action,
long max_size,
short[] thresholds,
IntHolder id)
throws InvalidLogFullAction,
InvalidThreshold
- Create EventLog. An ObjectCreation event is generated whenever a log is created.
- Parameters:
full_action
- The action that will be taken when the
maximum size of the log has been reached.max_size
- The size of the log measured in number of bytes.thresholds
- A sequence of value that specifies, as a
percentage of max log size, the points at which a ThresholdAlarm
event will be generated.id
- The id of a log. Log objects are created by a log factory
and each log is assigned an id that uniquely identifies
the log object within the factory.
- Returns:
- the reference to the created event log.
- Throws:
org.omg.DsLogAdmin::InvalidLogFullAction
- raised if the full_action specified is not
valid
org.omg.DsLogAdmin::InvalidThreshold
- if the threshold list passed to the operation
contains invalid values.
InvalidLogFullAction
InvalidThreshold
Read the latest documentation online