1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.shiro.event; 20 21 /** 22 * Interface implemented by components that utilize an EventBus for publishing and/or subscribing to/from events 23 * and wish that EventBus to be supplied if one is available. 24 * <p/> 25 * <b>NOTE:</b> If an {@code EventBusAware} implementation wishes to subscribe to events (i.e. it has 26 * {@code @Subscriber}-annotated methods itself, it must register itself with the event bus, i.e.: 27 * <pre> 28 * eventBus.register(this); 29 * </pre> 30 * Shiro's default configuration mechanisms will <em>NOT</em> auto-register {@code @Subscriber}-annotated components 31 * that are also {@code EventBusAware}: it is assumed that the {@code EventBusAware} implementation, having access to 32 * an EventBus directly, knows best when to register/unregister itself. 33 * 34 * @since 1.3 35 */ 36 public interface EventBusAware { 37 38 /** 39 * Sets the available {@code EventBus} that may be used for publishing and subscribing to/from events. 40 * 41 * @param bus the available {@code EventBus}. 42 */ 43 void setEventBus(EventBus bus); 44 }