1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.shiro.authc; 20 21 /** 22 * A {@code HostAuthenticationToken} retains the host information from where 23 * an authentication attempt originates. 24 * 25 * @since 1.0 26 */ 27 public interface HostAuthenticationToken extends AuthenticationToken { 28 29 /** 30 * Returns the host name of the client from where the 31 * authentication attempt originates or if the Shiro environment cannot or 32 * chooses not to resolve the hostname to improve performance, this method 33 * returns the String representation of the client's IP address. 34 * <p/> 35 * When used in web environments, this value is usually the same as the 36 * {@code ServletRequest.getRemoteHost()} value. 37 * 38 * @return the fully qualified name of the client from where the 39 * authentication attempt originates or the String representation 40 * of the client's IP address is hostname resolution is not 41 * available or disabled. 42 */ 43 String getHost(); 44 }