1 //
2 // ========================================================================
3 // Copyright (c) 1995-2015 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.start;
20
21 import java.io.IOException;
22 import java.net.URI;
23 import java.nio.file.Path;
24
25 /**
26 * Interface for initializing a file resource.
27 */
28 public interface FileInitializer
29 {
30 /**
31 * Initialize a file resource
32 *
33 * @param uri
34 * the remote URI of the resource acting as its source
35 * @param file
36 * the local file resource to initialize. (often in ${jetty.base} directory)
37 * @param fileRef
38 * the simple string reference to the output file, suitable for searching
39 * for the file in other locations (like ${jetty.home} or ${jetty.dir})
40 * @return true if local file is initialized (resulted in a change on disk), false if this
41 * {@link FileInitializer} did nothing.
42 * @throws IOException
43 * if there was an attempt to initialize, but an error occurred.
44 */
45 public boolean init(URI uri, Path file, String fileRef) throws IOException;
46 }