1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.vfs2.provider;
18
19 import org.apache.commons.logging.Log;
20 import org.apache.commons.vfs2.FileSystemException;
21
22 /**
23 * A partial {@link VfsComponent} implementation.
24 */
25 public abstract class AbstractVfsComponent implements VfsComponent {
26
27 private VfsComponentContext context;
28 private Log log;
29
30 /**
31 * Sets the Logger to use for the component.
32 *
33 * @param log The Log to use.
34 */
35 @Override
36 public final void setLogger(final Log log) {
37 this.log = log;
38 }
39
40 /**
41 * Sets the context for this file system provider.
42 *
43 * @param context The VfsComponentContext.
44 */
45 @Override
46 public final void setContext(final VfsComponentContext context) {
47 this.context = context;
48 }
49
50 /**
51 * Initializes the component. This implementation does nothing.
52 *
53 * @throws FileSystemException if an error occurs.
54 */
55 @Override
56 public void init() throws FileSystemException {
57 // default is noop.
58 }
59
60 /**
61 * Closes the provider. This implementation does nothing.
62 */
63 @Override
64 public void close() {
65 // default is noop.
66 }
67
68 /**
69 * Returns the logger for this file system to use.
70 *
71 * @return logger for this file system
72 */
73 protected final Log getLogger() {
74 return log;
75 }
76
77 /**
78 * Returns the context for this provider.
79 *
80 * @return provider context
81 */
82 protected final VfsComponentContext getContext() {
83 return context;
84 }
85 }