wt.jmx.core.mbeans
Interface TechSupportMBean


public interface TechSupportMBean

Provides operation(s) to mass e-mail data and files to PTC technical support.

Supported API: true

Extendable: true


Method Summary
 void emailFilesToSupport(long callNumber)
          E-mail JMX management bean (MBean) data and registered log directories to PTC technical support for all nodes in the cluster -- and with no additional e-mail recipients.
 void emailFilesToSupport(long callNumber, String additionalRecipients, boolean mailMBeans, boolean mailLogDirs, boolean forFullCluster)
          E-mail JMX management bean (MBean) data and/or registered log directories to PTC technical support.
 String getEmailAddress()
          E-mail address of PTC technical support

Supported API: true
 int getMaxAgeInDaysOfLogsToEmail()
          Maximum age (in days) of log files to e-mail

Supported API: true
 void setMaxAgeInDaysOfLogsToEmail(int maxAgeInDaysOfLogsToEmail)
          Maximum age (in days) of log files to e-mail

Supported API: true
 

Method Detail

getEmailAddress

String getEmailAddress()
E-mail address of PTC technical support

Supported API: true


getMaxAgeInDaysOfLogsToEmail

int getMaxAgeInDaysOfLogsToEmail()
Maximum age (in days) of log files to e-mail

Supported API: true


setMaxAgeInDaysOfLogsToEmail

void setMaxAgeInDaysOfLogsToEmail(int maxAgeInDaysOfLogsToEmail)
Maximum age (in days) of log files to e-mail

Supported API: true


emailFilesToSupport

void emailFilesToSupport(long callNumber)
                         throws Exception
E-mail JMX management bean (MBean) data and registered log directories to PTC technical support for all nodes in the cluster -- and with no additional e-mail recipients.

Supported API: true

Parameters:
callNumber - Number of PTC technical support call this data is related to (without the leading "C")
Throws:
Exception

emailFilesToSupport

void emailFilesToSupport(long callNumber,
                         String additionalRecipients,
                         boolean mailMBeans,
                         boolean mailLogDirs,
                         boolean forFullCluster)
                         throws Exception
E-mail JMX management bean (MBean) data and/or registered log directories to PTC technical support.

Supported API: true

Parameters:
callNumber - Number of PTC technical support call this data is related to (without the leading "C")
additionalRecipients - E-mail addresses (or e-mail list) to send to in addition to PTC technical support
mailMBeans - Whether JMX management bean (MBean) data dumps should be generated and e-mailed
mailLogDirs - Whether registered logs directories should be e-mailed
forFullCluster - Whether e-mail operation should be performed for each node in the cluster (when false operation is only applied to this process)
Throws:
Exception