Package 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 Details

    • 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

      @MBeanOperationImpact(0) String[] viewFile() throws IOException
      View last reasonable portion of this file

      Supported API: true
      Throws:
      IOException

    • searchFile

      @MBeanOperationImpact(0) String[] searchFile(String searchRegexp, boolean numberLines) throws IOException
      View portions of this file that match a specified regular expression.

      Supported API: true
      Parameters:
      searchRegexp - Regular expression to search with
      numberLines - Whether resulting lines should include original line numbers
      Throws:
      IOException

    • emailClusterPropertyComparison

      @MBeanOperationImpact(0) void emailClusterPropertyComparison(String addressesOrEmailList) throws Exception
      Compare properties across a cluster and email the results.
      Parameters:
      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

    • emailDefaultPropertyValueComparison

      @MBeanOperationImpact(0) void emailDefaultPropertyValueComparison(String addressesOrEmailList, boolean skipPropsWODefaults) throws Exception
      Compare current property values to default values and email the results.
      Parameters:
      addressesOrEmailList - The addresses or list to send the results to.
      skipPropsWODefaults - Flag for whether or not to include properties that don't have default values in the out put.
      Throws:
      Exception - If there are any errors during the comparison or sending the email with the results.

      Supported API: true

    • emailFile

      @MBeanOperationImpact(0) 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

    • sendFileToSupport

      @MBeanOperationImpact(0) void sendFileToSupport(long callNumber, String description) throws Exception
      Send file to technical support

      Supported API: true
      Parameters:
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      Throws:
      Exception

    • getProperty

      @MBeanOperationImpact(0) String[] getProperty(String propertyName) throws Exception
      Retrieve the value of a property

      Supported API: true
      Parameters:
      propertyName - Property to retrieve
      Throws:
      Exception

    • reviewPendingChanges

      @MBeanOperationImpact(0) String[] reviewPendingChanges()
      Review pending property changes

      Supported API: true

    • applyPendingChanges

      @MBeanOperationImpact(1) void applyPendingChanges() throws Exception
      Apply pending property changes

      Supported API: true
      Throws:
      Exception

    • clearPendingChanges

      @MBeanOperationImpact(1) void clearPendingChanges()
      Clear pending property changes

      Supported API: true

    • setCmpClusterPropsStyleSheet

      void setCmpClusterPropsStyleSheet(String newStyleSheet)
      Set the stylesheet used to generate the cluster property comparison output.
      Parameters:
      newStyleSheet - The path, relative to codebase, of the new stylesheet.

      Supported API: true

    • getCmpClusterPropsStyleSheet

      String getCmpClusterPropsStyleSheet()
      Get the stylesheet used to generate the cluster property comparison output.
      Returns:
      The path, relative to codebase, of the new stylesheet.

      Supported API: true

    • setCmpDefaultPropValuesStylesheet

      void setCmpDefaultPropValuesStylesheet(String newStylesheet)
      Set the stylesheet used to generate the default property value comparison output.
      Parameters:
      newStylesheet - The path, relative to codebase, of the new stylesheet.

      Supported API: true

    • getCmpDefaultPropValuesStylesheet

      String getCmpDefaultPropValuesStylesheet()
      Get the stylesheet used to generate the default property value comparison output.
      Returns:
      The path, relative to codebase, of the stylesheet.

      Supported API: true

    • collectProperties

      @MBeanOperationImpact(0) Map<String,Map<String,String>> collectProperties() throws IOException
      Collect properties managed by this MBean.
      Returns:
      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