##### Project Documentation

- Checkstyle

## Checkstyle Results

The following document contains the results of Checkstyle.

## Summary

Files | Infos | Warnings | Errors
--- | --- | --- | ---
19 | 0 | 74 | 0

## Files

Files | I | W | E
--- | --- | --- | ---
edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.java | 0 | 23 | 0
edu/internet2/middleware/shibboleth/wayf/HandlerConfig.java | 0 | 3 | 0
edu/internet2/middleware/shibboleth/wayf/IdPSite.java | 0 | 12 | 0
edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.java | 0 | 15 | 0
edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/wayf/Version.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/wayf/WayfService.java | 0 | 7 | 0
edu/internet2/middleware/shibboleth/wayf/XMLConstants.java | 0 | 1 | 0
edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.java | 0 | 3 | 0
edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.java | 0 | 2 | 0
edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.java | 0 | 6 | 0

## Rules

Rules | Violations | Severity
--- | --- | ---
JavadocMethod suppressLoadErrors: `"true"` allowThrowsTagsForSubclasses: `"true"` | 17 | Warning
JavadocType | 1 | Warning
JavadocVariable | 0 | Warning
JavadocStyle checkEmptyJavadoc: `"true"` | 5 | Warning
ConstantName | 0 | Warning
LocalFinalVariableName | 0 | Warning
LocalVariableName | 0 | Warning
MemberName | 0 | Warning
MethodName | 0 | Warning
PackageName | 0 | Warning
ParameterName | 2 | 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"` | 8 | Warning
MethodLength max: `"50"` | 8 | Warning
ParameterNumber max: `"5"` | 4 | Warning
EmptyForIteratorPad | 0 | Warning
MethodParamPad | 0 | Warning
TabCharacter | 0 | Warning
ModifierOrder | 0 | Warning
AvoidNestedBlocks | 0 | Warning
EmptyBlock | 1 | Warning
LeftCurly | 0 | Warning
NeedBraces | 0 | Warning
RightCurly | 0 | Warning
AvoidInlineConditionals | 0 | Warning
DoubleCheckedLocking | 0 | Warning
EmptyStatement | 1 | Warning
EqualsHashCode | 0 | Warning
HiddenField | 3 | Warning
IllegalInstantiation | 0 | Warning
InnerAssignment | 0 | Warning
MissingSwitchDefault | 0 | Warning
RedundantThrows | 0 | Warning
SimplifyBooleanExpression | 0 | Warning
SimplifyBooleanReturn | 0 | Warning
FinalClass | 0 | Warning
HideUtilityClassConstructor | 3 | 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 | 1 | Warning
FallThrough | 0 | Warning
IllegalCatch | 3 | Warning
IllegalThrows | 0 | Warning
JUnitTestCase | 0 | Warning
MultipleVariableDeclarations | 0 | Warning
PackageDeclaration | 0 | Warning
ParameterAssignment | 2 | Warning
ReturnCount max: `"4"` | 0 | Warning
StringLiteralEquality | 1 | Warning
SuperFinalize | 0 | Warning
ArrayTrailingComma | 0 | Warning
UnnecessaryParentheses | 4 | Warning
MutableException | 0 | Warning
ThrowsCount max: `"3"` | 0 | Warning
CyclomaticComplexity | 8 | Warning
TrailingComment | 0 | Warning
PackageHtml fileExtensions: `"html"` | 0 | Warning

## Details

### edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.java

Violation | Message | Line
--- | --- | ---
| File length is 1,003 lines (max allowed is 1,000). | 1
| Cyclomatic Complexity is 12 (max allowed is 10). | 166
| Method length is 91 lines (max allowed is 50). | 166
| 'config' hides a field. | 166
| 'plugins' hides a field. | 168
| Line is longer than 120 characters. | 212
| Line is longer than 120 characters. | 214
| Cyclomatic Complexity is 11 (max allowed is 10). | 287
| Missing a Javadoc comment. | 287
| Must have at least one statement. | 328
| Cyclomatic Complexity is 25 (max allowed is 10). | 400
| Method length is 141 lines (max allowed is 50). | 400
| Expected an @return tag. | 550
| Expected @param tag for 'discovery'. | 550
| Expected @param tag for 'providedName'. | 550
| Cyclomatic Complexity is 35 (max allowed is 10). | 583
| Method length is 216 lines (max allowed is 50). | 583
| Unnecessary parentheses around assignment right-hand side. | 589
| Unnecessary parentheses around assignment right-hand side. | 590
| Cyclomatic Complexity is 14 (max allowed is 10). | 834
| Method length is 99 lines (max allowed is 50). | 834
| Unnecessary parentheses around assignment right-hand side. | 839
| Missing a Javadoc comment. | 975

### edu/internet2/middleware/shibboleth/wayf/HandlerConfig.java

Violation | Message | Line
--- | --- | ---
| Cyclomatic Complexity is 16 (max allowed is 10). | 82
| Method length is 68 lines (max allowed is 50). | 82
| First sentence should end with a period. | 214

### edu/internet2/middleware/shibboleth/wayf/IdPSite.java

Violation | Message | Line
--- | --- | ---
| First sentence should end with a period. | 41
| First sentence should end with a period. | 60
| First sentence should end with a period. | 78
| First sentence should end with a period. | 118
| Unused @param tag for 'lang'. | 120
| Expected @param tag for 'req'. | 134
| Missing a Javadoc comment. | 190
| Variable 'req' explicitly initialized to 'null' (default value for its type). | 198
| Missing a Javadoc comment. | 200
| Missing a Javadoc comment. | 205
| 'req' hides a field. | 205
| Missing a Javadoc comment. | 209

### edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 105
| Cyclomatic Complexity is 19 (max allowed is 10). | 105
| Method length is 110 lines (max allowed is 50). | 105
| Catching 'Exception' is not allowed. | 168
| Method length is 51 lines (max allowed is 50). | 274
| Name 'SPName' must match pattern '^[a-z][a-zA-Z0-9]*$'. | 353
| Name 'IdPName' must match pattern '^[a-z][a-zA-Z0-9]*$'. | 394
| Expected @param tag for 'plugin'. | 444
| Line is longer than 120 characters. | 450
| Missing a Javadoc comment. | 452
| Unnecessary parentheses around expression. | 463
| Expected @param tag for 'entity'. | 502
| Expected @param tag for 'entity'. | 521
| Expected @throws tag for 'WayfException'. | 541
| Missing a Javadoc comment. | 552

### edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.java

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

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

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

### edu/internet2/middleware/shibboleth/wayf/WayfService.java

Violation | Message | Line
--- | --- | ---
| Unused import - javax.servlet.GenericServlet. | 27
| Cyclomatic Complexity is 26 (max allowed is 10). | 75
| Method length is 189 lines (max allowed is 50). | 75
| Line is longer than 120 characters. | 100
| Line is longer than 120 characters. | 156
| Catching 'Exception' is not allowed. | 228
| Catching 'Exception' is not allowed. | 252

### edu/internet2/middleware/shibboleth/wayf/XMLConstants.java

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

### edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.java

Violation | Message | Line
--- | --- | ---
| More than 5 parameters. | 106
| More than 5 parameters. | 136
| Expected @param tag for 'idP'. | 158

### edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 120 characters. | 167
| Line is longer than 120 characters. | 171

### edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.java

Violation | Message | Line
--- | --- | ---
| More than 5 parameters. | 170
| Empty statement. | 201
| More than 5 parameters. | 248
| Assignment of parameter 'codedData' is not allowed. | 352
| Assignment of parameter 'codedData' is not allowed. | 356
| Literal Strings should be compared using equals(), not '!='. | 475