| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
An SSO provider lets the IM server take advantage of a single-sign-on service. It is invoked by the server to validate session ids passed in password fields.
| Method Summary | |
|  void | close()release resources used by the provider | 
|  void | open()initializes the authentication provider | 
|  boolean | refresh(java.lang.String uid)refresh the session associated with this user id so that it does not time out. | 
|  boolean | verify(java.lang.String uid,
       java.lang.String token,
       java.util.Map attributes,
       java.util.Set attributeNames)Validates that a session identifier is valid and belongs to the correct user, and if so fills an map of attributes with their values. | 
| Method Detail | 
public boolean verify(java.lang.String uid,
                      java.lang.String token,
                      java.util.Map attributes,
                      java.util.Set attributeNames)
uid - usernametoken - string provided as user password.  It may not
 be an actual user password, but a string based session id. 
 When it is the case, this method extracts the session id
 and verifies that the pair user id + session id is a valid oneattributes - returned map containing attribute/value bindings
 for the user if authentication succeeded.attributeNames - set of user attributes to retrieve from the user 
 database.  Note that the provider may retrieve more attributes.
public boolean refresh(java.lang.String uid)
uid - id of session owner
public void open()
          throws java.lang.Exception
java.lang.Exception - the authentication provider failed to
 initialized.  It will not be used from this point on.public void close()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||