Skip navigation links

oracle.imaging
Class ImagingException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.imaging.ImagingException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InputAgentException, ValidationException

@WebFault
public class ImagingException

extends java.lang.Exception

The exception repositoryType thrown by the imaging service APIs.

See Also:

Serialized Form

Nested Class Summary

static class

ImagingException.LoggingWrapper

Field Summary

protected static java.lang.String	EXCEPTION_LOGGER
protected ImagingFaultInfo	faultInfo Fault payload containing the exception code.

Constructor Summary

ImagingException(java.util.Locale locale, java.lang.String exceptionCode, java.lang.String... args)
Constructor that performs a message bundle lookup to translate the message text for the given exception code.

ImagingException(java.util.Locale locale, java.lang.Throwable cause)
Constructor that builds an exception to pass through the details of an existiong exception.

ImagingException(java.util.Locale locale, java.lang.Throwable cause, java.lang.String exceptionCode, java.lang.String... args)
Constructor that performs a message bundle lookup to translate the message text for the given exception code.

ImagingException(java.lang.String message, ImagingFaultInfo faultInfo)
Constructor required by the JSR 224 @WebFault specification.

ImagingException(java.lang.String message, ImagingFaultInfo faultInfo, java.lang.Throwable cause)
Constructor required by the JSR 224 @WebFault specification.

Method Summary

void	generateStackTraceId() FOR INTERNAL USE ONLY
java.lang.String	getDetailedMessage() Deprecated.
static java.lang.String	getErrorMessage(java.lang.String exceptionCode, java.lang.String[] args, java.util.Locale locale) Helper method to perform the message bundle lookup to resolve the message text for a given error code
java.lang.String	getExceptionCode()
java.lang.String	getExceptionLabel()
java.util.List<ImagingFaultDetail>	getFaultDetails()
ImagingFaultInfo	getFaultInfo() Accessor method required by the JSR 224 @WebFault specification.
ImagingFaultType	getFaultType()
java.lang.String	getLocalizedMessage()
java.lang.String	getStackTraceId() FOR INTERNAL USE ONLY
protected void	logException(java.lang.Throwable cause, java.lang.Object[] messageArgs, java.util.logging.Level logLevel, boolean forceLogging) Log the exception.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_LOGGER

protected static final java.lang.String EXCEPTION_LOGGER

See Also:

Constant Field Values

faultInfo

protected ImagingFaultInfo faultInfo

Fault payload containing the exception code. This is the fault info payload required by JSR 224 @WebFault.

Constructor Detail

ImagingException

public ImagingException(java.lang.String message,
                        ImagingFaultInfo faultInfo)

Constructor required by the JSR 224 @WebFault specification. It should only be called by the JAX-WS infrastructure to map this exception to and from a SOAPFault. Although required to be public, this method should not be called directly.

Parameters:

message - The message text for the exception

faultInfo - The @WebFault fault info payload

ImagingException

public ImagingException(java.lang.String message,
                        ImagingFaultInfo faultInfo,
                        java.lang.Throwable cause)

Constructor required by the JSR 224 @WebFault specification. It should only be called by the JAX-WS infrastructure to map this exception to and from a SOAPFault. Although required to be public, this method should not be called directly.

Parameters:

message - The message text for the exception

faultInfo - The @WebFault fault info payload

cause - A Throwable to be encapsulated by this exception

ImagingException

public ImagingException(java.util.Locale locale,
                        java.lang.String exceptionCode,
                        java.lang.String... args)

Constructor that performs a message bundle lookup to translate the message text for the given exception code.

Parameters:

locale - The locale to be used for the message text lookup

exceptionCode - The exception code for the expection. Must be an exception value defined in the Exceptions message bundle.

args - Arguments for the message.

ImagingException

public ImagingException(java.util.Locale locale,
                        java.lang.Throwable cause,
                        java.lang.String exceptionCode,
                        java.lang.String... args)

Constructor that performs a message bundle lookup to translate the message text for the given exception code.

Parameters:

locale - The locale to be used for the message text lookup

exceptionCode - The exception code for the expection. Must be an exception value defined in the Exceptions message bundle.

args - Arguments for the message.

ImagingException

public ImagingException(java.util.Locale locale,
                        java.lang.Throwable cause)

Constructor that builds an exception to pass through the details of an existiong exception. This should primarily be used to pass through the details of FdkException generated by The CDB subsystem. The code handles the cause member specially be reading its message, rather than translating based on an exception code

Parameters:

locale - A Locale for the localized message.

cause - A Throwable to be encapsulated by this exception. The message text for the exception will come from the getMessage method of this parameter.

Method Detail

getFaultInfo

public ImagingFaultInfo getFaultInfo()

Accessor method required by the JSR 224 @WebFault specification. It should only be called by the JAX-WS infrastructure to map this exception to and from a SOAPFault. Although required to be public, this method should not be called directly.

Returns:

The fault info payload

getExceptionCode

public java.lang.String getExceptionCode()

Returns:

The exception code for the exception.

getExceptionLabel

public java.lang.String getExceptionLabel()

getFaultType

public ImagingFaultType getFaultType()

Returns:

The fault repositoryType of the exception

getFaultDetails

public java.util.List<ImagingFaultDetail> getFaultDetails()

Returns:

Gets detailed information about the exception.

getErrorMessage

public static java.lang.String getErrorMessage(java.lang.String exceptionCode,
                                               java.lang.String[] args,
                                               java.util.Locale locale)

Helper method to perform the message bundle lookup to resolve the message text for a given error code

Parameters:

exceptionCode - The error code to lookup in the message bundle

args - Arguments for the message.

locale - The locale to be used for the lookup

Returns:

The resolved exception message string

logException

protected void logException(java.lang.Throwable cause,
                            java.lang.Object[] messageArgs,
                            java.util.logging.Level logLevel,
                            boolean forceLogging)

Log the exception. Uses the stack trace to determe the calling class and method. It finds the approprate Logger by pairing the package name from the calling class.

generateStackTraceId

public void generateStackTraceId()

FOR INTERNAL USE ONLY

Generates a stack trace identifier for use when the ImagingException is logged.

FOR INTERNAL USE ONLY

getStackTraceId

public java.lang.String getStackTraceId()

FOR INTERNAL USE ONLY

Returns a stack trace identifier for use when the ImagingException is logged.

FOR INTERNAL USE ONLY

getDetailedMessage

@Deprecated
public java.lang.String getDetailedMessage()

Deprecated.

Deprecated. Use toString().

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

Skip navigation links