com.atlassian.jira.rpc.auth
Interface TokenManager

All Known Implementing Classes:
TokenManagerImpl

public interface TokenManager


Method Summary
 java.lang.String login(java.lang.String username, java.lang.String password)
           
 boolean logout(java.lang.String token)
           
 com.atlassian.crowd.embedded.api.User retrieveUser(java.lang.String token)
          Deprecated. As some instances may want to allow anonymous access, individual methods should check for their relevant permission instead. Use retrieveUserNoPermissionCheck(String) instead.
 com.atlassian.crowd.embedded.api.User retrieveUserNoPermissionCheck(java.lang.String token)
           
 

Method Detail

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws RemoteException,
                              RemoteAuthenticationException
Throws:
RemoteException
RemoteAuthenticationException

logout

boolean logout(java.lang.String token)

retrieveUser

com.atlassian.crowd.embedded.api.User retrieveUser(java.lang.String token)
                                                   throws RemoteAuthenticationException,
                                                          RemotePermissionException
Deprecated. As some instances may want to allow anonymous access, individual methods should check for their relevant permission instead. Use retrieveUserNoPermissionCheck(String) instead.

Retrieve the user, checking that the token is valid, and that the user has the 'USE' permission

Parameters:
token -
Returns:
A valid user. Note that this method will never return null
Throws:
RemoteAuthenticationException - If the token is not valid, or if it has timed out
RemotePermissionException - If the user does not have the 'USE' permission.

retrieveUserNoPermissionCheck

com.atlassian.crowd.embedded.api.User retrieveUserNoPermissionCheck(java.lang.String token)
                                                                    throws RemoteAuthenticationException,
                                                                           RemotePermissionException
Throws:
RemoteAuthenticationException
RemotePermissionException


Copyright © 2004-2011 Atlassian. All Rights Reserved.