AcsJException (ACS-2016.6)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - alma.acs.exceptions.AcsJException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DefaultAcsJException, Objects.MyAcsJException
```
public abstract class AcsJException
extends java.lang.Exception
```
Base class for any checked exceptions defined in ALMA Java code. Allows these Java exceptions to be interoperable with the ACS error system, i.e. that they can be converted to and from ErrorTrace or ACSException objects. See AcsJException(ErrorTrace), getErrorTrace(), #getACSException.
Not to be confused with alma.ACSErr.ACSException, which is a CORBA user exception with an alma.ACSErr.ErrorTrace inside. ACSException is declared as final, so that it's not an option to make our AcsJException a subclass of it. (todo check if that's due to OMG spec or JacORB).
For the conversion to and from the CORBA exception types, two ErrorTrace properties (i.e. NameValue objects referenced from ErrorTrace#data) are added:
- javaex.class to store the exception class for later reconstruction
- javaex.msg to store the message text provided in the various constructors of Throwable and subclasses.
  TODO check why there is no such field available already in ErrorTrace, is there really no unique way of transporting text messages in addition to error types and codes??
Author:

hsommer Jun 18, 2003 1:07:38 PM

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`m_file`
`protected java.lang.String`	`m_host`
`protected int`	`m_line`
`protected java.lang.String`	`m_method`
`protected java.lang.String`	`m_process`
`protected java.util.Properties`	`m_properties`
`protected Severity`	`m_severity`
`protected java.lang.String`	`m_sourceObject`
`protected java.lang.String`	`m_threadName`
`protected long`	`m_timeMilli`

Constructor Summary

Constructors
Constructor and Description
`AcsJException()`
`AcsJException(ErrorTrace etCause)`
`AcsJException(java.lang.String message)`
`AcsJException(java.lang.String message, ErrorTrace etCause)` Creates a new exception, with the chain of causing exceptions derived from `etCause`.
`AcsJException(java.lang.String message, java.lang.Throwable cause)` Constructor from another exception, with a message.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ErrorTrace`	`createSingleErrorTrace()` Creates an `ErrorTrace` object that represents this exception.
`static ErrorTrace`	`createSingleErrorTrace(java.lang.Throwable thr, long defaultTimeMilli)` Converts a Throwable that may not be an AcsJException to an `ErrorTrace`.
`protected abstract int`	`getErrorCode()` Forces a subclass to choose an ACS error code.
`ErrorTrace`	`getErrorTrace()` Converts this exception (and all "caused-by" throwables it might have) to an `ErrorTrace` that links to its caused-by `ErrorTrace` objects.
`protected abstract int`	`getErrorType()` Forces a subclass to choose an ACS error type.
`java.lang.String`	`getFile()`
`java.lang.String`	`getHost()`
`int`	`getLine()`
`java.lang.String`	`getMethod()`
`NameValue[]`	`getNameValueArray()` To be used by `getErrorTrace()` or whoever else cares about a `NameValue[]`.
`java.lang.String`	`getProcess()`
`java.lang.String`	`getProperty(java.lang.String key)`
`Severity`	`getSeverity()` Returns the Severity level currently associated with this exception instance.
`java.lang.String`	`getShortDescription()` Returns the short description which is a hardcoded text particular for a (type, code) combination.
`java.lang.String`	`getSourceObject()`
`java.lang.String`	`getThreadName()`
`long`	`getTimestampMillis()` Gets the timestamp when this exception was created.
`int`	`getTraceDepth()` Gets the total number of linked ("caused-by") exceptions including this one.
`void`	`log(java.util.logging.Logger logger)` Logs this exception and all causing exceptions.
`static void`	`setProcessName(java.lang.String name)` If we have some better name than "java", for example the unique name of the java container.
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.String value)` Allows extra information to be attached to the exception.
`void`	`setSeverity()` Sets the default severity level to `Severity#Error`.
`AcsJCompletion`	`toAcsJCompletion()` Creates an AcsJCompletion that contains this exception.
`abstract org.omg.CORBA.UserException`	`toCorbaException()` Creates a CORBA `UserException` from this exception.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_host
```
protected java.lang.String m_host
```
  - m_process
```
protected java.lang.String m_process
```
  - m_line
```
protected int m_line
```
  - m_method
```
protected java.lang.String m_method
```
  - m_file
```
protected java.lang.String m_file
```
  - m_sourceObject
```
protected java.lang.String m_sourceObject
```
  - m_threadName
```
protected java.lang.String m_threadName
```
  - m_severity
```
protected Severity m_severity
```
  - m_properties
```
protected java.util.Properties m_properties
```
  - m_timeMilli
```
protected long m_timeMilli
```
- Constructor Detail
  - AcsJException
```
public AcsJException()
```
  - AcsJException
```
public AcsJException(java.lang.String message)
```
  - AcsJException
```
public AcsJException(java.lang.String message,
                     java.lang.Throwable cause)
```
    Constructor from another exception, with a message. Subclass ctors call this ctor even if the message is null, to avoid the Throwable#ctor taking the cause.toString() as the message.
    If cause is a CORBA exception generated by the ACS error system, then its ErrorTrace is automatically converted to a chain of AcsJ-style exceptions.
    
    Parameters:
    
    cause - the causing exception
    
    See Also:
    
    CorbaExceptionConverter.convertHiddenErrorTrace(Throwable)
  - AcsJException
```
public AcsJException(ErrorTrace etCause)
```
  - AcsJException
```
public AcsJException(java.lang.String message,
                     ErrorTrace etCause)
```
    Creates a new exception, with the chain of causing exceptions derived from etCause.
    
    Parameters:
    
    message -
    
    etCause -
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Throwable
  - setProcessName
```
public static void setProcessName(java.lang.String name)
```
    If we have some better name than "java", for example the unique name of the java container.
    
    Parameters:
    
    name -
  - getErrorType
```
protected abstract int getErrorType()
```
    Forces a subclass to choose an ACS error type.
    
    Returns:
    
    the error type
  - getErrorCode
```
protected abstract int getErrorCode()
```
    Forces a subclass to choose an ACS error code.
    
    Returns:
    
    the error code
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Returns the short description which is a hardcoded text particular for a (type, code) combination. The subclass that represents the exception code will have to override this method. This method is not abstract because the exception class that corresponds to an error type (but not an error code) would otherwise have to overload it with returning an empty string.
  - toCorbaException
```
public abstract org.omg.CORBA.UserException toCorbaException()
```
    Creates a CORBA UserException from this exception.
    Subclasses must return their associated UserException with an ErrorTrace member.
    By convention, subclasses must also implement another method that returns the correct subtype of UserException. No problem with a code generator of course...
  - toAcsJCompletion
```
public AcsJCompletion toAcsJCompletion()
```
    Creates an AcsJCompletion that contains this exception.
    
    Returns:
    
    A completion object for which AcsJCompletion.getAcsJException() will yield this exception.
  - setSeverity
```
public void setSeverity()
```
    Sets the default severity level to Severity#Error. May be overridden by a subclass to set the default severity for that exception, or may be called from application code to set it for a specific exception instance.
  - getSeverity
```
public Severity getSeverity()
```
    Returns the Severity level currently associated with this exception instance.
    
    Returns:
    
    Severity
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.String value)
```
    Allows extra information to be attached to the exception.
    
    Returns:
    
    the previous value of the specified key in this property list, or null if it did not have one.
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    See Also:
    
    setProperty(java.lang.String, java.lang.String)
  - getNameValueArray
```
public NameValue[] getNameValueArray()
```
    To be used by getErrorTrace() or whoever else cares about a NameValue[].
  - getTimestampMillis
```
public long getTimestampMillis()
```
    Gets the timestamp when this exception was created.
    
    Returns:
    
    timestamp in milliseconds (Java-UTC time, 1970)
  - getErrorTrace
```
public ErrorTrace getErrorTrace()
```
    Converts this exception (and all "caused-by" throwables it might have) to an ErrorTrace that links to its caused-by ErrorTrace objects.
    To be used whenever the Corba wall is hit and the Java exception must be converted to an ACS-Corba-exception.
  - createSingleErrorTrace
```
protected ErrorTrace createSingleErrorTrace()
```
    Creates an ErrorTrace object that represents this exception. Linked exceptions are not considered, so the returned ErrorTrace.previousError is left as null.
  - createSingleErrorTrace
```
public static ErrorTrace createSingleErrorTrace(java.lang.Throwable thr,
                                                long defaultTimeMilli)
