com.avaya.collaboration.businessdata.api

Interface ClusterData

public interface ClusterData

This interface provides methods to retrieve various cluster-related data configured as cluster attributes

Method Summary

Methods

Modifier and Type	Method and Description
String	getClusterAttribute(String attrName) Returns the value for a cluster attribute.
List	getClusterAttributeList() Returns the list of Cluster Attributes defined for the cluster.
String	getClusterDescription() Returns the description of the cluster that includes the Avaya Breeze server instance on which the service is running.
String	getClusterDomainName() Returns the domain name of the cluster that includes the Avaya Breeze server instance on which the service is running.
String	getClusterEncryptedAttribute(String attrName) Returns the value for an encrypted cluster attribute.
String	getClusterHost() Returns the IP address of the cluster that includes the Avaya Breeze server instance on which the service is running.
String	getClusterName() Returns the name of the cluster that includes the Avaya Breeze server instance on which the service is running.
Long	getClusterProfileID() Returns the profile ID of the cluster that includes the Avaya Breeze server instance on which the service is running.
String	getClusterProfileName() Returns the cluster profile name of the cluster that includes the Avaya Breeze server instance on which the service is running.

Method Detail

getClusterAttribute

String getClusterAttribute(String attrName)
                           throws NoAttributeFoundException

Returns the value for a cluster attribute. Note: Any attempt to retrieve encrypted attribute through this method would result in UnsupportedOperationException runtime exception. Encrypted Cluster attributes should be retrieved using the ClusterData.getClusterEncryptedAttribute(String) method.

Parameters:

attrName - attribute name of a cluster attribute defined for the cluster.

Throws:

NoAttributeFoundException - when invalid attrName is passed in as the parameter or the attrName do not exist.

getClusterAttributeList

List getClusterAttributeList()

Returns the list of Cluster Attributes defined for the cluster.

Returns:

a list of attributes

getClusterEncryptedAttribute

String getClusterEncryptedAttribute(String attrName)
                                    throws NoAttributeFoundException

Returns the value for an encrypted cluster attribute.

Parameters:

attrName - attribute name of a cluster attribute defined for the cluster.

Throws:

NoAttributeFoundException - when invalid attrName is passed in as the parameter or the attrName do not exist.

getClusterName

String getClusterName()

Returns the name of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

name of the cluster on which the service is running

getClusterDomainName

String getClusterDomainName()

Returns the domain name of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

domain name of the cluster on which the service is running

getClusterHost

String getClusterHost()

Returns the IP address of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

IP address of the cluster on which the service is running

getClusterDescription

String getClusterDescription()

Returns the description of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

description of the cluster on which the service is running

getClusterProfileID

Long getClusterProfileID()

Returns the profile ID of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

profile ID of the cluster on which the service is running

getClusterProfileName

String getClusterProfileName()

Returns the cluster profile name of the cluster that includes the Avaya Breeze server instance on which the service is running.

Returns:

profile name of the cluster on which the service is running