001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.shiro.env;
018
019import org.apache.activemq.shiro.SecurityFilter;
020import org.apache.shiro.env.Environment;
021
022/**
023 * An abstract {@code BrokerFilter} that makes the Shiro {@link Environment} available to subclasses.
024 *
025 * @since 5.10.0
026 */
027public abstract class EnvironmentFilter extends SecurityFilter {
028
029    private Environment environment;
030
031    public EnvironmentFilter() {
032    }
033
034    public Environment getEnvironment() {
035        if (this.environment == null) {
036            String msg = "Environment has not yet been set.  This should be done before this broker filter is used.";
037            throw new IllegalStateException(msg);
038        }
039        return environment;
040    }
041
042    public void setEnvironment(Environment environment) {
043        this.environment = environment;
044    }
045}