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.web.jaxrs;
20
21 import javax.ws.rs.core.Application;
22 import javax.ws.rs.core.Feature;
23 import javax.ws.rs.core.FeatureContext;
24 import javax.ws.rs.ext.Provider;
25
26
27 /**
28 * Shiro JAX-RS feature which includes {@link ExceptionMapper}, {@link SubjectPrincipalRequestFilter}, and
29 * {@link ShiroAnnotationFilterFeature}.
30 *
31 * Typically a JAX-RS {@link Application} class will include this Feature class in the
32 * classes returned from {@link Application#getClasses()} method, for example:
33 * <blockquote><pre>
34 * public class SampleApplication extends Application {
35 *
36 * @Override
37 * public Set<Class<?>> getClasses() {
38 * Set<Class<?>> classes = new HashSet<Class<?>>();
39 *
40 * // register Shiro
41 * classes.add(ShiroFeature.class);
42 * ...
43 * return classes;
44 * }
45 * }
46 * </pre></blockquote>
47 * @since 1.4
48 */
49 @Provider // NOTE: Apache CXF requires this annotation on this feature (jersey and resteasy do not)
50 public class ShiroFeature implements Feature {
51
52 @Override
53 public boolean configure(FeatureContext context) {
54
55 context.register(ExceptionMapper.class);
56 context.register(SubjectPrincipalRequestFilter.class);
57 context.register(ShiroAnnotationFilterFeature.class);
58
59 return true;
60 }
61 }