Author: dimuthul
Date: Mon Jan 21 02:54:30 2008
New Revision: 12608
Log:
Code Commenting
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/RealmConfigParameterInfo.java
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/UserManagerConfigException.java
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/acegi/AcegiRealmConfig.java
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
trunk/commons/usermanager/modules/core/src/main/java/org/wso2/usermanager/readwrite/DefaultUserStoreReader.java
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/RealmConfigParameterInfo.java
==============================================================================
---
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/RealmConfigParameterInfo.java
(original)
+++
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/RealmConfigParameterInfo.java
Mon Jan 21 02:54:30 2008
@@ -3,10 +3,10 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
-
@Retention(RetentionPolicy.RUNTIME)
-public @interface RealmConfigParameterInfo{
-
+public @interface RealmConfigParameterInfo {
+
public boolean isRequired();
+
public String getHelpText();
}
\ No newline at end of file
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/UserManagerConfigException.java
==============================================================================
---
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/UserManagerConfigException.java
(original)
+++
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/config/UserManagerConfigException.java
Mon Jan 21 02:54:30 2008
@@ -1,25 +1,22 @@
package org.wso2.usermanager.config;
-public class UserManagerConfigException extends Exception{
+public class UserManagerConfigException
+ extends Exception {
public UserManagerConfigException() {
super();
- // TODO Auto-generated constructor stub
}
public UserManagerConfigException(String message, Throwable cause) {
super(message, cause);
- // TODO Auto-generated constructor stub
}
public UserManagerConfigException(String message) {
super(message);
- // TODO Auto-generated constructor stub
}
public UserManagerConfigException(Throwable cause) {
super(cause);
- // TODO Auto-generated constructor stub
}
}
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/acegi/AcegiRealmConfig.java
==============================================================================
---
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/acegi/AcegiRealmConfig.java
(original)
+++
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/acegi/AcegiRealmConfig.java
Mon Jan 21 02:54:30 2008
@@ -1,6 +1,5 @@
package org.wso2.usermanager.custom.acegi;
-
import org.wso2.usermanager.config.RealmConfigParameterInfo;
import org.wso2.usermanager.config.UserManagerConfigException;
@@ -9,40 +8,43 @@
public String authenticationProviderBeanMappingFile = null;
public String authProviderId = null;
-
- public AcegiRealmConfig(){}
-
-
- public AcegiRealmConfig(AcegiRealmConfig oldConfig){
- this.authenticationProviderBeanMappingFile = new
String(oldConfig.getAuthenticationProviderBeanMappingFile());
+
+ public AcegiRealmConfig() {
+ }
+
+ public AcegiRealmConfig(AcegiRealmConfig oldConfig) {
+ this.authenticationProviderBeanMappingFile = new String(oldConfig
+ .getAuthenticationProviderBeanMappingFile());
this.authProviderId = new String(oldConfig.getAuthProviderId());
}
-
- @RealmConfigParameterInfo(isRequired=true, getHelpText="BeanMapping file")
+
+ @RealmConfigParameterInfo(isRequired = true, getHelpText = "BeanMapping
file")
public String getAuthenticationProviderBeanMappingFile() {
return authenticationProviderBeanMappingFile;
}
-
+
public void setAuthenticationProviderBeanMappingFile(
String authenticationProviderBeanMapping) {
this.authenticationProviderBeanMappingFile =
authenticationProviderBeanMapping;
}
- @RealmConfigParameterInfo(isRequired=true, getHelpText="Authentication
provider id")
+ @RealmConfigParameterInfo(isRequired = true, getHelpText = "Authentication
provider id")
public String getAuthProviderId() {
return authProviderId;
}
-
+
public void setAuthProviderId(String authProviderId) {
this.authProviderId = authProviderId;
}
-
+
public void validate() throws UserManagerConfigException {
- if(authProviderId == null || authenticationProviderBeanMappingFile ==
null){
+ if (authProviderId == null
+ || authenticationProviderBeanMappingFile == null) {
throw new UserManagerConfigException("acegiConfigValidation");
}
-
- if(authProviderId.equals("") ||
authenticationProviderBeanMappingFile.equals("")){
+
+ if (authProviderId.equals("")
+ || authenticationProviderBeanMappingFile.equals("")) {
throw new UserManagerConfigException("acegiConfigValidation");
}
}
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
==============================================================================
---
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
(original)
+++
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
Mon Jan 21 02:54:30 2008
@@ -70,9 +70,9 @@
}
public String getDriverName() {
- if(driverName == null || driverName.equals("")){
+ if (driverName == null || driverName.equals("")) {
return "org.apache.derby.jdbc.EmbeddedDriver";
- }else{
+ } else {
return driverName;
}
}
@@ -99,35 +99,42 @@
throw new UserManagerConfigException("jdbcConfigValidation");
}
}
-
+
@RealmConfigParameterInfo(isRequired = true, getHelpText = "e.g.
jdbc:derby:home/identity/database/USER_DB")
public void setConnectionURL(String connectionURL) {
this.connectionURL = connectionURL.trim();
}
+
@RealmConfigParameterInfo(isRequired = false, getHelpText = "Username of
the connection, if there is one")
public void setConnectionUserName(String connectionName) {
this.connectionUserName = connectionName.trim();
}
+
@RealmConfigParameterInfo(isRequired = false, getHelpText = "Password of
the connection, if there is one")
public void setConnectionPassword(String connectionPassword) {
this.connectionPassword = connectionPassword.trim();
}
+
@RealmConfigParameterInfo(isRequired = true, getHelpText = "Name of the
users table - e.g. user_table")
public void setUserTable(String userTable) {
this.userTable = userTable.trim();
}
+
@RealmConfigParameterInfo(isRequired = true, getHelpText = "User name
column")
public void setUserNameColumn(String userNameCol) {
this.userNameColumn = userNameCol.trim();
}
+
@RealmConfigParameterInfo(isRequired = true, getHelpText = "Password
column of user table")
public void setUserCredentialColumn(String userCredentialCol) {
this.userCredentialColumn = userCredentialCol.trim();
}
+
@RealmConfigParameterInfo(isRequired = false, getHelpText = "Driver name -
e.g. org.apache.derby.jdbc.EmbeddedDriver")
public void setDriverName(String driverName) {
this.driverName = driverName.trim();
}
+
@RealmConfigParameterInfo(isRequired = false, getHelpText = "Comma
separated columns in the user table - e.g. email, age")
public void setColumnNames(String columnNames) {
this.columnNames = columnNames.trim();
Modified:
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
==============================================================================
---
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
(original)
+++
trunk/commons/usermanager/modules/annotation-configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
Mon Jan 21 02:54:30 2008
@@ -16,7 +16,6 @@
package org.wso2.usermanager.custom.ldap;
-
import org.wso2.usermanager.config.RealmConfigParameterInfo;
import org.wso2.usermanager.config.UserManagerConfigException;
@@ -92,7 +91,7 @@
}
@RealmConfigParameterInfo(isRequired = false, getHelpText = "Comma
separated attribute Ids - e.g. email, age")
- public void setAttributeIds(String attributeIds){
+ public void setAttributeIds(String attributeIds) {
this.attributeIds = attributeIds.trim();
}
Modified:
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
==============================================================================
---
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
(original)
+++
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/jdbc/JDBCRealmConfig.java
Mon Jan 21 02:54:30 2008
@@ -17,33 +17,33 @@
package org.wso2.usermanager.custom.jdbc;
/**
- * Configuration Bean to be used in the JDBCRealmConfig.
- * Contains all the data that is needed to initialize the JDBCRealmConfig
+ * Configuration Bean to be used in the JDBCRealmConfig. Contains all the data
+ * that is needed to initialize the JDBCRealmConfig
*/
public class JDBCRealmConfig {
- /** User table name*/
+ /** User table name */
protected String userTable = null;
- /** User name column*/
+ /** User name column */
protected String userNameColumn = null;
- /** User credential column*/
+ /** User credential column */
protected String userCredentialColumn = null;
- /** User connection URL*/
+ /** User connection URL */
protected String connectionURL = null;
- /** Driver name*/
+ /** Driver name */
protected String driverName = null;
- /** Connection User Name*/
+ /** Connection User Name */
protected String connectionUserName = null;
- /** Connection Password*/
+ /** Connection Password */
protected String connectionPassword = null;
- /** Column name*/
+ /** Column name */
protected String columnNames = null;
public JDBCRealmConfig() {
Modified:
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
==============================================================================
---
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
(original)
+++
trunk/commons/usermanager/modules/configs/src/main/java/org/wso2/usermanager/custom/ldap/LDAPRealmConfig.java
Mon Jan 21 02:54:30 2008
@@ -17,8 +17,8 @@
package org.wso2.usermanager.custom.ldap;
/**
- * Configuration Bean to be used in the AcegiRealmConfig
- * Contains all the data that is needed to initialize the AcegiRealmConfig
+ * Configuration Bean to be used in the AcegiRealmConfig Contains all the data
+ * that is needed to initialize the AcegiRealmConfig
*/
public class LDAPRealmConfig {
Modified:
trunk/commons/usermanager/modules/core/src/main/java/org/wso2/usermanager/readwrite/DefaultUserStoreReader.java
==============================================================================
---
trunk/commons/usermanager/modules/core/src/main/java/org/wso2/usermanager/readwrite/DefaultUserStoreReader.java
(original)
+++
trunk/commons/usermanager/modules/core/src/main/java/org/wso2/usermanager/readwrite/DefaultUserStoreReader.java
Mon Jan 21 02:54:30 2008
@@ -33,6 +33,11 @@
import org.wso2.usermanager.UserStoreReader;
import org.wso2.usermanager.readwrite.util.DefaultStrategyImpl;
+/**
+ * Manipulates data in the User Store
+ *
+ * @see org.wso2.usermanager.UserStoreReader
+ */
public class DefaultUserStoreReader implements UserStoreReader {
private static Log log = LogFactory.getLog(DefaultUserStoreReader.class);
_______________________________________________
Commons-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/commons-dev
