org.omg.DsTypedNotifyLogAdmin
Interface TypedNotifyLogFactoryOperations

All Superinterfaces:

ConsumerAdminOperations, FilterAdminOperations, LogMgrOperations, NotifySubscribeOperations, QoSAdminOperations

All Known Subinterfaces:

TypedNotifyLogFactory

public interface TypedNotifyLogFactoryOperations
extends LogMgrOperations, ConsumerAdminOperations

TypedNotifyLogFactory provides the following additional functions:

• Create TypedNotifyLog.
• Create TypedNotifyLog with id.
• Emit log creation events and forward log generated events as untyped events.
• Clients can specify filters via the TypedNotifyConsumerAdmin interface to receive filtered events.

Method Summary

TypedNotifyLog	create_with_id(int id, short full_action, long max_size, short[] thresholds, Property[] initial_qos, Property[] initial_admin) Create TypedNotifyLog with id.
TypedNotifyLog	create(short full_action, long max_size, short[] thresholds, Property[] initial_qos, Property[] initial_admin, IntHolder id) Create TypedNotifyLog.

Methods inherited from interface org.omg.DsLogAdmin.LogMgrOperations

find_log, list_logs_by_id, list_logs

Methods inherited from interface org.omg.CosNotifyChannelAdmin.ConsumerAdminOperations

destroy, get_proxy_supplier, lifetime_filter, lifetime_filter, MyChannel, MyID, MyOperator, obtain_notification_pull_supplier, obtain_notification_push_supplier, priority_filter, priority_filter, pull_suppliers, push_suppliers

Methods inherited from interface org.omg.CosNotification.QoSAdminOperations

get_qos, set_qos, validate_qos

Methods inherited from interface org.omg.CosNotifyComm.NotifySubscribeOperations

subscription_change

Methods inherited from interface org.omg.CosNotifyFilter.FilterAdminOperations

add_filter, get_all_filters, get_filter, remove_all_filters, remove_filter

Methods inherited from interface org.omg.CosEventChannelAdmin.ConsumerAdminOperations

obtain_pull_supplier, obtain_push_supplier

Method Detail

create_with_id

TypedNotifyLog create_with_id(int id,
                              short full_action,
                              long max_size,
                              short[] thresholds,
                              Property[] initial_qos,
                              Property[] initial_admin)
                              throws LogIdAlreadyExists,
                                     InvalidLogFullAction,
                                     InvalidThreshold,
                                     UnsupportedQoS,
                                     UnsupportedAdmin

Create TypedNotifyLog 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.

initial_qos - The initial QoS.

initial_admin - The initial admin.

Returns:

the reference to the TypedNotifyLog.

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.

CosNotification::UnsupportedQoS - if the qos properties passed to the operation contains invalid values.

CosNotification::UnsupportedAdmin - if the admin properties passed to the operation contains invalid values.

LogIdAlreadyExists

InvalidLogFullAction

InvalidThreshold

UnsupportedQoS

UnsupportedAdmin

create

TypedNotifyLog create(short full_action,
                      long max_size,
                      short[] thresholds,
                      Property[] initial_qos,
                      Property[] initial_admin,
                      IntHolder id)
                      throws InvalidLogFullAction,
                             InvalidThreshold,
                             UnsupportedQoS,
                             UnsupportedAdmin

Create TypedNotifyLog. 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.

initial_qos - The initial QoS.

initial_admin - The initial admin.

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 TypedNotifyLog.

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.

CosNotification::UnsupportedQoS - if the qos properties passed to the operation contains invalid values.

CosNotification::UnsupportedAdmin - if the admin properties passed to the operation contains invalid values.

InvalidLogFullAction

InvalidThreshold

UnsupportedQoS

UnsupportedAdmin