File: SSIExternalResolver.java

package info (click to toggle)
tomcat10 10.1.52-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 47,900 kB
  • sloc: java: 375,756; xml: 59,410; jsp: 4,741; sh: 1,381; perl: 324; makefile: 25; ansic: 14
file content (68 lines) | stat: -rw-r--r-- 2,183 bytes parent folder | download | duplicates (6)
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
/*
 * 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.catalina.ssi;


import java.io.IOException;
import java.util.Collection;
import java.util.Date;

/**
 * Interface used by SSIMediator to talk to the 'outside world' ( usually a servlet ).
 */
public interface SSIExternalResolver {
    /**
     * Adds any external variables to the variableNames collection.
     *
     * @param variableNames the collection to add to
     */
    void addVariableNames(Collection<String> variableNames);


    String getVariableValue(String name);


    /**
     * Set the named variable to the specified value. If value is null, then the variable will be removed ( ie. a call
     * to getVariableValue will return null )
     *
     * @param name  of the variable
     * @param value of the variable
     */
    void setVariableValue(String name, String value);


    /**
     * Returns the current date. This is useful for putting the SSI stuff in a regression test. Since you can make the
     * current date a constant, it makes testing easier since the output won't change.
     *
     * @return the data
     */
    Date getCurrentDate();


    long getFileSize(String path, boolean virtual) throws IOException;


    long getFileLastModified(String path, boolean virtual) throws IOException;


    String getFileText(String path, boolean virtual) throws IOException;


    void log(String message, Throwable throwable);
}