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     * @since 0.1
027     */
028    public class HostUnauthorizedException extends UnauthorizedException {
029    
030        private String host;
031    
032        /**
033         * Creates a new HostUnauthorizedException.
034         */
035        public HostUnauthorizedException() {
036            super();
037        }
038    
039        /**
040         * Constructs a new HostUnauthorizedException.
041         *
042         * @param message the reason for the exception
043         */
044        public HostUnauthorizedException(String message) {
045            super(message);
046        }
047    
048        /**
049         * Constructs a new HostUnauthorizedException.
050         *
051         * @param cause the underlying Throwable that caused this exception to be thrown.
052         */
053        public HostUnauthorizedException(Throwable cause) {
054            super(cause);
055        }
056    
057        /**
058         * Constructs a new HostUnauthorizedException.
059         *
060         * @param message the reason for the exception
061         * @param cause   the underlying Throwable that caused this exception to be thrown.
062         */
063        public HostUnauthorizedException(String message, Throwable cause) {
064            super(message, cause);
065        }
066    
067        /**
068         * Returns the host associated with this exception.
069         *
070         * @return the host associated with this exception.
071         */
072        public String getHost() {
073            return this.host;
074        }
075    
076        /**
077         * Sets the host associated with this exception.
078         *
079         * @param host the host associated with this exception.
080         */
081        public void setHostAddress(String host) {
082            this.host = host;
083        }
084    }