1 /*
2 * Copyright (c) 2012-2024, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.aspects.aj;
31
32 import com.jcabi.aspects.Immutable;
33 import com.jcabi.log.Logger;
34 import org.aspectj.lang.ProceedingJoinPoint;
35 import org.aspectj.lang.annotation.Around;
36 import org.aspectj.lang.annotation.Aspect;
37 import org.aspectj.lang.reflect.MethodSignature;
38
39 /**
40 * Logs all exceptions thrown out of a method and swallow exception.
41 *
42 * @since 0.1.10
43 * @see com.jcabi.aspects.LogExceptions
44 * @checkstyle IllegalThrows (100 lines)
45 * @checkstyle NonStaticMethodCheck (100 lines)
46 */
47 @Aspect
48 @Immutable
49 public final class QuietExceptionsLogger {
50
51 /**
52 * Catch exception and log it, the exception will be swallowed.
53 *
54 * <p>This aspect should be used only on void returning methods.
55 *
56 * <p>Try NOT to change the signature of this method, in order to keep
57 * it backward compatible.
58 *
59 * @param point Joint point
60 * @return The result of call
61 */
62 @Around
63 (
64 // @checkstyle StringLiteralsConcatenation (2 lines)
65 "execution(* * (..))"
66 + " && @annotation(com.jcabi.aspects.Quietly)"
67 )
68 @SuppressWarnings("PMD.AvoidCatchingThrowable")
69 public Object wrap(final ProceedingJoinPoint point) {
70 if (!((MethodSignature) point.getSignature()).getReturnType()
71 .equals(Void.TYPE)) {
72 throw new IllegalStateException(
73 String.format(
74 "%s: Return type is not void, cannot use @Quietly",
75 Mnemos.toText(point, true, true)
76 )
77 );
78 }
79 Object result = null;
80 try {
81 result = point.proceed();
82 // @checkstyle IllegalCatch (1 line)
83 } catch (final Throwable ex) {
84 Logger.warn(
85 new ImprovedJoinPoint(point).targetize(),
86 "%[exception]s",
87 ex
88 );
89 }
90 return result;
91 }
92 }