blob: 9847a02f6dd2fb3b0711e1a81ef8cd25f621f492 [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<FindBugsFilter>
<!-- Considered to be false positives -->
<Match>
<!-- Cannot do anything about this. API is fixed by the specification. -->
<Class name="javax.servlet.jsp.tagext.TagData"/>
<Bug code="CN" />
</Match>
<Match>
<Class name="javax.servlet.jsp.el.ImplicitObjectELResolver$ScopeMap$ScopeEntry"/>
<Method name="equals"/>
<Bug code="Eq" />
</Match>
<Match>
<!-- Yes the simple name is the same as the super class. Accept it. -->
<Class name="org.apache.catalina.Executor" />
<Bug code="Nm" />
</Match>
<Match>
<Class name="org.apache.catalina.ant.AbstractCatalinaTask"/>
<Method name="execute"/>
<Bug code="REC"/>
</Match>
<Match>
<Class name="org.apache.catalina.ant.jmx.JMXAccessorCondition"/>
<Method name="accessJMXValue"/>
<Bug code="REC"/>
</Match>
<Match>
<Class name="org.apache.catalina.ant.jmx.JMXAccessorEqualsCondition"/>
<Method name="accessJMXValue"/>
<Bug code="REC"/>
</Match>
<Match>
<Class name="org.apache.catalina.authenticator.AuthenticatorBase"/>
<Field name="sessionIdGenerator"/>
<Bug code="IS"/>
</Match>
<Match>
<!-- Method is synchronized therefore not an issue -->
<Class name="org.apache.catalina.authenticator.DigestAuthenticator$NonceInfo"/>
<Bug code="VO"/>
</Match>
<Match>
<Class name="org.apache.catalina.connector.CoyoteReader"/>
<Method name="readLine"/>
<Bug code="RR"/>
</Match>
<Match>
<!-- JNI library can only be loaded once so statics are appropriate -->
<Class name="org.apache.catalina.core.AprLifecycleListener" />
<Bug code="ST" />
</Match>
<Match>
<!-- Have to trigger GC for leak detection to work. Clearly documented -->
<Class name="org.apache.catalina.core.StandardHost" />
<Method name="findReloadedContextMemoryLeaks" />
<Bug code="Dm" />
</Match>
<Match>
<!-- Sleep is of short duration and lock is required -->
<Class name="org.apache.catalina.core.StandardWrapper" />
<Method name="unload" />
<Bug code="SWL" />
</Match>
<Match>
<!-- The code is adding HTTP request headers, not parameters and the
header parsing on input will have removed any CR or LF characters. -->
<Class name="org.apache.catalina.filters.CorsFilter" />
<Or>
<Method name="handlePreflightCORS" />
<Method name="handleSimpleCORS" />
</Or>
<Bug pattern="HRS_REQUEST_PARAMETER_TO_HTTP_HEADER" />
</Match>
<Match>
<!-- shost will not be null in normal usage -->
<Class name="org.apache.catalina.ha.backend.CollectedInfo" />
<Method name="init" />
<Bug code="NP" />
</Match>
<Match>
<!-- Field is only modified during Servlet load -->
<Class name="org.apache.catalina.manager.host.HostManagerServlet" />
<Bug code="MSF" />
</Match>
<Match>
<!-- Catching exception is simpler than handling all the individual ones -->
<Class name="org.apache.catalina.manager.util.SessionUtils" />
<Method name="guessLocaleFromSession" />
<Bug code="REC" />
</Match>
<Match>
<Class name="org.apache.catalina.realm.JDBCRealm" />
<Field name="containerLog" />
<Bug code="IS" />
</Match>
<Match>
<!-- Non-constant strings are configuration settings rather than client
supplied -->
<Class name="org.apache.catalina.session.JDBCStore" />
<Or>
<Method name="load" />
<Method name="save" />
</Or>
<Bug code="SQL" />
</Match>
<Match>
<!-- We can live with the threading issue. See code comment for details. -->
<Class name="org.apache.catalina.session.ManagerBase" />
<Method name="generateSessionId" />
<Bug code="VO" />
</Match>
<Match>
<!-- Use of null is deliberate -->
<Class name="org.apache.catalina.ssi.ExpressionParseTree" />
<Method name="pushOpp" />
<Bug code="NP" />
</Match>
<Match>
<!-- Catalina isn't used when embedding -->
<Class name="org.apache.catalina.startup.Catalina" />
<Method name="stopServer" />
<Bug code="Dm" />
</Match>
<Match>
<!-- Sleep is short, needs to keep lock -->
<Class name="org.apache.catalina.startup.HostConfig" />
<Method name="checkResources" />
<Bug code="SWL" />
</Match>
<Match>
<!-- context is never null -->
<Class name="org.apache.catalina.startup.HostConfig" />
<Method name="deployDescriptor" />
<Bug code="NP" />
</Match>
<Match>
<!-- context is never null -->
<Class name="org.apache.catalina.startup.HostConfig" />
<Method name="deployDirectory" />
<Bug code="NP" />
</Match>
<Match>
<!-- context is never null -->
<Class name="org.apache.catalina.startup.HostConfig" />
<Method name="deployWAR" />
<Bug code="NP" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector"/>
<Method name="memberAlive"/>
<Bug code="DE"/>
</Match>
<Match>
<Class name="org.apache.catalina.tribes.membership.McastServiceImpl"/>
<Method name="stop"/>
<Bug code="DE"/>
</Match>
<Match>
<Class name="org.apache.catalina.tribes.membership.McastServiceImpl$ReceiverThread"/>
<Method name="run"/>
<Bug code="DE"/>
</Match>
<Match>
<Class name="org.apache.catalina.tribes.membership.McastServiceImpl$RecoveryThread"/>
<Method name="run"/>
<Bug code="NS"/>
</Match>
<Match>
<!-- Intentional in case thread is waiting -->
<Class name="org.apache.catalina.tribes.transport.RxTaskPool"/>
<Method name="returnWorker"/>
<Bug code="NN"/>
</Match>
<Match>
<Class name="org.apache.catalina.util.LifecycleBase" />
<Method name="getState"/>
<Bug code="UG" />
</Match>
<Match>
<!-- Non-constant strings are configuration settings rather than client
supplied -->
<Class name="org.apache.catalina.valves.JDBCAccessLogValve" />
<Method name="open" />
<Bug code="SQL" />
</Match>
<Match>
<!-- Locks are always released. Non-standard pattern is required because -->
<!-- of lock upgrade that is used. -->
<Class name="org.apache.coyote.http11.upgrade.AprServletInputStream" />
<Method name="doRead"/>
<Bug code="UL" />
</Match>
<Match>
<!-- Locks are always released. Non-standard pattern is required because -->
<!-- of lock upgrade that is used. -->
<Class name="org.apache.coyote.http11.upgrade.AprServletOutputStream" />
<Method name="doWrite"/>
<Bug code="UL" />
</Match>
<Match>
<!-- Locks are always released. Non-standard pattern is required because -->
<!-- of lock upgrade that is used. -->
<Class name="org.apache.coyote.http11.InternalAprInputBuffer" />
<Method name="doReadSocket"/>
<Bug code="UL" />
</Match>
<Match>
<!-- Locks are always released. Non-standard pattern is required because -->
<!-- of lock upgrade that is used. -->
<Class name="org.apache.coyote.http11.InternalAprOutputBuffer" />
<Method name="writeToSocket"/>
<Bug code="UL" />
</Match>
<Match>
<!-- Returning null is required by the EL specification -->
<Class name="org.apache.el.lang.ELSupport" />
<Method name="coerceToBoolean"/>
<Bug pattern="NP_BOOLEAN_RETURN_NULL"/>
</Match>
<Match>
<!-- JspC will not be used under a security manager -->
<Class name="org.apache.jasper.JspC"/>
<Method name="initClassLoader"/>
<Bug code="DP" />
</Match>
<Match>
<!-- Parser config is static so statics are appropriate -->
<Class name="org.apache.jasper.JspC"/>
<Method name="setValidateXml"/>
<Bug code="ST" />
</Match>
<Match>
<!-- Node constructors add node to parent. Local variable is used to
silence an Eclipse warning -->
<Class name="org.apache.jasper.compiler.ELFunctionMapper"/>
<Method name="map"/>
<Bug code="DLS"/>
</Match>
<Match>
<!-- NPE is not possible -->
<Class name="org.apache.jasper.compiler.JspConfig"/>
<Method name="selectProperty"/>
<Bug code="NP"/>
</Match>
<Match>
<!-- Returning null is intentional -->
<Class name="org.apache.jasper.compiler.JspReader"/>
<Method name="indexOf"/>
<Bug code="NP"/>
</Match>
<Match>
<!-- Node constructors add node to parent. Local variable is used to
silence an Eclipse warning -->
<Class name="org.apache.jasper.compiler.Parser"/>
<Bug code="DLS"/>
</Match>
<Match>
<!-- Simpler to catch Exception than to create dummy implementations of the
necessary exception hierarchy -->
<Class name="org.apache.naming.factory.SendMailFactory$1" />
<Method name="run" />
<Bug code="DE" />
</Match>
<Match>
<!-- Simpler to catch Exception than to create dummy implementations of the
necessary exception hierarchy -->
<Class name="org.apache.naming.factory.webservices.ServiceProxy" />
<Method name="&lt;init&gt;"/>
<Bug code="ST" />
</Match>
<Match>
<!-- Class name needs to start with a lower case letter in this case -->
<Class name="org.apache.naming.java.javaURLContextFactory" />
<Bug code="Nm" />
</Match>
<Match>
<!-- Increment is in sync block so it is safe. Volatile is used so reading
thread sees latest value. -->
<Class name="org.apache.tomcat.dbcp.pool2.impl.DefaultPooledObject" />
<Method name="allocate" />
<Bug pattern="VO_VOLATILE_INCREMENT" />
</Match>
<Match>
<!-- Return value is ignored but a null result will trigger an exception -->
<Class name="org.apache.tomcat.jdbc.pool.ConnectionPool$ConnectionFuture" />
<Method name="get" />
<Bug code="RV" />
</Match>
<Match>
<!-- Lock is released -->
<Class name="org.apache.tomcat.jdbc.pool.FairBlockingQueue" />
<Method name="poll" />
<Bug code="UL" />
</Match>
<Match>
<!-- Use of == is deliberate -->
<Class name="org.apache.tomcat.jdbc.pool.JdbcInterceptor" />
<Method name="compare" />
<Bug code="ES" />
</Match>
<Match>
<!-- Lock is released -->
<Class name="org.apache.tomcat.jdbc.pool.MultiLockFairBlockingQueue" />
<Method name="poll" />
<Bug code="UL" />
</Match>
<Match>
<!-- Lack of thread-safety is accepted in return for better performance. -->
<Class name="org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport$QueryStats" />
<Or>
<Method name="add" />
<Method name="failure" />
<Method name="prepare" />
</Or>
<Bug code="VO" />
</Match>
<Match>
<!-- Wait is in AprSocket -->
<Class name="org.apache.tomcat.jni.socket.AprSocketContext$AprPoller" />
<Method name="run"/>
<Bug code="NN" />
</Match>
<Match>
<Class name="org.apache.tomcat.util.IntrospectionUtils" />
<Method name="findMethod"/>
<Bug code="NP" />
</Match>
<Match>
<!-- Class name is appropriate -->
<Class name="org.apache.tomcat.util.bcel.classfile.CodeException"/>
<Bug code="Nm" />
</Match>
<Match>
<!-- Field by field copy is fine for clone in this case -->
<Class name="org.apache.tomcat.util.bcel.classfile.StackMapType"/>
<Bug code="CN" />
</Match>
<Match>
<!-- Fall-through expected -->
<Class name="org.apache.tomcat.util.bcel.classfile.Utility"/>
<Bug code="SF" />
</Match>
<Match>
<!-- Returning null here is fine -->
<Class name="org.apache.tomcat.util.buf.ByteChunk"/>
<Method name="toString"/>
<Bug code="NP" />
</Match>
<Match>
<!-- Returning null here is fine -->
<Class name="org.apache.tomcat.util.buf.CharChunk"/>
<Method name="toString"/>
<Bug code="NP" />
</Match>
<Match>
<!-- Returning null here is fine -->
<Class name="org.apache.tomcat.util.buf.MessageBytes"/>
<Method name="toString"/>
<Bug code="NP" />
</Match>
<Match>
<!-- Whilst cache is global there may be multiple instances (one per -->
<!-- server so statics are appropriate -->
<Class name="org.apache.tomcat.util.buf.StringCache"/>
<Bug code="ST" />
</Match>
<Match>
<!-- NPE is desired as it indicates an error condition -->
<Class name="org.apache.tomcat.util.digester.CallMethodRule"/>
<Method name="end"/>
<Bug code="NP" />
</Match>
<Match>
<!-- Test really is for the same object rather than equality -->
<Class name="org.apache.tomcat.util.digester.Digester"/>
<Or>
<Method name="updateBodyText"/>
<Method name="updateAttributes"/>
</Or>
<Bug code="ES" />
</Match>
<Match>
<!-- Hiding of field in superclass is deliberate -->
<Class name="org.apache.tomcat.util.modeler.NotificationInfo"/>
<Field name="info" />
<Bug code="MF" />
</Match>
<Match>
<!-- JSSE vs APR attribute names. More confusing to change one of them -->
<Class name="org.apache.tomcat.util.net.AprEndpoint"/>
<Or>
<Method name="getSSLProtocol"/>
<Method name="setSSLProtocol"/>
</Or>
<Bug code="Nm"/>
</Match>
<Match>
<!-- See wait() call in destroy() -->
<Class name="org.apache.tomcat.util.net.AprEndpoint$Poller"/>
<Method name="run"/>
<Bug code="NN" />
</Match>
<Match>
<Class name="org.apache.tomcat.util.net.AprEndpoint$Sendfile"/>
<Method name="run"/>
<Or>
<!-- see wait() call in destroy() -->
<Bug code="NN" />
<!-- notify() is called from add() -->
<Bug code="UW" />
</Or>
</Match>
<Match>
<!-- Sync is there to protect referenced object not field -->
<Class name="org.apache.tomcat.util.net.AprEndpoint$SocketEventProcessor"/>
<Method name="run"/>
<Bug code="ML" />
</Match>
<Match>
<!-- Object is only ever set to null, sync therefore is still valid -->
<Class name="org.apache.tomcat.util.net.AprEndpoint$SocketProcessor"/>
<Method name="run"/>
<Bug code="ML"/>
</Match>
<Match>
<!-- Sync is there to protect referenced object not field -->
<Class name="org.apache.tomcat.util.net.AprEndpoint$SocketWithOptionsProcessor"/>
<Method name="run"/>
<Bug code="ML" />
</Match>
<Match>
<!-- Return value is ignored at this point but logic further up call -->
<!-- stack will ensure that a SocketTimeoutException is thrown -->
<Class name="org.apache.tomcat.util.net.NioEndpoint$KeyAttachment"/>
<Method name="awaitLatch"/>
<Bug code="RV"/>
</Match>
<Match>
<!-- Object is only ever set to null, sync therefore is still valid -->
<Class name="org.apache.tomcat.util.net.NioEndpoint$SocketProcessor"/>
<Method name="run"/>
<Bug code="ML"/>
</Match>
<Match>
<Class name="org.apache.tomcat.util.net.SecureNioChannel"/>
<Method name="rehandshake"/>
<Bug code="DE" />
</Match>
<Match>
<!-- Use of synchronisation is required to make a sequence of calls in -->
<!-- one method appear to be atomic. -->
<Class name="org.apache.tomcat.util.net.SocketWrapper"/>
<Or>
<Method name="addDispatch"/>
<Method name="getIteratorAndClearDispatches"/>
<Method name="clearDispatches"/>
</Or>
<Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER" />
</Match>
<Match>
<!-- Yes the simple name is the same as the super class. Accept it. -->
<Class name="org.apache.tomcat.util.threads.ThreadPoolExecutor" />
<Bug code="Nm" />
</Match>
<Match>
<!-- Object creation will trigger input processing. -->
<Class name="org.apache.tomcat.websocket.WsWebSocketContainer" />
<Method name="connectToServer" />
<Bug code="DLS" />
</Match>
<!-- Example code -->
<Match>
<!-- FindBugs assumes the container uses the values as is. Tomcat validates
them and escapes them as necessary to ensure they are safe. -->
<Class name="CookieExample" />
<Method name="doGet" />
<Bug code="HRS" />
</Match>
<Match>
<!-- Not really unused as it registers itself during construction -->
<Class name="nonblocking.ByteCounter" />
<Method name="doPost" />
<Bug pattern="DLS_DEAD_LOCAL_STORE" />
</Match>
<Match>
<!-- Not really unused as it registers itself during construction -->
<Class name="nonblocking.NumberWriter" />
<Method name="doGet" />
<Bug pattern="DLS_DEAD_LOCAL_STORE" />
</Match>
<!-- Generated code -->
<Match>
<Class name="org.apache.el.parser.ELParserTokenManager" />
</Match>
<Match>
<Class name="org.apache.el.parser.TokenMgrError" />
</Match>
<Match>
<Class name="org.apache.el.parser.ParseException" />
</Match>
<Match>
<!-- fCurrentEntity may be null after endEntity() call -->
<Class name="org.apache.jasper.xmlparser.XMLEncodingDetector" />
<Method name="load" />
<Bug code="RCN" />
</Match>
<!-- Test code -->
<Match>
<!-- Code is deliberately unused -->
<Or>
<Class name="javax.servlet.http.TestCookie" />
<Class name="javax.servlet.http.TestCookieStrict" />
</Or>
<Bug pattern="DLS_DEAD_LOCAL_STORE"/>
</Match>
<Match>
<!-- Code is intentionally unused -->
<Class name="org.apache.catalina.authenticator.TestBasicAuthParser"/>
<Method name="testAuthMethodBadMethod"/>
<Bug pattern="DLS_DEAD_LOCAL_STORE"/>
</Match>
<Match>
<Class name="org.apache.catalina.core.TestApplicationSessionCookieConfig$CustomContext" />
<Method name="getState"/>
<Bug code="UG" />
</Match>
<Match>
<Or>
<Class name="org.apache.catalina.startup.TestListener$SCL" />
<Class name="org.apache.catalina.startup.TestListener$SCL3" />
</Or>
<Method name="contextInitialized" />
<Bug code="ST" />
</Match>
<Match>
<Class name="org.apache.catalina.startup.TestTomcatClassLoader$ClassLoaderReport"/>
<Bug code="Se"/>
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.EchoRpcTest" />
<Method name="run"/>
<Bug code="REC" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.EchoRpcTest$SystemExit" />
<Bug code="Dm" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.IntrospectionUtils" />
<Method name="findMethod"/>
<Bug code="NP" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.LoadTest" />
<Method name="memberAdded"/>
<Bug code="NN" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.LoadTest" />
<Method name="run"/>
<Or>
<Bug code="REC" />
<Bug code="UW" />
</Or>
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.LoadTest$SystemExit" />
<Bug code="Dm" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.demos.MapDemo$SystemExit" />
<Bug code="Dm" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.channel.TestChannelOptionFlag" />
<Method name="tearDown" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.channel.TestChannelStartStop" />
<Method name="tearDown" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.channel.TestChannelStartStop" />
<Method name="testDoublePartialStart" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.channel.TestChannelStartStop" />
<Method name="testFalseOption" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.channel.TestRemoteProcessException" />
<Bug code="Nm" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.interceptors.TestNonBlockingCoordinator" />
<Method name="testCoord1" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.membership.TestTcpFailureDetector" />
<Method name="tearDown" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.transport.SocketReceive$1" />
<Method name="run" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.transport.SocketTribesReceive$1" />
<Method name="run" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.transport.SocketTribesReceive" />
<Method name="main" />
<Bug code="DE" />
</Match>
<Match>
<Class name="org.apache.catalina.tribes.test.transport.SocketValidateReceive$1" />
<Method name="run" />
<Bug code="DE" />
</Match>
<Match>
<!-- Code is deliberately unused -->
<Or>
<Class name="org.apache.catalina.webresources.AbstractTestDirResourceSet" />
<Class name="org.apache.catalina.webresources.AbstractTestFileResourceSet" />
<Class name="org.apache.catalina.webresources.TestJarResourceSet" />
<Class name="org.apache.catalina.webresources.TestJarResourceSetInternal" />
</Or>
<Method name="testNoArgConstructor" />
<Bug pattern="DLS_DEAD_LOCAL_STORE"/>
</Match>
<Match>
<!-- Use of static is unavoidable -->
<Class name="org.apache.tomcat.jdbc.test.TestStatementCache" />
<Method name="tearDown" />
<Bug code="ST" />
</Match>
<Match>
<!-- Use of statics is unavoidable in all cases -->
<!-- Better to use it consistently rather than only where necessary -->
<Class name="org.apache.tomcat.jdbc.pool.interceptor.TestInterceptor" />
<Bug code="ST" />
</Match>
<Match>
<!-- Return value of latch is intentionally ignored -->
<Or>
<Class name="org.apache.tomcat.websocket.TestWebSocketFrameClient"/>
<Class name="org.apache.tomcat.websocket.TestWebSocketFrameClientSSL"/>
</Or>
<Method name="testConnectToServerEndpoint"/>
<Bug pattern="RV_RETURN_VALUE_IGNORED"/>
</Match>
<Match>
<Class name="org.apache.tomcat.util.net.TestSsl" />
<Or>
<Method name="testRenegotiateFail" />
<Method name="testRenegotiateWorks" />
</Or>
<Bug code="RR" />
</Match>
<Match>
<!-- Code is deliberately unused -->
<Class name="org.apache.tomcat.websocket.server.TestUriTemplate" />
<Or>
<Method name="testBasicPrefix" />
<Method name="testQuote2" />
<Method name="testDuplicate01" />
</Or>
<Bug pattern="DLS_DEAD_LOCAL_STORE"/>
</Match>
</FindBugsFilter>