org.apache.shiro.web.jaxrs.ShiroFeature Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.web.jaxrs;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.Provider;
/**
* Shiro JAX-RS feature which includes {@link ExceptionMapper}, {@link SubjectPrincipalRequestFilter}, and
* {@link ShiroAnnotationFilterFeature}.
*
* Typically a JAX-RS {@link Application} class will include this Feature class in the
* classes returned from {@link Application#getClasses()} method, for example:
*
* public class SampleApplication extends Application {
*
* @Override
* public Set> getClasses() {
* Set> classes = new HashSet>();
*
* // register Shiro
* classes.add(ShiroFeature.class);
* ...
* return classes;
* }
* }
*
* @since 1.4
*/
@Provider // NOTE: Apache CXF requires this annotation on this feature (jersey and resteasy do not)
public class ShiroFeature implements Feature {
@Override
public boolean configure(FeatureContext context) {
context.register(ExceptionMapper.class);
context.register(SubjectPrincipalRequestFilter.class);
context.register(ShiroAnnotationFilterFeature.class);
return true;
}
}