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
|
/*
* Copyright 2007 the original author or authors.
*
* Licensed 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.mockftpserver.stub.command;
import org.mockftpserver.core.command.Command;
import org.mockftpserver.core.command.CommandHandler;
import org.mockftpserver.core.command.InvocationRecord;
import org.mockftpserver.core.session.Session;
/**
* CommandHandler for the NLST command. Return the configured directory listing on the data
* connection, along with two replies on the control connection: a reply code of 150 and
* another of 226. By default, return an empty directory listing. You can customize the
* returned directory listing by setting the <code>directoryListing</code> property.
* <p>
* Each invocation record stored by this CommandHandler includes the following data element key/values:
* <ul>
* <li>{@link #PATHNAME_KEY} ("pathname") - the pathname of the directory (or file) submitted on the
* invocation (the first command parameter); this parameter is optional, so the value may be null.
* </ul>
*
* @author Chris Mair
* @version $Revision$ - $Date$
*/
public class NlstCommandHandler extends AbstractStubDataCommandHandler implements CommandHandler {
public static final String PATHNAME_KEY = "pathname";
private String directoryListing = "";
/**
* @see org.mockftpserver.stub.command.AbstractStubDataCommandHandler#beforeProcessData(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord)
*/
protected void beforeProcessData(Command command, Session session, InvocationRecord invocationRecord) throws Exception {
invocationRecord.set(PATHNAME_KEY, command.getOptionalString(0));
}
/**
* @see org.mockftpserver.stub.command.AbstractStubDataCommandHandler#processData(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord)
*/
protected void processData(Command command, Session session, InvocationRecord invocationRecord) {
session.sendData(directoryListing.getBytes(), directoryListing.length());
}
/**
* Set the contents of the directoryListing to send back on the data connection for this command.
* The passed-in value is trimmed automatically.
*
* @param directoryListing - the directoryListing to set
*/
public void setDirectoryListing(String directoryListing) {
this.directoryListing = directoryListing.trim();
}
}
|
