##### Project Documentation

- Checkstyle

## Checkstyle Results

The following document contains the results of Checkstyle.

## Summary

Files | Infos | Warnings | Errors
--- | --- | --- | ---
71 | 0 | 96 | 0

## Files

Files | I | W | E
--- | --- | --- | ---
edu/internet2/middleware/shibboleth/idp/StatusServlet.java | 0 | 8 | 0
edu/internet2/middleware/shibboleth/idp/Version.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/authn/AuthenticationEngine.java | 0 | 8 | 0
edu/internet2/middleware/shibboleth/idp/authn/Saml2LoginContext.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/authn/provider/IPAddressLoginHandler.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/idp/authn/provider/UsernamePasswordLoginHandler.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/authn/provider/UsernamePasswordLoginServlet.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/config/profile/ProfileHandlerNamespaceHandler.java | 0 | 4 | 0
edu/internet2/middleware/shibboleth/idp/config/profile/SAMLMetadataHandlerBeanDefinitionParser.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/idp/config/profile/StatusHandlerBeanDefinitionParser.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/config/profile/authn/IPAddressLoginHandlerFactoryBean.java | 0 | 4 | 0
edu/internet2/middleware/shibboleth/idp/config/profile/authn/PreviousSessionLoginHandlerBeanDefinitionParser.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/AbstractSAMLProfileHandler.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/IdPProfileHandlerManager.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/idp/profile/SAMLMetadataProfileHandler.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml1/AbstractSAML1ProfileHandler.java | 0 | 9 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml1/ArtifactResolution.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml1/AttributeQueryProfileHandler.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml1/BaseSAML1ProfileRequestContext.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml1/ShibbolethSSOProfileHandler.java | 0 | 3 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml2/AbstractSAML2ProfileHandler.java | 0 | 12 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml2/ArtifactResolution.java | 0 | 3 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml2/AttributeQueryProfileHandler.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml2/BaseSAML2ProfileRequestContext.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/idp/profile/saml2/SSOProfileHandler.java | 0 | 9 | 0
edu/internet2/middleware/shibboleth/idp/util/HttpServletHelper.java | 0 | 12 | 0
edu/internet2/middleware/shibboleth/idp/util/IPRange.java | 0 | 3 | 0

## Rules

Rules | Violations | Severity
--- | --- | ---
JavadocMethod allowThrowsTagsForSubclasses: `"true"` allowUndeclaredRTE: `"true"` | 2 | Warning
JavadocType | 0 | Warning
JavadocVariable | 4 | Warning
JavadocStyle checkEmptyJavadoc: `"true"` | 6 | Warning
ConstantName | 1 | Warning
LocalFinalVariableName | 0 | Warning
LocalVariableName | 0 | Warning
MemberName | 1 | Warning
MethodName | 0 | Warning
PackageName | 0 | Warning
ParameterName | 0 | Warning
StaticVariableName | 0 | Warning
TypeName | 0 | Warning
AvoidStarImport | 0 | Warning
IllegalImport | 0 | Warning
RedundantImport | 0 | Warning
UnusedImports | 1 | Warning
FileLength max: `"1000"` | 1 | Warning
LineLength max: `"120"` | 48 | Warning
MethodLength max: `"50"` | 9 | Warning
ParameterNumber max: `"5"` | 0 | Warning
EmptyForIteratorPad | 0 | Warning
MethodParamPad | 0 | Warning
TabCharacter | 0 | Warning
ModifierOrder | 0 | Warning
AvoidNestedBlocks | 0 | Warning
EmptyBlock | 2 | Warning
LeftCurly | 0 | Warning
NeedBraces | 0 | Warning
RightCurly | 0 | Warning
AvoidInlineConditionals | 2 | Warning
DoubleCheckedLocking | 0 | Warning
EmptyStatement | 0 | Warning
EqualsHashCode | 0 | Warning
HiddenField | 1 | Warning
IllegalInstantiation | 0 | Warning
InnerAssignment | 0 | Warning
MissingSwitchDefault | 0 | Warning
RedundantThrows | 0 | Warning
SimplifyBooleanExpression | 0 | Warning
SimplifyBooleanReturn | 0 | Warning
FinalClass | 0 | Warning
HideUtilityClassConstructor | 2 | Warning
InterfaceIsType | 0 | Warning
VisibilityModifier | 0 | Warning
ArrayTypeStyle | 0 | Warning
UpperEll | 0 | Warning
AbstractClassName format: `"^Abstract.*$|^Base.*$"` | 0 | Warning
AnonInnerLength | 0 | Warning
EmptyForInitializerPad | 0 | Warning
CovariantEquals | 0 | Warning
DefaultComesLast | 0 | Warning
DeclarationOrder | 0 | Warning
ExplicitInitialization | 0 | Warning
FallThrough | 0 | Warning
IllegalCatch | 6 | Warning
IllegalThrows | 0 | Warning
JUnitTestCase | 0 | Warning
MultipleVariableDeclarations | 0 | Warning
PackageDeclaration | 0 | Warning
ParameterAssignment | 0 | Warning
ReturnCount max: `"4"` | 0 | Warning
StringLiteralEquality | 2 | Warning
SuperFinalize | 0 | Warning
ArrayTrailingComma | 3 | Warning
UnnecessaryParentheses | 0 | Warning
MutableException | 0 | Warning
ThrowsCount max: `"3"` | 0 | Warning
CyclomaticComplexity | 5 | Warning
TrailingComment | 0 | Warning
PackageHtml fileExtensions: `"html"` | 0 | Warning

