1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
|
commit f2dfa7ff39c9870e7b9856ceca8690c5398080fa
Author: Brian Demers <bdemers@apache.org>
Date: Thu Jul 14 09:51:45 2016 -0400
SHIRO-493 - Adding new methods and deprecating old to ShiroWebModule to support Guice 4
--- a/support/guice/src/main/java/org/apache/shiro/guice/ShiroModule.java
+++ b/support/guice/src/main/java/org/apache/shiro/guice/ShiroModule.java
@@ -18,20 +18,33 @@
*/
package org.apache.shiro.guice;
+import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Collections;
+import java.util.List;
import java.util.Set;
import java.util.WeakHashMap;
import javax.annotation.PreDestroy;
+import com.google.inject.Provider;
+import com.google.inject.matcher.Matchers;
+import com.google.inject.name.Names;
+import com.google.inject.spi.InjectionListener;
+import com.google.inject.spi.TypeEncounter;
+import com.google.inject.spi.TypeListener;
import org.apache.shiro.config.ConfigurationException;
import org.apache.shiro.env.Environment;
+import org.apache.shiro.event.EventBus;
+import org.apache.shiro.event.EventBusAware;
+import org.apache.shiro.event.Subscribe;
+import org.apache.shiro.event.support.DefaultEventBus;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.realm.Realm;
import org.apache.shiro.session.mgt.DefaultSessionManager;
import org.apache.shiro.session.mgt.SessionManager;
+import org.apache.shiro.util.ClassUtils;
import org.apache.shiro.util.Destroyable;
import com.google.inject.Key;
@@ -57,6 +70,9 @@
bindSessionManager(bind(SessionManager.class));
bindEnvironment(bind(Environment.class));
bindListener(BeanTypeListener.MATCHER, new BeanTypeListener());
+ bindEventBus(bind(EventBus.class));
+ bindListener(Matchers.any(), new SubscribedEventTypeListener());
+ bindListener(Matchers.any(), new EventBusAwareTypeListener());
final DestroyableInjectionListener.DestroyableRegistry registry = new DestroyableInjectionListener.DestroyableRegistry() {
public void add(Destroyable destroyable) {
ShiroModule.this.add(destroyable);
@@ -70,6 +86,7 @@
bindListener(LifecycleTypeListener.MATCHER, new LifecycleTypeListener(registry));
expose(SecurityManager.class);
+ expose(EventBus.class);
configureShiro();
bind(realmCollectionKey())
@@ -153,6 +170,15 @@
}
/**
+ * Binds the EventBus. Override this method in order to provide your own {@link EventBus} binding.
+ * @param bind
+ * @since 1.4
+ */
+ protected void bindEventBus(AnnotatedBindingBuilder<EventBus> bind) {
+ bind.to(DefaultEventBus.class).asEagerSingleton();
+ }
+
+ /**
* Destroys all beans created within this module that implement {@link org.apache.shiro.util.Destroyable}. Should be called when this
* module will no longer be used.
*
@@ -167,4 +193,39 @@
public void add(Destroyable destroyable) {
this.destroyables.add(destroyable);
}
+
+ private class SubscribedEventTypeListener implements TypeListener {
+ @Override
+ public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
+
+ final Provider<EventBus> eventBusProvider = typeEncounter.getProvider(EventBus.class);
+
+ List<Method> methods = ClassUtils.getAnnotatedMethods(typeLiteral.getRawType(), Subscribe.class);
+ if (methods != null && !methods.isEmpty()) {
+ typeEncounter.register( new InjectionListener<I>() {
+ @Override
+ public void afterInjection(Object o) {
+ eventBusProvider.get().register(o);
+ }
+ });
+ }
+ }
+ }
+
+ private class EventBusAwareTypeListener implements TypeListener {
+ @Override
+ public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
+
+ final Provider<EventBus> eventBusProvider = typeEncounter.getProvider(EventBus.class);
+
+ if (EventBusAware.class.isAssignableFrom(typeLiteral.getRawType())) {
+ typeEncounter.register( new InjectionListener<I>() {
+ @Override
+ public void afterInjection(Object o) {
+ ((EventBusAware)o).setEventBus(eventBusProvider.get());
+ }
+ });
+ }
+ }
+ }
}
--- a/support/guice/src/main/java/org/apache/shiro/guice/web/ShiroWebModule.java
+++ b/support/guice/src/main/java/org/apache/shiro/guice/web/ShiroWebModule.java
@@ -18,10 +18,7 @@
*/
package org.apache.shiro.guice.web;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.LinkedHashMap;
-import java.util.Map;
+import java.util.*;
import javax.servlet.Filter;
import javax.servlet.ServletContext;
@@ -31,6 +28,7 @@
import org.apache.shiro.guice.ShiroModule;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.mgt.SessionManager;
+import org.apache.shiro.util.StringUtils;
import org.apache.shiro.web.env.WebEnvironment;
import org.apache.shiro.web.filter.PathMatchingFilter;
import org.apache.shiro.web.filter.authc.AnonymousFilter;
@@ -94,7 +92,7 @@
* We use a LinkedHashMap here to ensure that iterator order is the same as add order. This is important, as the
* FilterChainResolver uses iterator order when searching for a matching chain.
*/
- private final Map<String, Key<? extends Filter>[]> filterChains = new LinkedHashMap<String, Key<? extends Filter>[]>();
+ private final Map<String, FilterConfig<? extends Filter>[]> filterChains = new LinkedHashMap<String, FilterConfig<? extends Filter>[]>();
private final ServletContext servletContext;
public ShiroWebModule(ServletContext servletContext) {
@@ -134,37 +132,65 @@
this.configureShiroWeb();
- setupFilterChainConfigs();
-
- bind(FilterChainResolver.class).toProvider(new FilterChainResolverProvider(filterChains));
+ bind(FilterChainResolver.class).toProvider(new FilterChainResolverProvider(setupFilterChainConfigs()));
}
- private void setupFilterChainConfigs() {
- Map<Key<? extends PathMatchingFilter>, Map<String, String>> configs = new HashMap<Key<? extends PathMatchingFilter>, Map<String, String>>();
+ private Map<String, Key<? extends Filter>[]> setupFilterChainConfigs() {
+
+ // loop through and build a map of Filter Key -> Map<Path, Config>
+ Map<Key<? extends Filter>, Map<String, String>> filterToPathToConfig = new HashMap<Key<? extends Filter>, Map<String, String>>();
+
+ // At the same time build a map to return with Path -> Key[]
+ Map<String, Key<? extends Filter>[]> resultConfigMap = new HashMap<String, Key<? extends Filter>[]>();
+
+ for (Map.Entry<String, FilterConfig<? extends Filter>[]> filterChain : filterChains.entrySet()) {
+
+ String path = filterChain.getKey();
+
+ // collect the keys used for this path
+ List<Key<? extends Filter>> keysForPath = new ArrayList<Key<? extends Filter>>();
- for (Map.Entry<String, Key<? extends Filter>[]> filterChain : filterChains.entrySet()) {
for (int i = 0; i < filterChain.getValue().length; i++) {
- Key<? extends Filter> key = filterChain.getValue()[i];
- if (key instanceof FilterConfigKey) {
- FilterConfigKey<? extends PathMatchingFilter> configKey = (FilterConfigKey<? extends PathMatchingFilter>) key;
- key = configKey.getKey();
- filterChain.getValue()[i] = key;
- if (!PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {
- throw new ConfigurationException("Config information requires a PathMatchingFilter - can't apply to " + key.getTypeLiteral().getRawType());
- }
- if (configs.get(castToPathMatching(key)) == null) configs.put(castToPathMatching(key), new HashMap<String, String>());
- configs.get(castToPathMatching(key)).put(filterChain.getKey(), configKey.getConfigValue());
- } else if (PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {
- if (configs.get(castToPathMatching(key)) == null) configs.put(castToPathMatching(key), new HashMap<String, String>());
- configs.get(castToPathMatching(key)).put(filterChain.getKey(), "");
+ FilterConfig<? extends Filter> filterConfig = filterChain.getValue()[i];
+
+ Key<? extends Filter> key = filterConfig.getKey();
+ String config = filterConfig.getConfigValue();
+
+ // initialize key in filterToPathToConfig, if it doesn't exist
+ if (filterToPathToConfig.get(key) == null) {
+ filterToPathToConfig.put((key), new HashMap<String, String>());
+ }
+ // now set the value
+ filterToPathToConfig.get(key).put(path, config);
+
+ // Config error if someone configured a non PathMatchingFilter with a config value
+ if (StringUtils.hasText(config) && !PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {
+ throw new ConfigurationException("Config information requires a PathMatchingFilter - can't apply to " + key.getTypeLiteral().getRawType());
}
+
+ // store the key in keysForPath
+ keysForPath.add(key);
}
+
+ // map the current path to all of its Keys
+ resultConfigMap.put(path, keysForPath.toArray(new Key[keysForPath.size()]));
}
- for (Key<? extends PathMatchingFilter> filterKey : configs.keySet()) {
- bindPathMatchingFilter(filterKey, configs.get(filterKey));
+
+ // now we find only the PathMatchingFilter and configure bindings
+ // non PathMatchingFilter, can be loaded with the default provider via the class name
+ for (Key<? extends Filter> key : filterToPathToConfig.keySet()) {
+ if (PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {
+ bindPathMatchingFilter(castToPathMatching(key), filterToPathToConfig.get(key));
+ }
+ else {
+ bind(key);
+ }
}
+
+ return resultConfigMap;
}
+
private <T extends PathMatchingFilter> void bindPathMatchingFilter(Key<T> filterKey, Map<String, String> configs) {
bind(filterKey).toProvider(new PathMatchingFilterProvider<T>(filterKey, configs)).asEagerSingleton();
}
@@ -218,6 +244,126 @@
bind.to(WebGuiceEnvironment.class).asEagerSingleton();
}
+ protected final void addFilterChain(String pattern, Key<? extends Filter> key) {
+ // check for legacy API
+ if (key instanceof FilterConfigKey) {
+ addLegacyFilterChain(pattern, (FilterConfigKey) key);
+ }
+ else {
+ addFilterChain(pattern, new FilterConfig<Filter>((Key<Filter>) key, ""));
+ }
+ }
+
+ /**
+ * Maps 'n' number of <code>filterConfig</code>s to a specific path pattern.<BR/>
+ * For example, a path of '/my_private_resource/**' to 'filterConfig(AUTHC)' would require
+ * any resource under the path '/my_private_resource' would be processed through the {@link FormAuthenticationFilter}.
+ *
+ * @param pattern URL patter to be mapped to a FilterConfig, e.g. '/my_private-path/**'
+ * @param filterConfigs FilterConfiguration representing the Filter and config to be used when processing resources on <code>pattern</code>.
+ * @since 1.4
+ */
+ protected final void addFilterChain(String pattern, FilterConfig<? extends Filter>... filterConfigs) {
+ filterChains.put(pattern, filterConfigs);
+ }
+
+ /**
+ * Builds a FilterConfig from a Filer and configuration String
+ * @param baseKey The Key of the Filter class to be used.
+ * @param <T> A Servlet Filter class.
+ * @return A FilterConfig used to map a String path to this configuration.
+ * @since 1.4
+ */
+ protected static <T extends Filter> FilterConfig<T> filterConfig(Key<T> baseKey, String configValue) {
+ return new FilterConfig<T>(baseKey, configValue);
+ }
+
+ /**
+ * Builds a FilterConfig from a Filer and configuration String
+ * @param baseKey The Key of the Filter class to be used.
+ * @param <T> A Servlet Filter class.
+ * @return A FilterConfig used to map a String path to this configuration.
+ * @since 1.4
+ */
+ protected static <T extends Filter> FilterConfig<T> filterConfig(Key<T> baseKey) {
+ return filterConfig(baseKey, "");
+ }
+
+ /**
+ * Builds a FilterConfig from a Filer and configuration String
+ * @param typeLiteral The TyleLiteral of the filter key to be used.
+ * @param configValue the configuration used.
+ * @param <T> A Servlet Filter class.
+ * @return A FilterConfig used to map a String path to this configuration.
+ * @since 1.4
+ */
+ @SuppressWarnings({"UnusedDeclaration"})
+ protected static <T extends Filter> FilterConfig<T> filterConfig(TypeLiteral<T> typeLiteral, String configValue) {
+ return filterConfig(Key.get(typeLiteral), configValue);
+ }
+
+ /**
+ * Builds a FilterConfig from a Filer and configuration String
+ * @param type The filter to be used.
+ * @param configValue the configuration used.
+ * @param <T> A Servlet Filter class.
+ * @return A FilterConfig used to map a String path to this configuration.
+ * @since 1.4
+ */
+ @SuppressWarnings({"UnusedDeclaration"})
+ protected static <T extends Filter> FilterConfig<T> filterConfig(Class<T> type, String configValue) {
+ return filterConfig(Key.get(type), configValue);
+ }
+
+
+ /**
+ * Filter configuration which pairs a Filter class with its configuration used on a path.
+ * @param <T> The Servlet Filter class.
+ * @since 1.4
+ */
+ public static class FilterConfig<T extends Filter> {
+ private Key<T> key;
+ private String configValue;
+
+ private FilterConfig(Key<T> key, String configValue) {
+ super();
+ this.key = key;
+ this.configValue = configValue;
+ }
+
+ public Key<T> getKey() {
+ return key;
+ }
+
+ public String getConfigValue() {
+ return configValue;
+ }
+ }
+
+
+
+
+
+
+
+ // legacy methods
+
+
+ static boolean isGuiceVersion3() {
+ try {
+ Class.forName("com.google.inject.multibindings.MapKey");
+ return false;
+ } catch (ClassNotFoundException e) {
+ return true;
+ }
+ }
+
+ private void addLegacyFilterChain(String pattern, FilterConfigKey filterConfigKey) {
+
+ FilterConfig<Filter> filterConfig = new FilterConfig<Filter>(filterConfigKey.getKey(), filterConfigKey.getConfigValue());
+ addFilterChain(pattern, filterConfig);
+ }
+
/**
* Adds a filter chain to the shiro configuration.
* <p/>
@@ -228,24 +374,52 @@
* @param keys
*/
@SuppressWarnings({"UnusedDeclaration"})
+ @Deprecated
protected final void addFilterChain(String pattern, Key<? extends Filter>... keys) {
- filterChains.put(pattern, keys);
+
+ // We need to extract the keys and FilterConfigKey and convert to the new format.
+
+ FilterConfig[] filterConfigs = new FilterConfig[keys.length];
+ for (int ii = 0; ii < keys.length; ii++) {
+ Key<? extends Filter> key = keys[ii];
+ // If this is a path matching filter, we need to remember the config
+ if (key instanceof FilterConfigKey) {
+ // legacy config
+ FilterConfigKey legacyKey = (FilterConfigKey) key;
+ filterConfigs[ii] = new FilterConfig(legacyKey.getKey(), legacyKey.getConfigValue());
+ }
+ else {
+ // Some other type of Filter key, no config
+ filterConfigs[ii] = new FilterConfig(key, "");
+ }
+ }
+
+ filterChains.put(pattern, filterConfigs);
}
+ @Deprecated
protected static <T extends PathMatchingFilter> Key<T> config(Key<T> baseKey, String configValue) {
+
+ if( !isGuiceVersion3()) {
+ throw new ConfigurationException("Method ShiroWebModule.config(Key<? extends PathMatchingFilter>, String configValue), is not supported when using Guice 4+");
+ }
+
return new FilterConfigKey<T>(baseKey, configValue);
}
@SuppressWarnings({"UnusedDeclaration"})
+ @Deprecated
protected static <T extends PathMatchingFilter> Key<T> config(TypeLiteral<T> typeLiteral, String configValue) {
return config(Key.get(typeLiteral), configValue);
}
@SuppressWarnings({"UnusedDeclaration"})
+ @Deprecated
protected static <T extends PathMatchingFilter> Key<T> config(Class<T> type, String configValue) {
return config(Key.get(type), configValue);
}
+ @Deprecated
private static class FilterConfigKey<T extends PathMatchingFilter> extends Key<T> {
private Key<T> key;
private String configValue;
@@ -264,4 +438,5 @@
return configValue;
}
}
+
}
--- a/support/guice/src/main/java/org/apache/shiro/guice/web/SimpleFilterChain.java
+++ b/support/guice/src/main/java/org/apache/shiro/guice/web/SimpleFilterChain.java
@@ -44,4 +44,13 @@
originalChain.doFilter(request, response);
}
}
+
+ /**
+ * Exposed for testing, not part of public API.
+ * @return an Iterater of filters.
+ */
+ Iterator<? extends Filter> getFilters() {
+ return chain;
+ }
+
}
--- a/support/guice/src/test/java/org/apache/shiro/guice/ShiroModuleTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/ShiroModuleTest.java
@@ -28,6 +28,10 @@
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.env.Environment;
+import org.apache.shiro.event.EventBus;
+import org.apache.shiro.event.EventBusAware;
+import org.apache.shiro.event.Subscribe;
+import org.apache.shiro.event.support.DefaultEventBus;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.realm.Realm;
@@ -37,11 +41,13 @@
import org.apache.shiro.util.Destroyable;
import org.junit.Test;
+import java.lang.reflect.Field;
import java.util.Collection;
+import java.util.Map;
import static org.easymock.EasyMock.*;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.*;
+import static org.hamcrest.CoreMatchers.*;
public class ShiroModuleTest {
@@ -204,6 +210,82 @@
verify(myDestroyable);
}
+ /**
+ * @since 1.4
+ * @throws Exception
+ */
+ @Test
+ public void testEventListener() throws Exception {
+
+ final MockRealm mockRealm = createMock(MockRealm.class);
+ final EventBus eventBus = createMock(EventBus.class);
+
+ // expect both objects to be registered
+ eventBus.register(anyObject(MockEventListener1.class));
+ eventBus.register(anyObject(MockEventListener2.class));
+ replay(eventBus);
+
+ final ShiroModule shiroModule = new ShiroModule() {
+ @Override
+ protected void configureShiro() {
+ bindRealm().to(MockRealm.class);
+
+ // bind our event listeners
+ binder().bind(MockEventListener1.class).asEagerSingleton();
+ binder().bind(MockEventListener2.class).asEagerSingleton();
+ }
+
+ @Override
+ protected void bindEventBus(AnnotatedBindingBuilder<EventBus> bind) {
+ bind.toInstance(eventBus);
+ }
+
+ @Provides
+ public MockRealm createRealm() {
+ return mockRealm;
+ }
+
+ };
+ Guice.createInjector(shiroModule);
+
+ verify(eventBus);
+
+ }
+
+ /**
+ * @since 1.4
+ * @throws Exception
+ */
+ @Test
+ public void testEventBusAware() throws Exception {
+
+ final MockRealm mockRealm = createMock(MockRealm.class);
+
+ final ShiroModule shiroModule = new ShiroModule() {
+ @Override
+ protected void configureShiro() {
+ bindRealm().to(MockRealm.class);
+
+ binder().bind(MockEventBusAware.class).asEagerSingleton();
+ expose(MockEventBusAware.class);
+ }
+
+ @Provides
+ public MockRealm createRealm() {
+ return mockRealm;
+ }
+
+ };
+ Injector injector = Guice.createInjector(shiroModule);
+ EventBus eventBus = injector.getInstance(EventBus.class);
+ SecurityManager securityManager = injector.getInstance(SecurityManager.class);
+
+ MockEventBusAware eventBusAware = injector.getInstance(MockEventBusAware.class);
+
+ assertSame(eventBus, eventBusAware.eventBus);
+ assertSame(eventBus, ((DefaultSecurityManager)securityManager).getEventBus());
+ }
+
public static interface MockRealm extends Realm {
}
@@ -227,4 +309,27 @@
public static interface MyDestroyable extends Destroyable {
}
+
+ public static class MockEventListener1 {
+ @Subscribe
+ public void listenToAllAndDoNothing(Object o) {}
+ }
+
+ public static class MockEventListener2 {
+ @Subscribe
+ public void listenToAllAndDoNothing(Object o) {}
+ }
+
+ public static class MockEventBusAware implements EventBusAware {
+ private EventBus eventBus;
+
+ public EventBus getEventBus() {
+ return eventBus;
+ }
+
+ @Override
+ public void setEventBus(EventBus eventBus) {
+ this.eventBus = eventBus;
+ }
+ }
}
--- a/support/guice/src/test/java/org/apache/shiro/guice/web/FilterConfigTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/web/FilterConfigTest.java
@@ -45,7 +45,8 @@
bindRealm().to(ShiroModuleTest.MockRealm.class);
addFilterChain("/index.html", AUTHC_BASIC);
- addFilterChain("/index2.html", config(PERMS, "permission"));
+// addFilterChain("/index2.html", config(PERMS, "permission"));
+ addFilterChain("/index2.html", filterConfig(PERMS, "permission"));
}
@Provides
--- a/support/guice/src/test/java/org/apache/shiro/guice/web/ShiroWebModuleTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/web/ShiroWebModuleTest.java
@@ -21,6 +21,7 @@
import com.google.inject.Guice;
import com.google.inject.Inject;
import com.google.inject.Injector;
+import com.google.inject.Key;
import com.google.inject.Provides;
import com.google.inject.binder.AnnotatedBindingBuilder;
import org.apache.shiro.guice.ShiroModuleTest;
@@ -28,21 +29,38 @@
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.realm.Realm;
import org.apache.shiro.session.mgt.SessionManager;
+import org.apache.shiro.web.env.EnvironmentLoader;
import org.apache.shiro.web.env.WebEnvironment;
+import org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter;
+import org.apache.shiro.web.filter.authc.FormAuthenticationFilter;
+import org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter;
+import org.apache.shiro.web.filter.authz.RolesAuthorizationFilter;
import org.apache.shiro.web.filter.mgt.FilterChainResolver;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.apache.shiro.web.mgt.WebSecurityManager;
import org.apache.shiro.web.session.mgt.DefaultWebSessionManager;
import org.apache.shiro.web.session.mgt.ServletContainerSessionManager;
+import org.easymock.EasyMock;
+import org.junit.Assume;
import org.junit.Test;
import javax.inject.Named;
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import java.io.IOException;
import java.util.Collection;
+import java.util.Iterator;
+
+import static org.easymock.EasyMock.*;
+import static org.junit.Assert.*;
+import static org.hamcrest.CoreMatchers.*;
-import static org.easymock.EasyMock.createMock;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
public class ShiroWebModuleTest {
@@ -146,6 +164,92 @@
assertTrue( environment == webEnvironment );
}
+ /**
+ * @since 1.4
+ */
+ @Test
+ public void testAddFilterChainGuice3and4() {
+
+ final ShiroModuleTest.MockRealm mockRealm = createMock(ShiroModuleTest.MockRealm.class);
+ ServletContext servletContext = createMock(ServletContext.class);
+ HttpServletRequest request = createMock(HttpServletRequest.class);
+
+ servletContext.setAttribute(eq(EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY), EasyMock.anyObject());
+ expect(request.getAttribute("javax.servlet.include.context_path")).andReturn("").anyTimes();
+ expect(request.getCharacterEncoding()).andReturn("UTF-8").anyTimes();
+ expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_authc");
+ expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_custom_filter");
+ expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_authc_basic");
+ expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_perms");
+ expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/multiple_configs");
+ replay(servletContext, request);
+
+ Injector injector = Guice.createInjector(new ShiroWebModule(servletContext) {
+ @Override
+ protected void configureShiroWeb() {
+ bindRealm().to(ShiroModuleTest.MockRealm.class);
+ expose(FilterChainResolver.class);
+ this.addFilterChain("/test_authc/**", filterConfig(AUTHC));
+ this.addFilterChain("/test_custom_filter/**", Key.get(CustomFilter.class));
+ this.addFilterChain("/test_authc_basic/**", AUTHC_BASIC);
+ this.addFilterChain("/test_perms/**", filterConfig(PERMS, "remote:invoke:lan,wan"));
+ this.addFilterChain("/multiple_configs/**", filterConfig(AUTHC), filterConfig(ROLES, "b2bClient"), filterConfig(PERMS, "remote:invoke:lan,wan"));
+ }
+
+ @Provides
+ public ShiroModuleTest.MockRealm createRealm() {
+ return mockRealm;
+ }
+ });
+
+ FilterChainResolver resolver = injector.getInstance(FilterChainResolver.class);
+ assertThat(resolver, instanceOf(SimpleFilterChainResolver.class));
+ SimpleFilterChainResolver simpleFilterChainResolver = (SimpleFilterChainResolver) resolver;
+
+ // test the /test_authc resource
+ FilterChain filterChain = simpleFilterChainResolver.getChain(request, null, null);
+ assertThat(filterChain, instanceOf(SimpleFilterChain.class));
+ Filter nextFilter = getNextFilter((SimpleFilterChain) filterChain);
+ assertThat(nextFilter, instanceOf(FormAuthenticationFilter.class));
+
+ // test the /test_custom_filter resource
+ filterChain = simpleFilterChainResolver.getChain(request, null, null);
+ assertThat(filterChain, instanceOf(SimpleFilterChain.class));
+ nextFilter = getNextFilter((SimpleFilterChain) filterChain);
+ assertThat(nextFilter, instanceOf(CustomFilter.class));
+
+ // test the /test_authc_basic resource
+ filterChain = simpleFilterChainResolver.getChain(request, null, null);
+ assertThat(filterChain, instanceOf(SimpleFilterChain.class));
+ nextFilter = getNextFilter((SimpleFilterChain) filterChain);
+ assertThat(nextFilter, instanceOf(BasicHttpAuthenticationFilter.class));
+
+ // test the /test_perms resource
+ filterChain = simpleFilterChainResolver.getChain(request, null, null);
+ assertThat(filterChain, instanceOf(SimpleFilterChain.class));
+ nextFilter = getNextFilter((SimpleFilterChain) filterChain);
+ assertThat(nextFilter, instanceOf(PermissionsAuthorizationFilter.class));
+
+ // test the /multiple_configs resource
+ filterChain = simpleFilterChainResolver.getChain(request, null, null);
+ assertThat(filterChain, instanceOf(SimpleFilterChain.class));
+ assertThat(getNextFilter((SimpleFilterChain) filterChain), instanceOf(FormAuthenticationFilter.class));
+ assertThat(getNextFilter((SimpleFilterChain) filterChain), instanceOf(RolesAuthorizationFilter.class));
+ assertThat(getNextFilter((SimpleFilterChain) filterChain), instanceOf(PermissionsAuthorizationFilter.class));
+
+ verify(servletContext, request);
+ }
+
+ private Filter getNextFilter(SimpleFilterChain filterChain) {
+
+ Iterator<? extends Filter> filters = filterChain.getFilters();
+ if (filters.hasNext()) {
+ return filters.next();
+ }
+
+ return null;
+ }
+
public static class MyDefaultWebSecurityManager extends DefaultWebSecurityManager {
@Inject
public MyDefaultWebSecurityManager(Collection<Realm> realms) {
@@ -162,4 +266,16 @@
super(filterChainResolver, servletContext, securityManager);
}
}
+
+ public static class CustomFilter implements Filter {
+
+ @Override
+ public void init(FilterConfig filterConfig) throws ServletException {}
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {}
+
+ @Override
+ public void destroy() {}
+ }
}
|