```
    Converts a Throwable that may not be an AcsJException to an ErrorTrace.
    For example, thr could be a NullPointerException thrown in the same process and thus not yet converted to DefaultAcsJException, but wrapped by some subclass of AcsJException which contains the NPE as its cause.
    
    Parameters:
    
    defaultTimeMilli - Java-time (1970-based) used to estimate a time stamp if none is available, in order to avoid something from October 1582 in the new ErrorTrace. Typically the timestamp from the wrapping AcsJException.
    
    See Also:
    
    createSingleErrorTrace()
  - log
```
public void log(java.util.logging.Logger logger)
```
    Logs this exception and all causing exceptions. For each such exception, a separate log entry is created, in accordance with the ACS error logging specification.
    
    Parameters:
    
    logger - the JDK logger to be used for logging this exception.
  - getTraceDepth
```
public int getTraceDepth()
```
    Gets the total number of linked ("caused-by") exceptions including this one.
    Not to be confused with the length of Throwable.getStackTrace(), which refers to the call stack for the current exception, and not to linked causing exception.
  - getFile
```
public java.lang.String getFile()
```
    Returns:
    
    Returns the m_file.
  - getHost
```
public java.lang.String getHost()
```
    Returns:
    
    Returns the m_host.
  - getLine
```
public int getLine()
```
    Returns:
    
    Returns the m_line.
  - getMethod
```
public java.lang.String getMethod()
```
    Returns:
    
    Returns the m_method.
  - getProcess
```
public java.lang.String getProcess()
```
    Returns:
    
    Returns the m_process.
  - getThreadName
```
public java.lang.String getThreadName()
```
    Returns:
    
    Returns the m_threadName.
  - getSourceObject
```
public java.lang.String getSourceObject()
```
    Returns:
    
    Returns the m_sourceObject.

Class AcsJException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

m_host

m_process

m_line

m_method

m_file

m_sourceObject

m_threadName

m_severity

m_properties

m_timeMilli

Constructor Detail

AcsJException

AcsJException

AcsJException

AcsJException

AcsJException

Method Detail

toString

setProcessName

getErrorType

getErrorCode

getShortDescription

toCorbaException

toAcsJCompletion

setSeverity

getSeverity

setProperty

getProperty

getNameValueArray

getTimestampMillis

getErrorTrace

createSingleErrorTrace

createSingleErrorTrace

log

getTraceDepth

getFile

getHost

getLine

getMethod

getProcess

getThreadName

getSourceObject