Package org.glassfish.jersey.internal
Class Errors
java.lang.Object
org.glassfish.jersey.internal.Errors
Errors utility used to file processing messages (e.g. validation, provider, resource building errors, hint).
Error filing methods (
#warning
, #error
, #fatal
) can be invoked only in the "error scope" which is
created by process(Producer)
or
processWithException(Producer)
methods. Filed error messages are present also in this
scope.
TODO do not use static thread local?-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Generic error message.static class
Error message exception. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate List<Errors.ErrorMessage>
_getErrorMessages
(boolean afterMark) private void
_mark()
private void
_reset()
private void
_unmark()
static void
Add an error to the list of messages.static void
Add an error to the list of messages.static void
Add a fatal error to the list of messages.static boolean
Check whether a fatal error is present in the list of all messages.static List<Errors.ErrorMessage>
Get the list of all error messages.static List<Errors.ErrorMessage>
getErrorMessages
(boolean afterMark) Get the list of error messages.private static Errors
static void
Add a hint to the list of messages.static boolean
logErrors
(boolean afterMark) Log errors and return a status flag indicating whether a fatal issue has been found in the error collection.private static boolean
logErrors
(Collection<Errors.ErrorMessage> errors) Log supplied errors and return a status flag indicating whether a fatal issue has been found in the error collection.static void
mark()
Set a mark at a current position in the errors messages list.private void
postProcess
(boolean throwException) private void
static void
Invoke given task and gather messages.static <T> T
Invoke given callable task and gather messages.private static <T> T
static <T> T
Invoke given producer task and gather errors.private static <T> T
private static void
processErrors
(boolean throwException) Log errors and throw an exception if there are any fatal issues detected and thethrowException
flag has been set totrue
.static void
processWithException
(Runnable task) Invoke given task and gather messages.static <T> T
processWithException
(Producer<T> producer) Invoke given producer task and gather messages.static void
reset()
Removes all issues that have been added since the last marked position as well as removes the last mark.static void
unmark()
Remove a previously set mark, if any.static void
Add a warning to the list of messages.
-
Field Details
-
LOGGER
-
errors
-
issues
-
mark
-
stack
private int stack
-
-
Constructor Details
-
Errors
private Errors()
-
-
Method Details
-
error
Add an error to the list of messages.- Parameters:
message
- message of the error.severity
- indicates severity of added error.
-
error
Add an error to the list of messages.- Parameters:
source
- source of the error.message
- message of the error.severity
- indicates severity of added error.
-
fatal
Add a fatal error to the list of messages.- Parameters:
source
- source of the error.message
- message of the error.
-
warning
Add a warning to the list of messages.- Parameters:
source
- source of the error.message
- message of the error.
-
hint
Add a hint to the list of messages.- Parameters:
source
- source of the error.message
- message of the error.
-
processErrors
private static void processErrors(boolean throwException) Log errors and throw an exception if there are any fatal issues detected and thethrowException
flag has been set totrue
.- Parameters:
throwException
- if set totrue
, any fatal issues will cause aErrors.ErrorMessagesException
to be thrown.
-
logErrors
public static boolean logErrors(boolean afterMark) Log errors and return a status flag indicating whether a fatal issue has been found in the error collection.The
afterMark
flag indicates whether only those issues should be logged that were added after amark has been set
.- Parameters:
afterMark
- iftrue
, only issues added after a mark has been set are returned, iffalse
all issues are returned.- Returns:
true
if there are any fatal issues present in the collection,false
otherwise.
-
logErrors
Log supplied errors and return a status flag indicating whether a fatal issue has been found in the error collection.- Parameters:
errors
- a collection of errors to be logged.- Returns:
true
if there are any fatal issues present in the collection,false
otherwise.
-
fatalIssuesFound
public static boolean fatalIssuesFound()Check whether a fatal error is present in the list of all messages.- Returns:
true
if there are any fatal issues in this error context,false
otherwise.
-
process
Invoke given producer task and gather errors. After the task is complete all gathered errors are logged. No exception is thrown even if there is a fatal error present in the list of errors.- Parameters:
producer
- producer task to be invoked.- Returns:
- the result produced by the task.
-
process
Invoke given callable task and gather messages. After the task is complete all gathered errors are logged. Any exception thrown by the throwable is re-thrown.- Parameters:
task
- callable task to be invoked.- Returns:
- the result produced by the task.
- Throws:
Exception
- exception thrown by the task.
-
processWithException
Invoke given producer task and gather messages. After the task is complete all gathered errors are logged. If there is a fatal error present in the list of errors anexception
is thrown.- Parameters:
producer
- producer task to be invoked.- Returns:
- the result produced by the task.
-
process
Invoke given task and gather messages. After the task is complete all gathered errors are logged. No exception is thrown even if there is a fatal error present in the list of errors.- Parameters:
task
- task to be invoked.
-
processWithException
Invoke given task and gather messages. After the task is complete all gathered errors are logged. If there is a fatal error present in the list of errors anexception
is thrown.- Parameters:
task
- task to be invoked.
-
process
-
process
- Throws:
Exception
-
getInstance
-
getErrorMessages
Get the list of all error messages.- Returns:
- non-null error message list.
-
getErrorMessages
Get the list of error messages.The
afterMark
flag indicates whether only those issues should be returned that were added after amark has been set
.- Parameters:
afterMark
- iftrue
, only issues added after a mark has been set are returned, iffalse
all issues are returned.- Returns:
- non-null error list.
-
mark
public static void mark()Set a mark at a current position in the errors messages list. -
unmark
public static void unmark()Remove a previously set mark, if any. -
reset
public static void reset()Removes all issues that have been added since the last marked position as well as removes the last mark. -
_mark
private void _mark() -
_unmark
private void _unmark() -
_reset
private void _reset() -
preProcess
private void preProcess() -
postProcess
private void postProcess(boolean throwException) -
_getErrorMessages
-