Commit 22b3986e7640510f4ccb813cd790e1e0ab6b3d36
1 parent
006be7c1
Exists in
master
Adição de javadoc nos pacotes security e util.
Showing
5 changed files
with
41 additions
and
0 deletions
Show diff stats
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/security/Credentials.java
| @@ -41,6 +41,13 @@ import java.io.Serializable; | @@ -41,6 +41,13 @@ import java.io.Serializable; | ||
| 41 | import javax.enterprise.context.RequestScoped; | 41 | import javax.enterprise.context.RequestScoped; |
| 42 | import javax.inject.Named; | 42 | import javax.inject.Named; |
| 43 | 43 | ||
| 44 | +/** | ||
| 45 | + * This classes keeps credential informations, username and password. | ||
| 46 | + * | ||
| 47 | + * @author SERPRO | ||
| 48 | + * | ||
| 49 | + */ | ||
| 50 | + | ||
| 44 | @Named | 51 | @Named |
| 45 | @RequestScoped | 52 | @RequestScoped |
| 46 | public class Credentials implements Serializable { | 53 | public class Credentials implements Serializable { |
| @@ -51,6 +58,9 @@ public class Credentials implements Serializable { | @@ -51,6 +58,9 @@ public class Credentials implements Serializable { | ||
| 51 | 58 | ||
| 52 | private String password; | 59 | private String password; |
| 53 | 60 | ||
| 61 | + /** | ||
| 62 | + * Cleans the stored information, setting username and password to null. | ||
| 63 | + */ | ||
| 54 | public void clear() { | 64 | public void clear() { |
| 55 | this.username = null; | 65 | this.username = null; |
| 56 | this.password = null; | 66 | this.password = null; |
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/security/ServletAuthenticator.java
| @@ -48,6 +48,14 @@ import br.gov.frameworkdemoiselle.util.Beans; | @@ -48,6 +48,14 @@ import br.gov.frameworkdemoiselle.util.Beans; | ||
| 48 | import br.gov.frameworkdemoiselle.util.NameQualifier; | 48 | import br.gov.frameworkdemoiselle.util.NameQualifier; |
| 49 | import br.gov.frameworkdemoiselle.util.ResourceBundle; | 49 | import br.gov.frameworkdemoiselle.util.ResourceBundle; |
| 50 | 50 | ||
| 51 | +/** | ||
| 52 | + * Implements the {@link Authenticator} interface, offering a way to implement | ||
| 53 | + * offering a manner to use the authenticator's functionalities. | ||
| 54 | + * | ||
| 55 | + * @author SERPRO | ||
| 56 | + * | ||
| 57 | + */ | ||
| 58 | + | ||
| 51 | @Priority(L2_PRIORITY) | 59 | @Priority(L2_PRIORITY) |
| 52 | public class ServletAuthenticator implements Authenticator { | 60 | public class ServletAuthenticator implements Authenticator { |
| 53 | 61 |
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/security/ServletAuthorizer.java
| @@ -46,6 +46,14 @@ import br.gov.frameworkdemoiselle.internal.producer.ResourceBundleProducer; | @@ -46,6 +46,14 @@ import br.gov.frameworkdemoiselle.internal.producer.ResourceBundleProducer; | ||
| 46 | import br.gov.frameworkdemoiselle.util.Beans; | 46 | import br.gov.frameworkdemoiselle.util.Beans; |
| 47 | import br.gov.frameworkdemoiselle.util.ResourceBundle; | 47 | import br.gov.frameworkdemoiselle.util.ResourceBundle; |
| 48 | 48 | ||
| 49 | +/** | ||
| 50 | + * Implements the {@link Authorizer} interface, offering a way to implement | ||
| 51 | + * offering a manner to use the authorizer's functionalities. | ||
| 52 | + * | ||
| 53 | + * @author SERPRO | ||
| 54 | + * | ||
| 55 | + */ | ||
| 56 | + | ||
| 49 | @Priority(L2_PRIORITY) | 57 | @Priority(L2_PRIORITY) |
| 50 | public class ServletAuthorizer implements Authorizer { | 58 | public class ServletAuthorizer implements Authorizer { |
| 51 | 59 |
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/util/ServletFilter.java
| @@ -45,6 +45,13 @@ import javax.servlet.ServletException; | @@ -45,6 +45,13 @@ import javax.servlet.ServletException; | ||
| 45 | import javax.servlet.ServletRequest; | 45 | import javax.servlet.ServletRequest; |
| 46 | import javax.servlet.ServletResponse; | 46 | import javax.servlet.ServletResponse; |
| 47 | 47 | ||
| 48 | +/** | ||
| 49 | + * Implements the {@link javax.servlet.Filter} interface. | ||
| 50 | + * | ||
| 51 | + * @author SERPRO | ||
| 52 | + * | ||
| 53 | + */ | ||
| 54 | + | ||
| 48 | public class ServletFilter implements Filter { | 55 | public class ServletFilter implements Filter { |
| 49 | 56 | ||
| 50 | @Override | 57 | @Override |
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/util/ServletListener.java
| @@ -41,6 +41,14 @@ import javax.servlet.ServletContextEvent; | @@ -41,6 +41,14 @@ import javax.servlet.ServletContextEvent; | ||
| 41 | import br.gov.frameworkdemoiselle.lifecycle.AfterShutdownProccess; | 41 | import br.gov.frameworkdemoiselle.lifecycle.AfterShutdownProccess; |
| 42 | import br.gov.frameworkdemoiselle.lifecycle.AfterStartupProccess; | 42 | import br.gov.frameworkdemoiselle.lifecycle.AfterStartupProccess; |
| 43 | 43 | ||
| 44 | +/** | ||
| 45 | + * Implements the {@link javax.servlet.ServletContextListener} interface, and fire two events: | ||
| 46 | + * {@link AfterStartupProccess} and {@link AfterShutdownProccess}. | ||
| 47 | + * | ||
| 48 | + * @author SERPRO | ||
| 49 | + * | ||
| 50 | + */ | ||
| 51 | + | ||
| 44 | public class ServletListener implements javax.servlet.ServletContextListener { | 52 | public class ServletListener implements javax.servlet.ServletContextListener { |
| 45 | 53 | ||
| 46 | @Override | 54 | @Override |