com.ibm.datapower.wamt.amp
Class ErrorReport

java.lang.Object
  extended by com.ibm.datapower.wamt.amp.ErrorReport

public class ErrorReport
extends java.lang.Object

An error report is an object generated on the DataPower appliance that reports the running config, logs, and other pertinent data that can be used in debugging. There is a operation in AMP which supports generating and retrieving an error report from a domain on the device. This class represents the data that would be returned from Commands.getErrorReport(DeviceContext). Objects of this class are automatically instantiated by that getErrorReport method.


Field Summary
static java.lang.String COPYRIGHT_2009_2013
           
 
Constructor Summary
ErrorReport(java.lang.String domainName, java.lang.String location, java.lang.String name, byte[] reportFile)
          Create a new ErrorReport object.
 
Method Summary
 java.lang.String getDomainName()
          Get the name of the domain for which the error report was generated.
 java.lang.String getLocation()
          Get the path to the directory on the appliance where the report resides.
 java.lang.String getName()
          Get the filename of the error report as it resides on the appliance.
 byte[] getReportFile()
          Get the contents of the error report.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2013

public static final java.lang.String COPYRIGHT_2009_2013
See Also:
Constant Field Values
Constructor Detail

ErrorReport

public ErrorReport(java.lang.String domainName,
                   java.lang.String location,
                   java.lang.String name,
                   byte[] reportFile)
Create a new ErrorReport object. The following parameters are required.

Parameters:
domainName - the name of the domain from where the file was extracted
location - the directory from where the file was extracted
name - the name of the error report file as stored on the appliance
reportFile - the actual file, represented as a byte[]
Method Detail

getDomainName

public java.lang.String getDomainName()
Get the name of the domain for which the error report was generated.

Returns:
A domain name from the appliance

getLocation

public java.lang.String getLocation()
Get the path to the directory on the appliance where the report resides.

Returns:
the location (directory) where the error report file resides

getName

public java.lang.String getName()
Get the filename of the error report as it resides on the appliance.

Returns:
the filename of the error report

getReportFile

public byte[] getReportFile()
Get the contents of the error report.

Returns:
the error report as a byte array


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.