## Details

### edu/internet2/middleware/shibboleth/idp/StatusServlet.java

Violation | Message | Line
--- | --- | ---
| Missing a Javadoc comment. | 55
| Name 'IP_PARAM_NAME' must match pattern '^[a-z][a-zA-Z0-9]*$'. | 55
| Missing a Javadoc comment. | 57
| Missing a Javadoc comment. | 59
| Line is longer than 120 characters. | 93
| Expected @throws tag for 'ServletException'. | 118
| Catching 'Throwable' is not allowed. | 223
| Must have at least one statement. | 223

### edu/internet2/middleware/shibboleth/idp/Version.java

Violation | Message | Line
--- | --- | ---
| Utility classes should not have a public or default constructor. | 20

### edu/internet2/middleware/shibboleth/idp/authn/AuthenticationEngine.java

Violation | Message | Line
--- | --- | ---
| Missing a Javadoc comment. | 95
| Method length is 59 lines (max allowed is 50). | 226
| Cyclomatic Complexity is 12 (max allowed is 10). | 297
| Method length is 54 lines (max allowed is 50). | 297
| Line is longer than 120 characters. | 457
| Line is longer than 120 characters. | 708
| Literal Strings should be compared using equals(), not '=='. | 710
| Avoid inline conditionals. | 710

### edu/internet2/middleware/shibboleth/idp/authn/Saml2LoginContext.java

Violation | Message | Line
--- | --- | ---
| Cyclomatic Complexity is 13 (max allowed is 10). | 125

### edu/internet2/middleware/shibboleth/idp/authn/provider/IPAddressLoginHandler.java

Violation | Message | Line
--- | --- | ---
| Missing a Javadoc comment. | 56
| 'ipInRangeIsAuthenticated' hides a field. | 56

### edu/internet2/middleware/shibboleth/idp/authn/provider/UsernamePasswordLoginHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 33

### edu/internet2/middleware/shibboleth/idp/authn/provider/UsernamePasswordLoginServlet.java

Violation | Message | Line
--- | --- | ---
| Catching 'Throwable' is not allowed. | 186

### edu/internet2/middleware/shibboleth/idp/config/profile/ProfileHandlerNamespaceHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 28
| Line is longer than 120 characters. | 29
| Line is longer than 120 characters. | 31
| Line is longer than 120 characters. | 32

### edu/internet2/middleware/shibboleth/idp/config/profile/SAMLMetadataHandlerBeanDefinitionParser.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 26
| Line is longer than 120 characters. | 30

### edu/internet2/middleware/shibboleth/idp/config/profile/StatusHandlerBeanDefinitionParser.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 23

### edu/internet2/middleware/shibboleth/idp/config/profile/authn/IPAddressLoginHandlerFactoryBean.java

Violation | Message | Line
--- | --- | ---
| Javadoc has empty description section. | 43
| Javadoc has empty description section. | 50
| Javadoc has empty description section. | 57
| Line is longer than 120 characters. | 66

### edu/internet2/middleware/shibboleth/idp/config/profile/authn/PreviousSessionLoginHandlerBeanDefinitionParser.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 54

