Package com.ptc.windchill.enterprise.report.jmx

Interface ReportingSystemMonitorMBean

All Superinterfaces:
SelfEmailingMBean
public interface ReportingSystemMonitorMBean extends SelfEmailingMBean
Exposes health information and administrative operations for third-party reporting system; can be deployed in servlet engine or method servers.

Supported API: true

Extendable: true

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NO_RESPONSE_NOTIF_TYPE
    Type of notification produced when reporting system does not respond to a ping

    Supported API: true
    static final String
    RESPONDING_NOTIF_TYPE
    Type of notification produced when reporting system is responding after a period of being unresponsive

    Supported API: true

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    exposeReports()
    Creates and/or modifies Report objects as necessary to reflect report tasks, ReportTemplate objects, and third party report objects as appropriate; returns number of reports created or modified.
    CompositeData
    getModelUpdateInfo()
    Information about the last update of the reporting model

    Supported API: true
    CompositeData
    getPingData()
    Data regarding results of periodic pings of reporting system (as controlled by PingIntervalSeconds)

    Supported API: true
    int
    getPingIntervalSeconds()
    Interval at which reporting system is pinged (in seconds); periodic pings are disabled if this is non-positive

    Supported API: true
    boolean
    isReportingSystemEnabled()
    Whether third-party reporting system is currently enabled.
    long
    pingReportingSystem()
    Ping third-party reporting system and elapsed milliseconds of ping; throws exception or returns negative numbers when third-party reporting system is unreachable.
    void
    resetPingData()
    Reset PingData.
    void
    setPingIntervalSeconds(int pingInterval)
    Interval at which reporting system is pinged (in seconds); periodic pings are disabled if this is non-positive

    Supported API: true
    void
    updateModel()
    Update third-party reporting system's knowledge of Windchill data model.

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

    emailThisMBean

  • Field Details

    • NO_RESPONSE_NOTIF_TYPE

      static final String NO_RESPONSE_NOTIF_TYPE
      Type of notification produced when reporting system does not respond to a ping

      Supported API: true

    • RESPONDING_NOTIF_TYPE

      static final String RESPONDING_NOTIF_TYPE
      Type of notification produced when reporting system is responding after a period of being unresponsive

      Supported API: true

  • Method Details

    • isReportingSystemEnabled

      boolean isReportingSystemEnabled()
      Whether third-party reporting system is currently enabled.

      Supported API: true

    • getModelUpdateInfo

      CompositeData getModelUpdateInfo() throws Exception
      Information about the last update of the reporting model

      Supported API: true
      Throws:
      Exception

    • getPingIntervalSeconds

      int getPingIntervalSeconds()
      Interval at which reporting system is pinged (in seconds); periodic pings are disabled if this is non-positive

      Supported API: true

    • setPingIntervalSeconds

      void setPingIntervalSeconds(int pingInterval)
      Interval at which reporting system is pinged (in seconds); periodic pings are disabled if this is non-positive

      Supported API: true

    • getPingData

      CompositeData getPingData()
      Data regarding results of periodic pings of reporting system (as controlled by PingIntervalSeconds)

      Supported API: true

    • pingReportingSystem

      @MBeanOperationImpact(0) long pingReportingSystem() throws Exception
      Ping third-party reporting system and elapsed milliseconds of ping; throws exception or returns negative numbers when third-party reporting system is unreachable.

      Supported API: true
      Throws:
      Exception

    • resetPingData

      @MBeanOperationImpact(1) void resetPingData()
      Reset PingData.

      Supported API: true

    • updateModel

      @MBeanOperationImpact(1) void updateModel() throws Exception
      Update third-party reporting system's knowledge of Windchill data model.

      Supported API: true
      Throws:
      Exception

    • exposeReports

      @MBeanOperationImpact(1) int exposeReports() throws Exception
      Creates and/or modifies Report objects as necessary to reflect report tasks, ReportTemplate objects, and third party report objects as appropriate; returns number of reports created or modified.

      Supported API: true
      Throws:
      Exception