All Implemented Interfaces:
Serializable

public class FileException extends ConnectorCheckedException
The FileException is thrown by the connector when it is not possible to retrieve the requested file.
See Also:
  • Constructor Details

    • FileException

      public FileException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileName)
      This is the typical constructor used for creating an exception.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      fileName - name of the invalid parameter if known
    • FileException

      public FileException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileName, Map<String,Object> relatedProperties)
      This is the typical constructor used for creating an exception.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      fileName - name of the invalid parameter if known
      relatedProperties - arbitrary properties that may help with diagnosing the problem.
    • FileException

      public FileException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileName)
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - the error that resulted in this exception.
      fileName - name of the invalid parameter if known
    • FileException

      public FileException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileName, Map<String,Object> relatedProperties)
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - the error that resulted in this exception.
      fileName - name of the invalid parameter if known
      relatedProperties - arbitrary properties that may help with diagnosing the problem.
    • FileException

      public FileException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, String fileName, Map<String,Object> relatedProperties)
      This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.
      Parameters:
      httpCode - http response code to use if this exception flows over a REST call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      errorMessageId - unique identifier for the message
      errorMessageParameters - parameters that were inserted in the message
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      caughtErrorClassName - previous error causing this exception
      fileName - name of the invalid parameter if known
      relatedProperties - arbitrary properties that may help with diagnosing the problem.
    • FileException

      @Deprecated public FileException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String fileName)
      Deprecated.
      This is the typical constructor used for creating an exception.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      fileName - name of the invalid parameter if known
    • FileException

      @Deprecated public FileException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Exception caughtError, String fileName)
      Deprecated.
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      caughtError - the error that resulted in this exception.
      fileName - name of the invalid parameter if known
  • Method Details

    • getFileName

      public String getFileName()
      Return the invalid parameter's name, if known.
      Returns:
      string name
    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class OCFCheckedExceptionBase
      Returns:
      string of property names and values for this enum
    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class OCFCheckedExceptionBase
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison
    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class OCFCheckedExceptionBase
      Returns:
      int hash code