Package com.mebigfatguy.fbcontrib.detect

Class HttpClientProblems

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.visitclass.DismantleBytecode

edu.umd.cs.findbugs.BytecodeScanningDetector

com.mebigfatguy.fbcontrib.detect.MissingMethodsDetector

com.mebigfatguy.fbcontrib.detect.HttpClientProblems

All Implemented Interfaces:

edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, org.apache.bcel.classfile.Visitor

public class HttpClientProblems
extends MissingMethodsDetector

looks for problems surrounding use of HttpRequests from the Apache HttpComponents library which have have some little-known quirks about them. This is a set of detectors that helps guard against resource starvation.

Field Summary

Fields

Modifier and Type	Field	Description
private static Set<String>	httpRequestClasses
private static Set<String>	resetMethods
private static Set<String>	whiteListMethods

Fields inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

Fields inherited from interface edu.umd.cs.findbugs.Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
HttpClientProblems(edu.umd.cs.findbugs.BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
protected boolean	doesObjectNeedToBeWatched(String type)
protected boolean	doesStaticFactoryReturnNeedToBeWatched(String clsName, String methodName, String signature)
protected boolean	isMethodThatShouldBeCalled(String methodName)
protected edu.umd.cs.findbugs.BugInstance	makeFieldBugInstance()
protected edu.umd.cs.findbugs.BugInstance	makeLocalBugInstance()
protected void	processMethodParms()	Checks to see if any of the locals or fields that we are tracking are passed into another method.

Methods inherited from class com.mebigfatguy.fbcontrib.detect.MissingMethodsDetector

clearSpecialField, getParentClassName, getStack, saveSpecialFieldUse, sawOpcode, visitClassContext, visitCode, visitField

Methods inherited from class edu.umd.cs.findbugs.BytecodeScanningDetector

getClassContext, report, shouldVisitCode

Methods inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

afterOpcode, areOppositeBranches, atCatchBlock, beforeOpcode, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefConstantOperand, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString, visit

Methods inherited from class edu.umd.cs.findbugs.visitclass.AnnotationVisitor

getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

Methods inherited from class edu.umd.cs.findbugs.visitclass.PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class edu.umd.cs.findbugs.visitclass.BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitMethod, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

Field Details

httpRequestClasses

private static Set<String> httpRequestClasses

resetMethods

private static Set<String> resetMethods

whiteListMethods

private static Set<String> whiteListMethods

Constructor Details

HttpClientProblems

public HttpClientProblems(edu.umd.cs.findbugs.BugReporter bugReporter)

Method Details

makeFieldBugInstance

protected edu.umd.cs.findbugs.BugInstance makeFieldBugInstance()

Specified by:

makeFieldBugInstance in class MissingMethodsDetector

makeLocalBugInstance

protected edu.umd.cs.findbugs.BugInstance makeLocalBugInstance()

Specified by:

makeLocalBugInstance in class MissingMethodsDetector

doesObjectNeedToBeWatched

protected boolean doesObjectNeedToBeWatched(@DottedClassName
 String type)

Specified by:

doesObjectNeedToBeWatched in class MissingMethodsDetector

doesStaticFactoryReturnNeedToBeWatched

protected boolean doesStaticFactoryReturnNeedToBeWatched(String clsName,
 String methodName,
 String signature)

Specified by:

doesStaticFactoryReturnNeedToBeWatched in class MissingMethodsDetector

isMethodThatShouldBeCalled

protected boolean isMethodThatShouldBeCalled(String methodName)

Specified by:

isMethodThatShouldBeCalled in class MissingMethodsDetector

processMethodParms

protected void processMethodParms()

Description copied from class: MissingMethodsDetector

Checks to see if any of the locals or fields that we are tracking are passed into another method. If they are, we clear out our tracking of them, because we can't easily track their progress into the method. This can be overridden to check for exceptions to this rule, for example, being logged to the console not counting.

Overrides:

processMethodParms in class MissingMethodsDetector