Package com.ptc.customersupport.mbeans.plugins

Class AbstractReportingPlugin

java.lang.Object

javax.management.StandardMBean

wt.jmx.core.StandardMBean

wt.jmx.core.SelfAwareMBean

com.ptc.customersupport.mbeans.AbstractPlugin

com.ptc.customersupport.mbeans.plugins.GatherFolderPlugin

com.ptc.customersupport.mbeans.plugins.AbstractReportingPlugin

All Implemented Interfaces:

PluginMBean, GatherFolderPluginMBean, DynamicMBean, MBeanRegistration, BaseObjectNamed, SelfEmailingMBean

Direct Known Subclasses:

ReportingInstallerFolderPlugin, ReportingInstlogFolderPlugin, ReportingLogsFolderPlugin

public abstract class AbstractReportingPlugin
extends GatherFolderPlugin

An abstract class used by plugins that are common to WBR (Windchill Business Reporting). These plugins rely on common WBR pathing information provided by this class. This class wraps common functionality needed for WBR plugin execution.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
abstract String	getSubDirectory()	An abstract method that all children must implement.

Methods inherited from class wt.jmx.core.SelfAwareMBean

deregister, destroy, getBaseObjectName, getObjectName, getObjectNameOnPreRegister, getOwnerMBean, getSelfAwareMBean, init, isInited, isRegistered, isStarted, onDestroy, onInit, onStart, onStop, postDeregister, postRegister, preDeregister, preRegister, register, register, register, resetObjectName, setOwnerMBean, start, stop

Methods inherited from class wt.jmx.core.StandardMBean

cacheMBeanInfo, cacheMBeanInfoInInstance, createMBeanInfo, emailThisMBean, getAttributes, getCachedInstanceMBeanInfo, getCachedMBeanInfo, getDescription, getDescription, getDescription, getDescription, getImpact, getMBeanInfo, getParameterName, setAttributes

Methods inherited from class javax.management.StandardMBean

getAttribute, getClassName, getConstructors, getDescription, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, invoke, setAttribute, setImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ptc.customersupport.mbeans.PluginMBean

areDbCredentialsNeeded, areWindchillCredentialsNeeded, getClusterAware, getCompressOutput, getConfigFileName, getDateRangeUsed, getDescription, getDisplayName, getMBeanName, getName, getPluginType, getPluginVersion, setClusterAware, setCompressOutput, setDatabaseCredentials, setDateRangeUsed, setDisplayName, setMBeanName

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

emailThisMBean

Method Details

getSubDirectory

public abstract String getSubDirectory()

An abstract method that all children must implement. This methods implementation must return a valid WBR subdirectory location where the plugin data to be collected from originates. Care must be ensured during method implmentation that this value is provided accurately as the collect(...) methods for plugins of this type rely on this subdirectory as the data collection originator.

Returns:

The WBR subdirectory as a String of the location the data to be collected originates from.

Supported API: true