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.event;
020
021/**
022 * Interface implemented by components that utilize an EventBus for publishing and/or subscribing to/from events
023 * and wish that EventBus to be supplied if one is available.
024 * <p/>
025 * <b>NOTE:</b> If an {@code EventBusAware} implementation wishes to subscribe to events (i.e. it has
026 * {@code @Subscriber}-annotated methods itself, it must register itself with the event bus, i.e.:
027 * <pre>
028 * eventBus.register(this);
029 * </pre>
030 * Shiro's default configuration mechanisms will <em>NOT</em> auto-register {@code @Subscriber}-annotated components
031 * that are also {@code EventBusAware}: it is assumed that the {@code EventBusAware} implementation, having access to
032 * an EventBus directly, knows best when to register/unregister itself.
033 *
034 * @since 1.3
035 */
036public interface EventBusAware {
037
038    /**
039     * Sets the available {@code EventBus} that may be used for publishing and subscribing to/from events.
040     *
041     * @param bus the available {@code EventBus}.
042     */
043    void setEventBus(EventBus bus);
044}