Browse Source
Create ErrorPageRegistry and ErrorPageRegistrar interfaces that allow error page registration to be a first class concern. Prior to this commit ErrorPageFilter needed to implement ConfigurableEmbeddedServletContainer in order to receive ErrorPage registrations. Closes gh-5789pull/5816/merge
Phillip Webb
10 years ago
11 changed files with 187 additions and 47 deletions
@ -0,0 +1,33 @@
@@ -0,0 +1,33 @@
|
||||
/* |
||||
* Copyright 2012-2016 the original author or authors. |
||||
* |
||||
* Licensed 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.springframework.boot.web.servlet; |
||||
|
||||
/** |
||||
* Interface to be implemented by types that register {@link ErrorPage ErrorPages}. |
||||
* |
||||
* @author Phillip Webb |
||||
* @since 1.4.0 |
||||
*/ |
||||
public interface ErrorPageRegistrar { |
||||
|
||||
/** |
||||
* Register pages as required with the given registry. |
||||
* @param registry the error page registry |
||||
*/ |
||||
void registerErrorPages(ErrorPageRegistry registry); |
||||
|
||||
} |
||||
@ -0,0 +1,82 @@
@@ -0,0 +1,82 @@
|
||||
/* |
||||
* Copyright 2012-2016 the original author or authors. |
||||
* |
||||
* Licensed 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.springframework.boot.web.servlet; |
||||
|
||||
import java.util.ArrayList; |
||||
import java.util.Collection; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
|
||||
import org.springframework.beans.BeansException; |
||||
import org.springframework.beans.factory.config.BeanPostProcessor; |
||||
import org.springframework.context.ApplicationContext; |
||||
import org.springframework.context.ApplicationContextAware; |
||||
import org.springframework.core.annotation.AnnotationAwareOrderComparator; |
||||
|
||||
/** |
||||
* {@link BeanPostProcessor} that apply all {@link ErrorPageRegistrar}s from the bean |
||||
* factory to {@link ErrorPageRegistry} beans. |
||||
* |
||||
* @author Phillip Webb |
||||
* @since 1.4.0 |
||||
*/ |
||||
public class ErrorPageRegistrarBeanPostProcessor |
||||
implements BeanPostProcessor, ApplicationContextAware { |
||||
|
||||
private ApplicationContext applicationContext; |
||||
|
||||
private List<ErrorPageRegistrar> registrars; |
||||
|
||||
@Override |
||||
public void setApplicationContext(ApplicationContext applicationContext) |
||||
throws BeansException { |
||||
this.applicationContext = applicationContext; |
||||
} |
||||
|
||||
@Override |
||||
public Object postProcessBeforeInitialization(Object bean, String beanName) |
||||
throws BeansException { |
||||
if (bean instanceof ErrorPageRegistry) { |
||||
postProcessBeforeInitialization((ErrorPageRegistry) bean); |
||||
} |
||||
return bean; |
||||
} |
||||
|
||||
@Override |
||||
public Object postProcessAfterInitialization(Object bean, String beanName) |
||||
throws BeansException { |
||||
return bean; |
||||
} |
||||
|
||||
private void postProcessBeforeInitialization(ErrorPageRegistry registry) { |
||||
for (ErrorPageRegistrar registrar : getRegistrars()) { |
||||
registrar.registerErrorPages(registry); |
||||
} |
||||
} |
||||
|
||||
private Collection<ErrorPageRegistrar> getRegistrars() { |
||||
if (this.registrars == null) { |
||||
// Look up does not include the parent context
|
||||
this.registrars = new ArrayList<ErrorPageRegistrar>(this.applicationContext |
||||
.getBeansOfType(ErrorPageRegistrar.class, false, false).values()); |
||||
Collections.sort(this.registrars, AnnotationAwareOrderComparator.INSTANCE); |
||||
this.registrars = Collections.unmodifiableList(this.registrars); |
||||
} |
||||
return this.registrars; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,33 @@
@@ -0,0 +1,33 @@
|
||||
/* |
||||
* Copyright 2012-2016 the original author or authors. |
||||
* |
||||
* Licensed 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.springframework.boot.web.servlet; |
||||
|
||||
/** |
||||
* Interface for a registry that holds {@link ErrorPage ErrorPages}. |
||||
* |
||||
* @author Phillip Webb |
||||
* @since 1.4.0 |
||||
*/ |
||||
public interface ErrorPageRegistry { |
||||
|
||||
/** |
||||
* Adds error pages that will be used when handling exceptions. |
||||
* @param errorPages the error pages |
||||
*/ |
||||
void addErrorPages(ErrorPage... errorPages); |
||||
|
||||
} |
||||
Loading…
Reference in new issue