Class AuthenticationTokenManager

Description
Description | Methods (details)

Token manager

Provides access to the token storage, allowing you to obtain, get and revoke tokens.

Stores tokens as files (serialized AuthenticationToken objects )at the moment, a memcache based approach might come as well as the usage of sessions.

WARNING: Although there is a lifetime specified this module does not cleanup orphaned token files.

Located in /phpsatk-lib/global/org.eenterphace.sat.auth.token/authentication.token.manager.php (line 45) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											AuthenticationToken
										getToken
											(string $tokid)
									

								
				

											string
										obtainToken
											(string $username, string $password)
									

								
				

											void
										revokeToken
											(string $tokid)
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		getToken (line 95)
	
 
	
	

Gets a token base on its ID


Throws exceptions when there is not valid token having this id.

	
    
				
  • access: public
    • 
				
  • static: 
    • 
			

	
	

		AuthenticationToken
		
			getToken
		
					(string $tokid)
			

	
			
    
					
  • 
				string
				$tokid: Token identifier			
    • 
				

		
		
	




	
	

		obtainToken (line 57)
	
 
	
	

Creates a token for a specified user/pass combination


Call this method before accessing resources which require token auth  to get the tokenID which you will have to pass to the resource.

	
    
				
  • return: The Token ID
    • 
				
  • access: public
    • 
				
  • static: 
    • 
			

	
	

		string
		
			obtainToken
		
					(string $username, string $password)
			

	
			
    
					
  • 
				string
				$username: Username to authenticate with			
    • 
					
  • 
				string
				$password: Password to authenticate with			
    • 
				

		
		
	




	
	

		revokeToken (line 126)
	
 
	
	

Revokes/invalidates a token


Physically removes the specified token

	
    
				
  • access: public
    • 
				
  • static: 
    • 
			

	
	

		void
		
			revokeToken
		
					(string $tokid)
			

	
			
    
					
  • 
				string
				$tokid: Token identifier			
    • 
				

		
		
	

						
		

	



	

		Documentation generated on Mon, 21 May 2007 10:34:43 +0200 by phpDocumentor 1.3.0RC5