more javadoc fixes #2056

Signed-off-by: olivier lamy <olamy@webtide.com>
This commit is contained in:
olivier lamy 2018-01-08 19:54:09 +11:00
parent 083c8045e8
commit b48364c298
3 changed files with 15 additions and 18 deletions

View File

@ -184,8 +184,9 @@ public class LdapLoginModule extends AbstractLoginModule
Attributes attributes; Attributes attributes;
/** /**
* @param userName * @param userName the user name
* @param credential * @param credential the credential
* @param attributes the user {@link Attributes}
*/ */
public LDAPUserInfo(String userName, Credential credential, Attributes attributes) public LDAPUserInfo(String userName, Credential credential, Attributes attributes)
{ {
@ -266,25 +267,21 @@ public class LdapLoginModule extends AbstractLoginModule
* NOTE: this is not an user authenticated operation * NOTE: this is not an user authenticated operation
* *
* @param username * @param username
* @return * @return the {@link Attributes} from the user
* @throws LoginException * @throws LoginException
*/ */
private Attributes getUserAttributes(String username) throws LoginException private Attributes getUserAttributes(String username) throws LoginException
{ {
Attributes attributes = null;
SearchResult result;
try try
{ {
result = findUser(username); SearchResult result = findUser(username);
attributes = result.getAttributes(); Attributes attributes = result.getAttributes();
return attributes;
} }
catch (NamingException e) catch (NamingException e)
{ {
throw new LoginException("Root context binding failure."); throw new LoginException("Root context binding failure.");
} }
return attributes;
} }
private String getUserCredentials(Attributes attributes) throws LoginException private String getUserCredentials(Attributes attributes) throws LoginException

View File

@ -42,9 +42,9 @@ public class UserInfo
/** /**
* @param userName * @param userName the user name
* @param credential * @param credential the credential
* @param roleNames * @param roleNames a {@link List} of role name
*/ */
public UserInfo (String userName, Credential credential, List<String> roleNames) public UserInfo (String userName, Credential credential, List<String> roleNames)
{ {
@ -76,8 +76,8 @@ public class UserInfo
* Should be overridden by subclasses to obtain * Should be overridden by subclasses to obtain
* role info * role info
* *
* @return * @return List of role associated to the user
* @throws Exception * @throws Exception if the roles cannot be retrieved
*/ */
public List<String> doFetchRoles() public List<String> doFetchRoles()
throws Exception throws Exception

View File

@ -123,7 +123,7 @@ public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor
* @param context the webapp * @param context the webapp
* @param descriptor the xml file to process * @param descriptor the xml file to process
* @param node the context-param node in the xml file * @param node the context-param node in the xml file
* @throws Exception * @throws Exception if some resources cannot be read
*/ */
public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node) public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node)
throws Exception throws Exception