Author: prabath
Date: Thu Feb 21 20:58:21 2008
New Revision: 14015
Log:
Code formatting + comments
Modified:
trunk/solutions/identity/modules/base/src/main/java/org/wso2/solutions/identity/IdentityConstants.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProviderData.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
Modified:
trunk/solutions/identity/modules/base/src/main/java/org/wso2/solutions/identity/IdentityConstants.java
==============================================================================
---
trunk/solutions/identity/modules/base/src/main/java/org/wso2/solutions/identity/IdentityConstants.java
(original)
+++
trunk/solutions/identity/modules/base/src/main/java/org/wso2/solutions/identity/IdentityConstants.java
Thu Feb 21 20:58:21 2008
@@ -99,6 +99,8 @@
public final static String XML_TOKEN = "xmlToken";
public final static String PROFILE_NAME = "profileName";
+
+ public final static String DEFAULT_PROFILE = "Default Profile";
public static class ErrorCodes {
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
Thu Feb 21 20:58:21 2008
@@ -59,13 +59,10 @@
/**
* Process the Relying Party request at the OpenID Provider end.
- *
- * @param httpReq
- * HttpServletRequest
- * @param httpResp
- * HttpServletResponse
+ * @param httpReq HttpServletRequest
+ * @param httpResp HttpServletResponse
* @return The Url to be redirected
- * @throws Exception
+ * @throws IdentityProviderException
*/
public String processRequest(HttpServletRequest httpReq,
HttpServletResponse httpResp) throws IdentityProviderException {
@@ -286,9 +283,7 @@
/**
* Find the user name corresponding to the given OpenID.
- *
- * @param openId
- * User's OpenID
+ * @param openId User's OpenID
* @return User name corresponding the given OpenID.
* @throws ServerException
* @throws IdentityProviderException
@@ -330,15 +325,12 @@
}
}
}
-
return null;
}
/**
* Generate OpenID for a given user.
- *
- * @param user
- * User
+ * @param user User
* @return Generated OpenID
*/
public static String generateOpenID(String user) {
@@ -358,9 +350,7 @@
}
/**
- *
- * @param authPage
- * Authentication page
+ * @param authPage Authentication page
*/
public void setAuthPage(String authPage) {
@@ -376,7 +366,6 @@
}
/**
- *
* @return OpenID Provider server URL.
*/
public static String getOpAddress() {
@@ -384,7 +373,6 @@
}
/**
- *
* @return ServerManager instance.
*/
public static ServerManager getManager() {
@@ -393,11 +381,8 @@
/**
* Send a direct response to the RP.
- *
- * @param httpResp
- * HttpServletResponse
- * @param response
- * Response message
+ * @param httpResp HttpServletResponse
+ * @param response Response message
* @return
* @throws IOException
*/
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProviderData.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProviderData.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProviderData.java
Thu Feb 21 20:58:21 2008
@@ -22,11 +22,8 @@
/**
* Populate the required claims with claim values.
- *
- * @param requiredClaims
- * Required claims as requested by the RP.
- * @param userId
- * User ID.
+ * @param requiredClaims Required claims as requested by the RP.
+ * @param userId User ID.
* @return A map, populated with required claim values.
* @throws IdentityProviderException
*/
@@ -52,11 +49,8 @@
/**
* Populate the required claims with claim values.
- *
- * @param requiredClaims
- * Required claims as requested by the RP.
- * @param userId
- * User ID.
+ * @param requiredClaims Required claims as requested by the RP.
+ * @param userId User ID.
* @return A map, populated with required claim values.
* @throws IdentityProviderException
*/
@@ -82,11 +76,8 @@
/**
* Populate the required claims with claim values.
- *
- * @param requiredClaims
- * Required claims as requested by the RP.
- * @param userId
- * User ID.
+ * @param requiredClaims Required claims as requested by the RP.
+ * @param userId User ID.
* @return A map, populated with required claim values.
* @throws IdentityProviderException
*/
@@ -124,7 +115,7 @@
String profile = null;
if (this.profileName == null)
- profile = "Default Profile";
+ profile = IdentityConstants.DEFAULT_PROFILE;
else
profile = this.profileName;
@@ -156,21 +147,16 @@
}
/**
- * Populate the response with claim values.
- *
- * @param response
- * Simple Registration response.
- * @param claimValues
- * Claim values.
+ * Populate the response with claim values. If we can't find the required
+ * values with us, we simply avoid sending them. An Identity Provider MAY
+ * return any subset of the following fields in response to the query.
+ * @param response Simple Registration response.
+ * @param claimValues Claim values.
* @throws MessageException
*/
protected void setSimpleAttributeRegistrationValues(SRegResponse response,
Map claimValues) throws MessageException {
- // If we can't find the required values with us, we simply avoid
sending
- // them. An Identity Provider MAY return any subset of the following
- // fields in response to the query.
-
Iterator iterator = null;
String key = null;
OpenIDClaim claim = null;
@@ -186,21 +172,15 @@
}
/**
- * Populate the response with claim values.
- *
- * @param response
- * Attribute Exchange response.
- * @param claimValues
- * Claim values.
+ * Populate the response with claim values. If we can't find the required
+ * values with us, we simply avoid sending them. An Identity Provider MAY
+ * return any subset of the following fields in response to the query.
+ * @param claimValues Claim values.
* @throws MessageException
*/
protected void setAttributeExchangeValues(FetchResponse response,
Map claimValues) throws MessageException {
- // If we can't find the required values with us, we simply avoid
sending
- // them. An Identity Provider MAY return any subset of the following
- // fields in response to the query.
-
Iterator iterator = null;
String key = null;
OpenIDClaim claim = null;
@@ -215,7 +195,6 @@
}
/**
- *
* @return User profile name.
*/
public String getProfileName() {
@@ -223,9 +202,7 @@
}
/**
- *
- * @param profileName
- * User profile name.
+ * @param profileName User profile name.
*/
public void setProfileName(String profileName) {
this.profileName = profileName;
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
Thu Feb 21 20:58:21 2008
@@ -22,7 +22,6 @@
private String opAdress;
/**
- *
* @param manager
*/
public OpenIDInfoCardHeader(ServerManager manager) {
@@ -31,13 +30,9 @@
/**
* Build the OpenIDToken header with the provided parameters.
- *
- * @param openID
- * OpenID Url
- * @param opAddress
- * OpenID Provider server Url
- * @param appliesTo
- * true/false
+ * @param openID OpenID Url
+ * @param opAddress OpenID Provider server Url
+ * @param appliesTo true/false
* @return OpenIDToken header
* @throws IdentityProviderException
*/
@@ -101,7 +96,6 @@
/**
* Creates an association between the OpenID Provider and the Relying
Party.
- *
* @return Association.
* @throws AssociationException
*/
@@ -114,7 +108,6 @@
/**
* Generates nonce token to uniquely identify authentication responses.
- *
* @return Nonce token.
*/
private String getNonce() {
@@ -122,22 +115,21 @@
}
/**
- * @param compatibilty
- * Indicates the compatibility.
+ * Creates the signature out of the specified parameters
+ * @param compatibilty Indicates the compatibility.
* @return Signature.
* @throws MessageException
* @throws AssociationException
*/
private String getSignature(boolean compatibilty) throws MessageException,
AssociationException {
- AuthSuccess openidResp = null;
+ AuthSuccess openidResp = null;
openidResp = AuthSuccess.createAuthSuccess(opAdress, openID, openID,
compatibilty, returnTo, nonce, null, assoc, true);
// sign the message
return openidResp.getSignature();
-
}
}
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
Thu Feb 21 20:58:21 2008
@@ -16,9 +16,7 @@
/**
* Populate CardSpace specific meta-data.
- *
- * @param data
- * WS-Trust information in the issue request.
+ * @param data WS-Trust information in the issue request.
* @throws IdentityProviderException
* @throws ClassNotFoundException
*/
@@ -93,8 +91,6 @@
* support OpenID should have OpenIDTag defined for it.
*/
public class OpenIDRequestedClaimData extends RequestedClaimData {
-
public String openIDTag;
-
}
}
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
Thu Feb 21 20:58:21 2008
@@ -8,9 +8,8 @@
/**
* Constructs an OpenID token encapsulating the provided OpenID Message.
* Should be used on the OP/STS side to generate a RSTR.
- *
- * @param openidMessage The OpenID message obtained from
- * ServerManager.authResponse().
+ * @param openidMessage The OpenID message obtained from
+ * ServerManager.authResponse().
*/
public OpenIDInfoCardToken(Message openidMessage) {
super(openidMessage);
@@ -18,7 +17,8 @@
}
/**
- * Returns a well-formatted string token corresponding to the parameter
list.
+ * Returns a well-formatted string token corresponding to the parameter
+ * list.
*/
public String getToken() {
return getOpenIDMessage().keyValueFormEncoding();
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
Thu Feb 21 20:58:21 2008
@@ -5,19 +5,20 @@
import org.hibernate.Query;
import org.hibernate.Session;
import org.wso2.solutions.identity.persistence.dataobject.OpenIDUserRPDO;
+import org.wso2.solutions.identity.persistence.HibernateConfig;
public class OpenIDUserRPDAO extends BaseDAO {
- public OpenIDUserRPDAO(
- org.wso2.solutions.identity.persistence.HibernateConfig config) {
+ public OpenIDUserRPDAO(HibernateConfig config) {
super(config);
}
/**
- *
- * @param userId
- * @param rpUrl
- * @return
+ * Returns relying party user settings corresponding to a given user name.
+ * @param userName Unique user name
+ * @param rpUrl Relying party url
+ * @return A set of OpenIDUserRPDO, corresponding to the provided user name
+ * and RP url.
*/
public OpenIDUserRPDO[] getOpenIDUserRP(String userName, String rpUrl) {
@@ -42,9 +43,10 @@
}
/**
- *
- * @param userId
- * @return
+ * Returns relying party user settings corresponding to a given user name.
+ * @param userName Unique user name
+ * @return OpenIDUserRPDO, corresponding to the provided user name and RP
+ * url.
*/
public OpenIDUserRPDO[] getOpenIDUserRP(String userName) {
@@ -69,9 +71,11 @@
}
/**
- *
- * @param userId
- * @return
+ * Returns the default user profile correspodning to the given user name
and
+ * the RP url.
+ * @param userName Unique user name
+ * @param rpUrl Relying party url
+ * @return Default user profile
*/
public String getOpenIDDefaultUserProfile(String userName, String rpUrl) {
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
Thu Feb 21 20:58:21 2008
@@ -4,9 +4,7 @@
import org.wso2.usermanager.readwrite.DefaultRealm;
/**
- *
* Extends base class functionality to introduce multiple profile support.
- *
*/
public class IdentityDefaultRealm extends DefaultRealm {
@@ -22,7 +20,6 @@
}
/**
- *
* @return IdentityUserStoreAdmin
*/
public IdentityUserStoreAdmin getIdentityUserStoreAdmin() {
@@ -30,7 +27,6 @@
}
/**
- *
* @return IdentityUserStoreReader
*/
public IdentityUserStoreReader getIdentityUserStoreReader() {
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
Thu Feb 21 20:58:21 2008
@@ -5,25 +5,18 @@
import org.wso2.usermanager.UserManagerException;
/**
- *
* This interface adds the functionality related to multiple profiles. A given
* user can have multiple profiles with different attribute values. This
* contains methods corresponding to adding attribute values to user profiles.
- *
*/
public interface IdentityUserStoreAdmin {
/**
* This sets user properties corresponding to the given user name and the
* profile name.
- *
- * @param userName
- * Unique user name
- * @param properties
- * Profile properties
- * @param profileName
- * Name of the profile
- *
+ * @param userName Unique user name
+ * @param properties Profile properties
+ * @param profileName Name of the profile
* @throws UserManagerException
*/
public void setUserProperties(String userName, Map properties,
Modified:
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
==============================================================================
---
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
(original)
+++
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
Thu Feb 21 20:58:21 2008
@@ -10,18 +10,14 @@
* user can have multiple profiles with different attribute values. This
* contains methods corresponding to reading attribute values from user
* profiles.
- *
*/
public interface IdentityUserStoreReader {
/**
* Get the user properties corresponding to the given user name and the
* profile name.
- *
- * @param userName
- * Unique user name
- * @param profileName
- * Profile name, unique to a given user
+ * @param userName Unique user name
+ * @param profileName Profile name, unique to a given user
* @return User properties corresponding to the given user name and the
* profile name
* @throws UserManagerException
@@ -32,9 +28,7 @@
/**
* A given user can have multiple profiles. This returns all the profile
* names for a given user.
- *
- * @param userName
- * Unique user name
+ * @param userName Unique user name
* @return Profile names corresponding to the given user name.
* @throws UserManagerException
*/
@@ -44,9 +38,7 @@
/**
* A given user should have a default profile name. This returns the name
of
* the default profile for a given user.
- *
- * @param userName
- * Unique user name
+ * @param userName Unique user name
* @return Default profile name corresponding to the given user name.
* @throws UserManagerException
*/
@@ -57,11 +49,8 @@
* Profile name for a given user should be unique. A single user cannot
have
* multiple profiles with the same profile name. This checks whether the
* given user have a profile of the provided profile name.
- *
- * @param userName
- * Unique user name
- * @param profileName
- * Profile name
+ * @param userName Unique user name
+ * @param profileName Profile name
* @return True, if the given user does have a profile with the same name,
* else false
* @throws UserManagerException
_______________________________________________
Identity-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/identity-dev
