Interface DiagnosticService

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag

public interface DiagnosticService extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
  • Method Details

    • getComputeChecksum

      String getComputeChecksum()
      Gets the value of the computeChecksum property.

      Boolean attribute. Indicates whether checksum of binaries is computed.

      Returns:
      possible object is String
    • setComputeChecksum

      void setComputeChecksum(String computeChecksum) throws PropertyVetoException
      Sets the value of the computeChecksum property.
      Parameters:
      computeChecksum - allowed object is String
      Throws:
      PropertyVetoException
    • getVerifyConfig

      String getVerifyConfig()
      Gets the value of the verifyConfig property.

      A Boolean attribute which indicates whether output of verify-config asadmin command is included in the diagnostic report.

      Returns:
      possible object is String
    • setVerifyConfig

      void setVerifyConfig(String verifyConfig) throws PropertyVetoException
      Sets the value of the verifyConfig property.
      Parameters:
      verifyConfig - allowed object is String
      Throws:
      PropertyVetoException
    • getCaptureInstallLog

      String getCaptureInstallLog()
      Gets the value of the captureInstallLog property.

      Boolean attribute which indicated whether the log generated during installation of the application server is captured.

      Returns:
      possible object is String
    • setCaptureInstallLog

      void setCaptureInstallLog(String captureInstallLog) throws PropertyVetoException
      Sets the value of the captureInstallLog property.
      Parameters:
      captureInstallLog - allowed object is String
      Throws:
      PropertyVetoException
    • getCaptureSystemInfo

      String getCaptureSystemInfo()
      Gets the value of the captureSystemInfo property.

      Boolean attribute which specifies whether OS level information is collected as part of diagnostic report.

      Returns:
      possible object is String
    • setCaptureSystemInfo

      void setCaptureSystemInfo(String captureSystemInfo) throws PropertyVetoException
      Sets the value of the captureSystemInfo property.
      Parameters:
      captureSystemInfo - allowed object is String
      Throws:
      PropertyVetoException
    • getCaptureHadbInfo

      String getCaptureHadbInfo()
      Gets the value of the captureHadbInfo property.

      Boolean attribute to indicate if HADB related information is collected.

      Returns:
      possible object is String
    • setCaptureHadbInfo

      void setCaptureHadbInfo(String captureHadbInfo) throws PropertyVetoException
      Sets the value of the captureHadbInfo property.
      Parameters:
      captureHadbInfo - allowed object is String
      Throws:
      PropertyVetoException
    • getCaptureAppDd

      String getCaptureAppDd()
      Gets the value of the captureAppDd property.

      Boolean attribute. If true, application deployment descriptors in plain text are captured as part of diagnostic report. If Deployment descriptors contain any confidential information, it's recommended to set it to false.

      Returns:
      possible object is String
    • setCaptureAppDd

      void setCaptureAppDd(String captureAppDd) throws PropertyVetoException
      Sets the value of the captureAppDd property.
      Parameters:
      captureAppDd - allowed object is String
      Throws:
      PropertyVetoException
    • getMinLogLevel

      String getMinLogLevel()
      Gets the value of the minLogLevel property.

      The log levels can be changed using one of the seven levels. Please refer JSR 047 to understand the Log Levels. The default level is INFO, meaning that messages at that level or higher (WARNING, SEVERE) are captured as part of the diagnostic report. If set to OFF, log contents will not be captured as part of diagnostic report.

      Returns:
      possible object is String
    • setMinLogLevel

      void setMinLogLevel(String minLogLevel) throws PropertyVetoException
      Sets the value of the minLogLevel property.
      Parameters:
      minLogLevel - allowed object is String
      Throws:
      PropertyVetoException
    • getMaxLogEntries

      @Min(0L) @Min(0L) String getMaxLogEntries()
      Gets the value of the maxLogEntries property.

      Max number of log entries being captured as part of diagnostic report. A non-negative value.

      Returns:
      possible object is String
    • setMaxLogEntries

      void setMaxLogEntries(String maxLogEntries) throws PropertyVetoException
      Sets the value of the maxLogEntries property.
      Parameters:
      maxLogEntries - allowed object is String
      Throws:
      PropertyVetoException
    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag
    • getExtensions

    • getExtensionByType

      default <T extends DiagnosticServiceExtension> T getExtensionByType(Class<T> type)
      Get an extension of the specified type.

      If there is more than one, it is undefined as to which one is returned.