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
|
package org.apache.velocity.app.event.implement;
/*
* 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.
*/
import org.apache.velocity.app.event.IncludeEventHandler;
import org.apache.velocity.context.Context;
import org.apache.velocity.runtime.RuntimeServices;
import org.apache.velocity.util.ContextAware;
import org.apache.velocity.util.RuntimeServicesAware;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
/**
* Simple event handler that checks to see if an included page is available.
* If not, it includes a designated replacement page instead.
*
* <P>By default, the name of the replacement page is "notfound.vm", however this
* page name can be changed by setting the Velocity property
* <code>eventhandler.include.notfound</code>, for example:</p>
* <pre><code>
* eventhandler.include.notfound = error.vm
* </code></pre>
* <p>The name of the missing resource is put into the Velocity context, under the
* key "missingResource", so that the "notfound" template can report the missing
* resource with a Velocity reference, like:
* <code>$missingResource</code>
* </p>
*
* @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a>
* @version $Id$
* @since 1.5
*/
public class IncludeNotFound implements IncludeEventHandler, RuntimeServicesAware, ContextAware {
private static final String DEFAULT_NOT_FOUND = "notfound.vm";
private static final String PROPERTY_NOT_FOUND = "eventhandler.include.notfound";
private RuntimeServices rs = null;
String notfound;
Context context;
protected Logger log;
/**
* Check to see if included file exists, and display "not found" page if it
* doesn't. If "not found" page does not exist, log an error and return
* null.
*
* @param includeResourcePath
* @param currentResourcePath
* @param directiveName
* @return message.
*/
@Override
public String includeEvent(
Context context,
String includeResourcePath,
String currentResourcePath,
String directiveName)
{
/*
* check to see if page exists
*/
boolean exists = (rs.getLoaderNameForResource(includeResourcePath) != null);
if (!exists)
{
context.put("missingResource", includeResourcePath);
if (rs.getLoaderNameForResource(notfound) != null)
{
return notfound;
}
else
{
/*
* can't find not found, so display nothing
*/
log.error("Can't find include not found page: {}", notfound);
return null;
}
}
else
return includeResourcePath;
}
/**
* @see org.apache.velocity.util.RuntimeServicesAware#setRuntimeServices(org.apache.velocity.runtime.RuntimeServices)
*/
@Override
public void setRuntimeServices(RuntimeServices rs)
{
this.rs = rs;
log = rs.getLog("event");
notfound = StringUtils.trim(rs.getString(PROPERTY_NOT_FOUND, DEFAULT_NOT_FOUND));
}
/**
* @see org.apache.velocity.util.ContextAware#setContext(org.apache.velocity.context.Context)
*/
@Override
public void setContext(Context context)
{
this.context = context;
}
}
|
