alma.acs.nc

Class ChannelProperties

java.lang.Object

alma.acs.nc.ChannelProperties

public class ChannelProperties
extends java.lang.Object

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

Author:

dfugate

Constructor Summary

Constructors

Constructor and Description
ChannelProperties(ContainerServicesBase services) Creates a new instance of ChannelProperties.

Method Summary

Modifier and Type	Method and Description
boolean	cdbChannelConfigExists(java.lang.String channelName) Simple function which returns true if the given channel has an entry in $ACS_CDB/CDB/MACI/EventChannels/ section of the ACS configuration database.
protected Property[]	configAdminProps(java.lang.String channelName) Override this method in a subclass to specify your own administrative properties for the channel.
protected Property[]	configQofS(java.lang.String channelName) Override this method in a subclass to specify your own quality of service properties for the channel.
Property[]	getCDBAdminProps(java.lang.String channelName) 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.
Property[]	getCDBQoSProps(java.lang.String channelName) 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.
boolean	isTraceEventsEnabled(java.lang.String channelName) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelProperties

public ChannelProperties(ContainerServicesBase services)

Creates a new instance of ChannelProperties.

Parameters:

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

Method Detail

cdbChannelConfigExists

public boolean cdbChannelConfigExists(java.lang.String channelName)

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.

isTraceEventsEnabled

public boolean isTraceEventsEnabled(java.lang.String channelName)
                             throws AcsJException

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.

Throws:

AcsJException

Since:

ACS 6.0.1 (formerly called "getIntegrationLogs")

getCDBAdminProps

public Property[] getCDBAdminProps(java.lang.String channelName)
                            throws AcsJException

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

Throws:

AcsJException - if the channel's CDB entry is corrupted in any way

getCDBQoSProps

public Property[] getCDBQoSProps(java.lang.String channelName)
                          throws AcsJException

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

Throws:

AcsJException - if the channel's CDB entry is corrupted in any way

configQofS

protected Property[] configQofS(java.lang.String channelName)
                         throws AcsJException

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.

Throws:

AcsJException - Thrown if a CORBA Any cannot be created.

configAdminProps

protected Property[] configAdminProps(java.lang.String channelName)
                               throws AcsJException

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.

Throws:

AcsJException - Thrown if a CORBA Any cannot be created.