spotbugs-exclude.xml

<!-- This file specifies a spotbugs filter for excluding reports that
     should not be considered errors.
     The format of this file is documented at:
       https://spotbugs.readthedocs.io/en/latest/filter.html
     When possible, please specify the full names of the bug codes,
     using the pattern attribute, to make it clearer what reports are
     being suppressed.  You can find a listing of codes at:
       https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html
  -->
<FindBugsFilter>
    <!-- These open matches are new rules that we have not yet addressed. Let's block them generically, and come
         back to them later. -->
    <Match>
        <Bug pattern="CT_CONSTRUCTOR_THROW" />
    </Match>
    <Match>
        <Bug pattern="PA_PUBLIC_PRIMITIVE_ATTRIBUTE" />
    </Match>
    <Match>
        <Bug pattern="SING_SINGLETON_GETTER_NOT_SYNCHRONIZED" />
    </Match>
    <Match>
        <Bug pattern="SING_SINGLETON_GETTER_NOT_SYNCHRONIZED" />
    </Match>

    <!-- Regular matches -->
    <Match>
        <Bug pattern="EI_EXPOSE_REP2"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.BaseProvider"/>
                <Field name="cacheManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.BaseProvider"/>
                <Field name="transformationManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.transform.TransformationManager"/>
                <Field name="transformation"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
                <Field name="transformationManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                <Method name="getS3Client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
                <Field name="cacheManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
                <Field name="transformationManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
                <Field name="client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
                <Field name="client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
                <Field name="cacheManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
                <Field name="cacheManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
                <Field name="client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
                <Field name="transformationManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
                <Field name="cacheManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
                <Field name="transformationManager"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.JsonSerializer"/>
            </And>
        </Or>
    </Match>
    <!-- Internals of Log event for apache log4j-->
    <Match>
        <Bug pattern="EI_EXPOSE_REP"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
                <Method name="getPersistenceStore"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
                <Method name="getConfig"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                <Method name="getS3Client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$Builder" />
                <Method name="getAdditionalFields"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$LogEventWithAdditionalFields" />
                <Method name="getAdditionalFields"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.LambdaJsonLayout$LogEventWithAdditionalFields" />
                <Method name="getAdditionalFields"/>
            </And>
        </Or>
    </Match>
    <Match>
        <Bug pattern="EI_EXPOSE_REP2"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder"/>
                <Field name="throwableConverter"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.parameters.transform.TransformationManager"/>
                <Field name="transformer"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder"/>
                <Field name="throwableConverter"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.sqs.internal.BatchContext"/>
                <Field name="client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
                <Field name="store"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
                <Field name="config"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.internal.IdempotencyHandler"/>
                <Field name="pjp"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.idempotency.persistence.dynamodb.DynamoDBPersistenceStore$Builder"/>
                <Field name="dynamoDbClient"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.utilities.EventDeserializer$EventPart"/>
                <Field name="contentMap"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.utilities.EventDeserializer$EventPart"/>
                <Field name="contentList"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                <Field name="s3Client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy" />
                <Method name="LogEventWithAdditionalFields"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$Builder" />
                <Method name="setAdditionalFields"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.LambdaJsonLayout" />
                <Method name="LogEventWithAdditionalFields"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.LambdaEcsEncoder" />
                <Method name="setThrowableConverter"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.LambdaJsonEncoder" />
                <Method name="setThrowableConverter"/>
            </And>
        </Or>
    </Match>
    <!--Functionally needed-->
    <Match>
        <Bug pattern="MS_SHOULD_BE_FINAL"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.logging.internal.LambdaLoggingAspect"/>
                <Field name="SAMPLING_RATE"/>
            </And>
        </Or>
    </Match>
    <Match>
        <Bug pattern="EI_EXPOSE_STATIC_REP2"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.tracing.TracingUtils"/>
                <Method name="defaultObjectMapper"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.sqs.SqsUtils"/>
                <Method name="overrideSqsClient"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.sqs.SqsUtils"/>
                <Method name="overrideS3Client"/>
            </And>
        </Or>
    </Match>
    <Match>
        <Bug pattern="MS_EXPOSE_REP"/>
        <Or>
            <And>
                <Class name="software.amazon.lambda.powertools.tracing.TracingUtils"/>
                <Method name="objectMapper"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.sqs.SqsUtils"/>
                <Method name="objectMapper"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.sqs.SqsUtils"/>
                <Method name="s3Client"/>
            </And>
            <And>
                <Class name="software.amazon.lambda.powertools.metrics.MetricsUtils"/>
                <Method name="metricsLogger"/>
            </And>
        </Or>
    </Match>
    <!--False positive https://github.com/spotbugs/spotbugs/issues/1539-->
    <Match>
        <Bug pattern="DMI_RANDOM_USED_ONLY_ONCE"/>
        <Class name="software.amazon.lambda.powertools.logging.internal.LambdaLoggingAspect"/>
        <Method name="setLogLevelBasedOnSamplingRate"/>
    </Match>
    <Match>
        <Bug pattern="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED"/>
        <Or>
            <And>
                <Class name="helloworld.App"/>
                <Method name="threadOption1"/>
            </And>
        </Or>
    </Match>
</FindBugsFilter>