01: /*
02: * Copyright 2007 Hippo.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package nl.hippo.cms.brokenlinkchecker;
17:
18: import nl.hippo.cms.brokenlinkchecker.log.BrokenLinkCheckerLog;
19: import org.apache.commons.httpclient.HttpClient;
20:
21: /**
22: * <p>
23: * This interface holds the information and resources needed by a
24: * {@link BrokenLinkCheckerTask}.
25: * </p>
26: */
27: public interface BrokenLinkCheckerTaskConfiguration {
28: /**
29: * <p>
30: * Get the owning broken link checker run of this task.
31: * </p>
32: *
33: * @return the owning broken link checker run.
34: */
35: BrokenLinkCheckerRun getBrokenLinkCheckerRun();
36:
37: /**
38: * <p>
39: * Get the HTTP client that should be used to execute the HTTP methods
40: * that are used to check the links.
41: * </p>
42: *
43: * @return the HTTP client to use for executing HTTP methods.
44: */
45: HttpClient getHttpClient();
46:
47: /**
48: * <p>
49: * Get the base URL to which the URL of the internal links must be
50: * appended to get the absolute URL of the internal link.
51: * </p>
52: *
53: * @return the base URL for internal links.
54: */
55: String getInternalLinksBaseUrl();
56:
57: /**
58: * <p>
59: * Get the log to which to write messages.
60: * </p>
61: *
62: * @return the log to which to write messages.
63: */
64: BrokenLinkCheckerLog getLog();
65: }
|