001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.authz;
020    
021    /**
022     * Thrown when a particular client (that is, host address) has not been enabled to access the system
023     * or if the client has been enabled access but is not permitted to perform a particular operation
024     * or access a particular resource.
025     *
026     * @author Les Hazlewood
027     * @since 0.1
028     */
029    public class HostUnauthorizedException extends UnauthorizedException {
030    
031        private String host;
032    
033        /**
034         * Creates a new HostUnauthorizedException.
035         */
036        public HostUnauthorizedException() {
037            super();
038        }
039    
040        /**
041         * Constructs a new HostUnauthorizedException.
042         *
043         * @param message the reason for the exception
044         */
045        public HostUnauthorizedException(String message) {
046            super(message);
047        }
048    
049        /**
050         * Constructs a new HostUnauthorizedException.
051         *
052         * @param cause the underlying Throwable that caused this exception to be thrown.
053         */
054        public HostUnauthorizedException(Throwable cause) {
055            super(cause);
056        }
057    
058        /**
059         * Constructs a new HostUnauthorizedException.
060         *
061         * @param message the reason for the exception
062         * @param cause   the underlying Throwable that caused this exception to be thrown.
063         */
064        public HostUnauthorizedException(String message, Throwable cause) {
065            super(message, cause);
066        }
067    
068        /**
069         * Returns the host associated with this exception.
070         *
071         * @return the host associated with this exception.
072         */
073        public String getHost() {
074            return this.host;
075        }
076    
077        /**
078         * Sets the host associated with this exception.
079         *
080         * @param host the host associated with this exception.
081         */
082        public void setHostAddress(String host) {
083            this.host = host;
084        }
085    }