Spring Security Framework

org.springframework.security.adapters
Interface AuthByAdapter

All Superinterfaces:
Authentication, Principal, Serializable
All Known Implementing Classes:
AbstractAdapterAuthenticationToken, PrincipalSpringSecurityUserToken

public interface AuthByAdapter
extends Authentication

Indicates a specialized, immutable, server-side only Authentication class.

Automatically considered valid by the AuthByAdapterProvider, provided the hash code presented by the implementation objects matches that expected by the AuthByAdapterProvider.

Version:
$Id$
Author:
Ben Alex

Method Summary
 int getKeyHash()
          Returns the hash code of the key that was passed to the constructor of the AuthByAdapter implementation.
 
Methods inherited from interface org.springframework.security.Authentication
getAuthorities, getCredentials, getDetails, getPrincipal, isAuthenticated, setAuthenticated
 
Methods inherited from interface java.security.Principal
equals, getName, hashCode, toString
 

Method Detail

getKeyHash

int getKeyHash()
Returns the hash code of the key that was passed to the constructor of the AuthByAdapter implementation. The implementation should convert the value to a hash code at construction time, rather than storing the key itself.

Returns:
the hash code of the key used when the object was created.

Spring Security Framework

Copyright © 2004-2010 SpringSource, Inc. All Rights Reserved.