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 */
019package org.apache.shiro.web.filter.authz;
020
021import java.util.Collection;
022
023/**
024 * Represents a source of information for IP restrictions (see IpFilter)
025 *
026 * @since 2.0
027 */
028public interface IpSource {
029
030    /**
031     * Returns a set of strings representing IP address representing
032     * IPv4 or IPv6 ranges / CIDRs. e.g. 192.168.0.0/16 from which
033     * access should be allowed (if and only if the IP is not included
034     * in the list of denied IPs)
035     */
036    Collection<String> getAuthorizedIps();
037
038    /**
039     * Returns a set of strings representing IP address representing
040     * IPv4 or IPv6 ranges / CIDRs. e.g. 192.168.0.0/16 from which
041     * access should be denied.
042     */
043    Collection<String> getDeniedIps();
044
045}