Interface HostAuthenticationToken

All Superinterfaces:
AuthenticationToken, Serializable
All Known Implementing Classes:
BearerToken, UsernamePasswordToken
public interface HostAuthenticationToken extends AuthenticationToken
A HostAuthenticationToken retains the host information from where an authentication attempt originates.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHost()
    Returns the host name of the client from where the authentication attempt originates or if the Shiro environment cannot or chooses not to resolve the hostname to improve performance, this method returns the String representation of the client's IP address.

    Methods inherited from interface org.apache.shiro.authc.AuthenticationToken

    getCredentials, getPrincipal

  • Method Details

    • getHost

      String getHost()
      Returns the host name of the client from where the authentication attempt originates or if the Shiro environment cannot or chooses not to resolve the hostname to improve performance, this method returns the String representation of the client's IP address.

      When used in web environments, this value is usually the same as the ServletRequest.getRemoteHost() value.

      Returns:
      the fully qualified name of the client from where the authentication attempt originates or the String representation of the client's IP address is hostname resolution is not available or disabled.