Skip to content
Snippets Groups Projects
Commit 80683822 authored by brinn's avatar brinn
Browse files

reformat: adapt comments to of 100 characters per line

SVN: 5430
parent 11660407
No related branches found
No related tags found
No related merge requests found
...@@ -27,25 +27,25 @@ public interface IAuthenticationService extends ISelfTestable ...@@ -27,25 +27,25 @@ public interface IAuthenticationService extends ISelfTestable
{ {
/** /**
* Attempts authentication of the application with credentials passed in the constructor and retuns the application * Attempts authentication of the application with credentials passed in the constructor and
* token. Implementations should log what is going on, whether the application could register itself successfully or * retuns the application token. Implementations should log what is going on, whether the
* not. * application could register itself successfully or not.
* <p> * <p>
* The returned application token can then be used to authenticate an user (via * The returned application token can then be used to authenticate an user (via
* {@link #authenticateUser(String, String, String)}) or to retrieve additional details about an user (via * {@link #authenticateUser(String, String, String)}) or to retrieve additional details about
* {@link #getPrincipal(String, String)}) * an user (via {@link #getPrincipal(String, String)})
* </p> * </p>
* *
* @return the application token if the application has been successfully authenticated, <code>null</code> * @return the application token if the application has been successfully authenticated,
* otherwise. * <code>null</code> otherwise.
*/ */
public String authenticateApplication(); public String authenticateApplication();
/** /**
* Attempts authentication for the given user credentials. * Attempts authentication for the given user credentials.
* <p> * <p>
* Note that the application must be authenticated (meaning that <var>applicationToken</var> is not * Note that the application must be authenticated (meaning that <var>applicationToken</var> is
* <code>null</code>) to perform this lookup. * not <code>null</code>) to perform this lookup.
* </p> * </p>
* *
* @return <code>true</code> if the <var>user</var> has been successfully authenticated. * @return <code>true</code> if the <var>user</var> has been successfully authenticated.
...@@ -53,14 +53,15 @@ public interface IAuthenticationService extends ISelfTestable ...@@ -53,14 +53,15 @@ public interface IAuthenticationService extends ISelfTestable
public boolean authenticateUser(String applicationToken, String user, String password); public boolean authenticateUser(String applicationToken, String user, String password);
/** /**
* For a given user name returns additional details encapsulated in returned <code>Principal</code>. * For a given user name returns additional details encapsulated in returned
* <code>Principal</code>.
* <p> * <p>
* Note that the application must be authenticated (meaning that <var>applicationToken</var> is not * Note that the application must be authenticated (meaning that <var>applicationToken</var> is
* <code>null</code>) to perform this lookup. * not <code>null</code>) to perform this lookup.
* </p> * </p>
* *
* @return a <code>Principal</code> object if given <var>user</var> could be found, <code>null</code> * @return a <code>Principal</code> object if given <var>user</var> could be found,
* otherwise. * <code>null</code> otherwise.
*/ */
public Principal getPrincipal(String applicationToken, String user); public Principal getPrincipal(String applicationToken, String user);
} }
\ No newline at end of file
...@@ -52,7 +52,7 @@ public class FileAuthenticationService implements IAuthenticationService ...@@ -52,7 +52,7 @@ public class FileAuthenticationService implements IAuthenticationService
LogFactory.getLogger(LogCategory.OPERATION, FileAuthenticationService.class); LogFactory.getLogger(LogCategory.OPERATION, FileAuthenticationService.class);
private final PasswordFile passwordFile; private final PasswordFile passwordFile;
public FileAuthenticationService(final String passwordFileName) public FileAuthenticationService(final String passwordFileName)
{ {
this.passwordFile = new PasswordFile(new File(passwordFileName)); this.passwordFile = new PasswordFile(new File(passwordFileName));
......
...@@ -72,7 +72,7 @@ final class Parameters ...@@ -72,7 +72,7 @@ final class Parameters
@Option(name = "p", longName = "password", usage = "The password.") @Option(name = "p", longName = "password", usage = "The password.")
private String password; private String password;
@Option(name = "P", longName = "change-password", usage = "Read the new password from the console,") @Option(name = "P", longName = "change-password", usage = "Read the new password from the console,")
private boolean changePassword; private boolean changePassword;
...@@ -214,7 +214,7 @@ final class Parameters ...@@ -214,7 +214,7 @@ final class Parameters
{ {
return emailOrNull; return emailOrNull;
} }
/** /**
* Returns <code>true</code>, if the password should be changed. * Returns <code>true</code>, if the password should be changed.
* <p> * <p>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment