1fba2635c088b01af59300e8a02611bb788ee3bffchrismair/*
2fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Copyright 2008 the original author or authors.
3fba2635c088b01af59300e8a02611bb788ee3bffchrismair *
4fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Licensed under the Apache License, Version 2.0 (the "License");
5fba2635c088b01af59300e8a02611bb788ee3bffchrismair * you may not use this file except in compliance with the License.
6fba2635c088b01af59300e8a02611bb788ee3bffchrismair * You may obtain a copy of the License at
7fba2635c088b01af59300e8a02611bb788ee3bffchrismair *
8fba2635c088b01af59300e8a02611bb788ee3bffchrismair *      http://www.apache.org/licenses/LICENSE-2.0
9fba2635c088b01af59300e8a02611bb788ee3bffchrismair *
10fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Unless required by applicable law or agreed to in writing, software
11fba2635c088b01af59300e8a02611bb788ee3bffchrismair * distributed under the License is distributed on an "AS IS" BASIS,
12fba2635c088b01af59300e8a02611bb788ee3bffchrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13fba2635c088b01af59300e8a02611bb788ee3bffchrismair * See the License for the specific language governing permissions and
14fba2635c088b01af59300e8a02611bb788ee3bffchrismair * limitations under the License.
15fba2635c088b01af59300e8a02611bb788ee3bffchrismair */
16fba2635c088b01af59300e8a02611bb788ee3bffchrismairpackage org.mockftpserver.fake.filesystem;
17fba2635c088b01af59300e8a02611bb788ee3bffchrismair
18fba2635c088b01af59300e8a02611bb788ee3bffchrismairimport org.mockftpserver.core.MockFtpServerException;
19fba2635c088b01af59300e8a02611bb788ee3bffchrismair
20fba2635c088b01af59300e8a02611bb788ee3bffchrismair/**
21fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Represents an error that occurs while performing a FileSystem operation.
22fba2635c088b01af59300e8a02611bb788ee3bffchrismair *
23fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @author Chris Mair
24fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @version $Revision$ - $Date$
25fba2635c088b01af59300e8a02611bb788ee3bffchrismair */
26fba2635c088b01af59300e8a02611bb788ee3bffchrismairpublic class FileSystemException extends MockFtpServerException {
27fba2635c088b01af59300e8a02611bb788ee3bffchrismair
28fba2635c088b01af59300e8a02611bb788ee3bffchrismair    /**
29fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * The path involved in the file system operation that caused the exception
30fba2635c088b01af59300e8a02611bb788ee3bffchrismair     */
31fba2635c088b01af59300e8a02611bb788ee3bffchrismair    private String path;
32fba2635c088b01af59300e8a02611bb788ee3bffchrismair
33fba2635c088b01af59300e8a02611bb788ee3bffchrismair    /**
34fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * The message key for the exception message
35fba2635c088b01af59300e8a02611bb788ee3bffchrismair     */
36fba2635c088b01af59300e8a02611bb788ee3bffchrismair    private String messageKey;
37fba2635c088b01af59300e8a02611bb788ee3bffchrismair
38fba2635c088b01af59300e8a02611bb788ee3bffchrismair    /**
39fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * Construct a new instance for the specified path and message key
40fba2635c088b01af59300e8a02611bb788ee3bffchrismair     *
41fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * @param path       - the path involved in the file system operation that caused the exception
42fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * @param messageKey - the exception message key
43fba2635c088b01af59300e8a02611bb788ee3bffchrismair     */
44fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public FileSystemException(String path, String messageKey) {
45fba2635c088b01af59300e8a02611bb788ee3bffchrismair        super(path);
46fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.path = path;
47fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.messageKey = messageKey;
48fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
49fba2635c088b01af59300e8a02611bb788ee3bffchrismair
50fba2635c088b01af59300e8a02611bb788ee3bffchrismair    /**
51fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * @param path       - the path involved in the file system operation that caused the exception
52fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * @param messageKey - the exception message key
53fba2635c088b01af59300e8a02611bb788ee3bffchrismair     * @param cause      - the exception cause, wrapped by this exception
54fba2635c088b01af59300e8a02611bb788ee3bffchrismair     */
55fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public FileSystemException(String path, String messageKey, Throwable cause) {
56fba2635c088b01af59300e8a02611bb788ee3bffchrismair        super(path, cause);
57fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.path = path;
58fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.messageKey = messageKey;
59fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
60fba2635c088b01af59300e8a02611bb788ee3bffchrismair
61fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public String getPath() {
62fba2635c088b01af59300e8a02611bb788ee3bffchrismair        return path;
63fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
64fba2635c088b01af59300e8a02611bb788ee3bffchrismair
65fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public void setPath(String path) {
66fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.path = path;
67fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
68fba2635c088b01af59300e8a02611bb788ee3bffchrismair
69fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public String getMessageKey() {
70fba2635c088b01af59300e8a02611bb788ee3bffchrismair        return messageKey;
71fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
72fba2635c088b01af59300e8a02611bb788ee3bffchrismair
73fba2635c088b01af59300e8a02611bb788ee3bffchrismair    public void setMessageKey(String messageKey) {
74fba2635c088b01af59300e8a02611bb788ee3bffchrismair        this.messageKey = messageKey;
75fba2635c088b01af59300e8a02611bb788ee3bffchrismair    }
76fba2635c088b01af59300e8a02611bb788ee3bffchrismair
77fba2635c088b01af59300e8a02611bb788ee3bffchrismair}
78