wt.util.jmx
Interface AbstractPropertiesManagerMBean

All Superinterfaces:

AbstractFileViewMBean, SelfEmailingMBean

All Known Subinterfaces:

PropertiesEditorMBean, PropertiesManagerMBean

public interface AbstractPropertiesManagerMBean
extends AbstractFileViewMBean

MBean for managing Windchill properties

Supported API: true

Extendable: true

Method Summary

void	applyPendingChanges() Apply pending property changes Supported API: true
void	clearPendingChanges() Clear pending property changes Supported API: true
Map<String,Properties>	collectProperties() Collect properties managed by this MBean.
void	emailClusterPropertyComparison(String addressesOrEmailList) Compare properties across a cluster and email the results.
void	emailFile(String addressesOrEmailList, String subject) E-mail file Supported API: true
String	getCmpPropsStyleSheet() Get the stylesheet used to generate the cluster property comparison output.
String	getLogger() Name of logger Supported API: true
String	getLogLevel() Log level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
String[]	getProperty(String propertyName) Retrieve the value of a property Supported API: true
long	getSize() Size of file (in bytes) Supported API: true
String[]	reviewPendingChanges() Review pending property changes Supported API: true
void	setCmpPropsStyleSheet(String newStyleSheet) Set the stylesheet used to generate the cluster property comparison output.
void	setLogLevel(String logLevel) Log level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
String[]	viewFile() View last reasonable portion of this file Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.AbstractFileViewMBean

getLastModifiedTime, getName, getPath, isExists

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Method Detail

getSize

long getSize()

Size of file (in bytes)

Supported API: true

getLogger

String getLogger()

Name of logger

Supported API: true

getLogLevel

String getLogLevel()

Log level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true

setLogLevel

void setLogLevel(String logLevel)

Log level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true

viewFile

String[] viewFile()
                  throws IOException

View last reasonable portion of this file

Supported API: true

Throws:

IOException

emailClusterPropertyComparison

void emailClusterPropertyComparison(String addressesOrEmailList)
                                    throws Exception

Compare properties across a cluster and email the results.

Parameters:

String - addressesOrEmailList - The addresses or list to send the results to.

Throws:

Exception - - If there are any errors comparing across the cluster or sending the email with the results.

Supported API: true

emailFile

void emailFile(String addressesOrEmailList,
               String subject)
               throws IOException

E-mail file

Supported API: true

Parameters:

addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to

subject - Subject to give e-mail

Throws:

IOException

getProperty

String[] getProperty(String propertyName)
                     throws Exception

Retrieve the value of a property

Supported API: true

Parameters:

propertyName - Property to retrieve

Throws:

Exception

reviewPendingChanges

String[] reviewPendingChanges()

Review pending property changes

Supported API: true

applyPendingChanges

void applyPendingChanges()
                         throws Exception

Apply pending property changes

Supported API: true

Throws:

Exception

clearPendingChanges

void clearPendingChanges()

Clear pending property changes

Supported API: true

setCmpPropsStyleSheet

void setCmpPropsStyleSheet(String newStyleSheet)

Set the stylesheet used to generate the cluster property comparison output.

Parameters:

String - newStyleSheet - The path, relative to codebase, of the new stylesheet.

Supported API: true

getCmpPropsStyleSheet

String getCmpPropsStyleSheet()

Get the stylesheet used to generate the cluster property comparison output.

Returns:

String - The path, relative to codebase, of the new stylesheet.

Supported API: true

collectProperties

Map<String,Properties> collectProperties()
                                         throws IOException

Collect properties managed by this MBean.

Returns:

Map - Map containing all property files, and their properties, managed by this MBean. The file path, relative to WT_HOME, of each property file managed by this MBean is the key. And each file's properties is the value.

Supported API: true

Throws:

IOException