Author: keith
Date: Thu Jan 17 19:19:17 2008
New Revision: 12443
Log:
Adding documentation
Modified:
trunk/mashup/java/modules/admin/service/src/org/wso2/mashup/admin/service/MashupLoginService.java
Modified:
trunk/mashup/java/modules/admin/service/src/org/wso2/mashup/admin/service/MashupLoginService.java
==============================================================================
---
trunk/mashup/java/modules/admin/service/src/org/wso2/mashup/admin/service/MashupLoginService.java
(original)
+++
trunk/mashup/java/modules/admin/service/src/org/wso2/mashup/admin/service/MashupLoginService.java
Thu Jan 17 19:19:17 2008
@@ -39,6 +39,22 @@
private static final Log log = LogFactory.getLog(MashupLoginService.class);
private PersistenceManager pm = new PersistenceManager();
+ /**
+ * This is the operation that should be called in order to login to the
mashup server. This operation requires the
+ * user to send Username Tokens or hin Infocard Token. This class is
exposed a two separate services which have
+ * serapate security policies. One requires UsernameTokens while the other
require Infocard Token. Rampart and WSAS
+ * takes care of validating the users cridentials hence the user gets to
this operation only if he is authorized.
+ *
+ * As this service is deployed in transport session we maintain the users
login status as a property in the
+ * ServiceGroupContext. In sudsequent request to this service group a
handler
+ * org.wso2.mashup.admin.handler.AuthenticationHandler checks for this
property in the ServiceGroupContext and if
+ * its not set prevents the user from accessing services under this
service group.
+ *
+ * All operation thst need secure access should be put under
MashupSdminService which is under this service Group.
+ * @return boolean - Returns true if everything went well (Setting the
parameter to ServiceGroupContext and
+ * updating the DB with last login details).
+ * @throws MashupFault - Thrown in case the username cannot be retrived or
if persisting the data fails.
+ */
public boolean login() throws MashupFault {
MessageContext msgCtx = MessageContext.getCurrentMessageContext();
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
