Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acs::nc::ChannelProperties Class Reference

List of all members.

Public Member Functions

 ChannelProperties (ContainerServicesBase services)
boolean cdbChannelConfigExists (String channelName)
boolean isTraceEventsEnabled (String channelName) throws AcsJException
Property[] getCDBAdminProps (String channelName) throws AcsJException
Property[] getCDBQoSProps (String channelName) throws alma.acs.exceptions.AcsJException

Protected Member Functions

Property[] configQofS (String channelName) throws AcsJException
Property[] configAdminProps (String channelName) throws AcsJException

Private Attributes

final ContainerServicesBase m_services
final Logger m_logger

Detailed Description

ChanncelProperties is a class designed to retrieve the various quality of service and administrative properties for a given channel. It is inteded to be used primarily by the Helper class within this package.

Author:
dfugate


Constructor & Destructor Documentation

alma::acs::nc::ChannelProperties::ChannelProperties ContainerServicesBase  services  )  [inline]
 

Creates a new instance of ChannelProperties.

Parameters:
services A reference to the ContainerServices. Used to retrieve other CORBA references and to access the logger.


Member Function Documentation

boolean alma::acs::nc::ChannelProperties::cdbChannelConfigExists String  channelName  )  [inline]
 

Simple function which returns true if the given channel has an entry in $ACS_CDB/CDB/MACI/EventChannels/ section of the ACS configuration database.

Parameters:
channelName is a string referring to the name of a Notification Channel registered in the CORBA Naming Service
Returns:
true if $ACS_CDB/CDB/MACI/EventChannels/channel_name/channel_name.xml exists and is a valid XML. false otherwise.

Property [] alma::acs::nc::ChannelProperties::configAdminProps String  channelName  )  throws AcsJException [inline, protected]
 

Override this method in a subclass to specify your own administrative properties for the channel. Only useful if the channel has not already been registered with the naming service.

Parameters:
channelName Name of the channel we are looking for
Returns:
A property array consisting of the administrative specifications.
Exceptions:
AcsJException Thrown if a CORBA Any cannot be created.

Property [] alma::acs::nc::ChannelProperties::configQofS String  channelName  )  throws AcsJException [inline, protected]
 

Override this method in a subclass to specify your own quality of service properties for the channel. Only useful if the channel has not already been registered with the naming service.

Parameters:
channelName Name of the channel we are looking for.
Returns:
A property array consisting of the quality of service specifications.
Exceptions:
AcsJException Thrown if a CORBA Any cannot be created.

Property [] alma::acs::nc::ChannelProperties::getCDBAdminProps String  channelName  )  throws AcsJException [inline]
 

Given a channel name that exists in the ACS CDB ($ACS_CDB/CDB/MACI/Channels/channelName/channelName.xml), this function returns the channels administrative properties in their CORBA format.

Parameters:
channelName name of the channel found in $ACS_CDB/CDB/MACI/Channels
Returns:
channel's admin properties
Exceptions:
AcsJException if the channel's CDB entry is corrupted in any way

Property [] alma::acs::nc::ChannelProperties::getCDBQoSProps String  channelName  )  throws alma.acs.exceptions.AcsJException [inline]
 

Given a channel name that exists in the ACS CDB ($ACS_CDB/CDB/MACI/Channels/channelName/channelName.xml), this function returns the channel's quality of service properties in their CORBA format.

The schema for this channel configuration is urn:schemas-cosylab-com:EventChannel:1.0.

Parameters:
channelName name of the channel found in $ACS_CDB/CDB/MACI/Channels
Returns:
channel's quality of service properties
Exceptions:
AcsJException if the channel's CDB entry is corrupted in any way

boolean alma::acs::nc::ChannelProperties::isTraceEventsEnabled String  channelName  )  throws AcsJException [inline]
 

When some attribute is set within the CDB (currently IntegrationLogs defined in EventChannel.xsd, see NC document), a log is published each time an event is sent or received. For performance reasons, this should be used very carefully to say the least.

Parameters:
channelName Name of the channel.
Returns:
True if event publishing/receiving should be traced by log messages.
Exceptions:
AcsJException 
Since:
ACS 6.0.1 (formerly called "getIntegrationLogs")


Member Data Documentation

final Logger alma::acs::nc::ChannelProperties::m_logger [private]
 

Standard logger

final ContainerServicesBase alma::acs::nc::ChannelProperties::m_services [private]
 

Access to the component's name along with the logging service.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:54:26 2009 for ACS Java API by doxygen 1.3.8