### edu/internet2/middleware/shibboleth/idp/profile/AbstractSAMLProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Unused import - org.opensaml.common.binding.SAMLMessageContext. | 26

### edu/internet2/middleware/shibboleth/idp/profile/IdPProfileHandlerManager.java

Violation | Message | Line
--- | --- | ---
| Catching 'Exception' is not allowed. | 130
| Line is longer than 120 characters. | 160

### edu/internet2/middleware/shibboleth/idp/profile/SAMLMetadataProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Catching 'Exception' is not allowed. | 65
| Catching 'Exception' is not allowed. | 90

### edu/internet2/middleware/shibboleth/idp/profile/saml1/AbstractSAML1ProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 285
| Cyclomatic Complexity is 14 (max allowed is 10). | 361
| Method length is 63 lines (max allowed is 50). | 361
| Line is longer than 120 characters. | 394
| Line is longer than 120 characters. | 405
| Line is longer than 120 characters. | 413
| Array should contain trailing comma. | 415
| Method length is 57 lines (max allowed is 50). | 600
| Cyclomatic Complexity is 11 (max allowed is 10). | 745

### edu/internet2/middleware/shibboleth/idp/profile/saml1/ArtifactResolution.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 203

### edu/internet2/middleware/shibboleth/idp/profile/saml1/AttributeQueryProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 217

### edu/internet2/middleware/shibboleth/idp/profile/saml1/BaseSAML1ProfileRequestContext.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 19

### edu/internet2/middleware/shibboleth/idp/profile/saml1/ShibbolethSSOProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 244
| Line is longer than 120 characters. | 344
| Line is longer than 120 characters. | 359

### edu/internet2/middleware/shibboleth/idp/profile/saml2/AbstractSAML2ProfileHandler.java

Violation | Message | Line
--- | --- | ---
| File length is 1,090 lines (max allowed is 1,000). | 1
| Line is longer than 120 characters. | 311
| Line is longer than 120 characters. | 312
| Line is longer than 120 characters. | 390
| Method length is 57 lines (max allowed is 50). | 552
| Line is longer than 120 characters. | 748
| Cyclomatic Complexity is 22 (max allowed is 10). | 828
| Method length is 97 lines (max allowed is 50). | 828
| Line is longer than 120 characters. | 840
| Line is longer than 120 characters. | 904
| Array should contain trailing comma. | 906
| Array should contain trailing comma. | 916

### edu/internet2/middleware/shibboleth/idp/profile/saml2/ArtifactResolution.java

Violation | Message | Line
--- | --- | ---
| Method length is 63 lines (max allowed is 50). | 91
| Line is longer than 120 characters. | 132
| Line is longer than 120 characters. | 240

### edu/internet2/middleware/shibboleth/idp/profile/saml2/AttributeQueryProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Method length is 56 lines (max allowed is 50). | 74
| Line is longer than 120 characters. | 225

### edu/internet2/middleware/shibboleth/idp/profile/saml2/BaseSAML2ProfileRequestContext.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 34

### edu/internet2/middleware/shibboleth/idp/profile/saml2/SSOProfileHandler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 172
| Method length is 60 lines (max allowed is 50). | 208
| Line is longer than 120 characters. | 232
| Line is longer than 120 characters. | 238
| Line is longer than 120 characters. | 397
| Line is longer than 120 characters. | 521
| Line is longer than 120 characters. | 530
| Line is longer than 120 characters. | 531
| Catching 'Exception' is not allowed. | 563

### edu/internet2/middleware/shibboleth/idp/util/HttpServletHelper.java

Violation | Message | Line
--- | --- | ---
| Utility classes should not have a public or default constructor. | 46
| Line is longer than 120 characters. | 54
| Line is longer than 120 characters. | 66
| Line is longer than 120 characters. | 75
| Line is longer than 120 characters. | 78
| Line is longer than 120 characters. | 84
| Line is longer than 120 characters. | 99
| Name 'log' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. | 115
| Literal Strings should be compared using equals(), not '=='. | 168
| Avoid inline conditionals. | 168
| Line is longer than 120 characters. | 386
| Must have at least one statement. | 389

### edu/internet2/middleware/shibboleth/idp/util/IPRange.java

Violation | Message | Line
--- | --- | ---
| First sentence should end with a period. | 28
| First sentence should end with a period. | 37
| First sentence should end with a period. | 47