Sign upLogin

encryptorcode/iam-oauth

View on GitHub
Star
src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java

Summary

Maintainability
A
0 mins
Test Coverage

Define a constant instead of duplicating this literal "redirect:" 3 times.
Open

        return new ModelAndView("redirect:" + AUTHENTICATION_SERVICE.getLoginRedirectPath(request, providerId, redirect));
Severity: Critical
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by sonar-java

Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

Noncompliant Code Example

With the default threshold of 3:

public void run() {
  prepare("action1");                              // Noncompliant - "action1" is duplicated 3 times
  execute("action1");
  release("action1");
}

@SuppressWarning("all")                            // Compliant - annotations are excluded
private void method1() { /* ... */ }
@SuppressWarning("all")
private void method2() { /* ... */ }

public String method3(String a) {
  System.out.println("'" + a + "'");               // Compliant - literal "'" has less than 5 characters and is excluded
  return "";                                       // Compliant - literal "" has less than 5 characters and is excluded
}

Compliant Solution

private static final String ACTION_1 = "action1";  // Compliant

public void run() {
  prepare(ACTION_1);                               // Compliant
  execute(ACTION_1);
  release(ACTION_1);
}

Exceptions

To prevent generating some false-positives, literals having less than 5 characters are excluded.

Wrong lexicographical order for 'javax.servlet.http.HttpServletResponse' import. Should be before 'org.springframework.web.servlet.ModelAndView'.
Open

import javax.servlet.http.HttpServletResponse;
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 146).
Open

 * In case you plan on using a single provider, You can set the default login url to /login/{provider} in your {@link AuthenticationConfiguration}
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 108).
Open

    private static final AuthenticationService AUTHENTICATION_SERVICE = AuthenticationService.getInstance();
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 106).
Open

        return new ModelAndView("redirect:" + AUTHENTICATION_SERVICE.logout(request, response, redirect));
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 103).
Open

 * A simple controller implementation using spring annotations for handling all the authentication urls
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 122).
Open

        return new ModelAndView("redirect:" + AUTHENTICATION_SERVICE.getLoginRedirectPath(request, providerId, redirect));
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Wrong lexicographical order for 'javax.servlet.http.HttpServletRequest' import. Should be before 'org.springframework.web.servlet.ModelAndView'.
Open

import javax.servlet.http.HttpServletRequest;
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 114).
Open

     * Or if you plan on writing your own controller implementation, you need to make sure same url is provided to
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

First sentence of Javadoc is missing an ending period.
Open

/**
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks thatJavadoc summary sentence does not contain phrases that are not recommended to use.Summaries that contain only the {@inheritDoc} tag are skipped. Check alsoviolate Javadoc that does not contain first sentence.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 105).
Open

 * You still have to handle showing the login page to the user and redirect the user to /login/{provider}
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

First sentence of Javadoc is missing an ending period.
Open

    /**
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks thatJavadoc summary sentence does not contain phrases that are not recommended to use.Summaries that contain only the {@inheritDoc} tag are skipped. Check alsoviolate Javadoc that does not contain first sentence.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Extra separation in import group before 'javax.servlet.http.HttpServletRequest'
Open

import javax.servlet.http.HttpServletRequest;
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

Line is longer than 100 characters (found 112).
Open

            return new ModelAndView("redirect:" + AUTHENTICATION_SERVICE.login(request, response, state, code));
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

First sentence of Javadoc is missing an ending period.
Open

    /**
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks thatJavadoc summary sentence does not contain phrases that are not recommended to use.Summaries that contain only the {@inheritDoc} tag are skipped. Check alsoviolate Javadoc that does not contain first sentence.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

First sentence of Javadoc is missing an ending period.
Open

    /**
Severity: Minor
Found in src/main/java/io/github/encryptorcode/implementation/spring/AuthenticationController.java by checkstyle

Checks thatJavadoc summary sentence does not contain phrases that are not recommended to use.Summaries that contain only the {@inheritDoc} tag are skipped. Check alsoviolate Javadoc that does not contain first sentence.

This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

There are no issues that match your filters.

Category
Status