1a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair/* 2a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Copyright 20078 the original author or authors. 3a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 4a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 5a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * you may not use this file except in compliance with the License. 6a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * You may obtain a copy of the License at 7a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 8a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * http://www.apache.org/licenses/LICENSE-2.0 9a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 10a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Unless required by applicable law or agreed to in writing, software 11a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * distributed under the License is distributed on an "AS IS" BASIS, 12a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * See the License for the specific language governing permissions and 14a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * limitations under the License. 15a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 16a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairpackage org.mockftpserver.core.command; 17a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 18a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairimport org.mockftpserver.core.CommandSyntaxException; 19a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairimport org.mockftpserver.core.util.Assert; 20a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 21a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairimport java.util.Arrays; 22a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairimport java.util.List; 23a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 24a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair/** 25a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Represents a command received from an FTP client, containing a command name and parameters. 26a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Objects of this class are immutable. 27a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 28a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @author Chris Mair 29a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @version $Revision$ - $Date$ 30a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 31a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairpublic final class Command { 32a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 33a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private String name; 34a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private String[] parameters; 35a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 36a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 37a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Construct a new immutable instance with the specified command name and parameters 38a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 39a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param name - the command name; may not be null 40a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param parameters - the command parameters; may be empty; may not be null 41a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 42a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public Command(String name, String[] parameters) { 43a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair Assert.notNull(name, "name"); 44a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair Assert.notNull(parameters, "parameters"); 45a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair this.name = name; 46a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair this.parameters = copy(parameters); 47a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 48a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 49a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 50a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Construct a new immutable instance with the specified command name and parameters 51a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 52a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param name - the command name; may not be null 53a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param parameters - the command parameters; may be empty; may not be null 54a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 55a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public Command(String name, List parameters) { 56a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair this(name, (String[]) parameters.toArray(new String[parameters.size()])); 57a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 58a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 59a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 60a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the name 61a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 62a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String getName() { 63a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return name; 64a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 65a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 66a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 67a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the parameters 68a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 69a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String[] getParameters() { 70a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return copy(parameters); 71a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 72a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 73a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 74a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Get the String value of the parameter at the specified index 75a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 76a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param index - the index 77a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the parameter value as a String 78a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @throws org.mockftpserver.core.util.AssertFailedException 79a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * if the parameter index is invalid or the value is not a valid String 80a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 81a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String getRequiredParameter(int index) { 82a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair assertValidIndex(index); 83a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return parameters[index]; 84a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 85a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 86a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 87a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Get the String value of the parameter at the specified index; return null if no parameter exists for the index 88a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 89a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param index - the index 90a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the parameter value as a String, or null if this Command does not have a parameter for that index 91a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 92a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String getParameter(int index) { 93a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return (parameters.length > index) ? parameters[index] : null; 94a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 95a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 96a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 97a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Get the String value of the parameter at the specified index; return null if no 98a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * parameter exists for the index. This is an alias for {@link #getParameter(int)}. 99a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 100a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param index - the index 101a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the parameter value as a String, or null if this Command does not have a parameter for that index 102a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 103a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String getOptionalString(int index) { 104a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return getParameter(index); 105a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 106a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 107a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 108a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @see java.lang.Object#equals(java.lang.Object) 109a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 110a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public boolean equals(Object obj) { 111a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair if (this == obj) { 112a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return true; 113a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 114a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair if (obj == null || !(obj instanceof Command)) { 115a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return false; 116a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 117a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return this.hashCode() == obj.hashCode(); 118a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 119a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 120a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 121a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @see java.lang.Object#hashCode() 122a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 123a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public int hashCode() { 124a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair String str = name + Arrays.asList(parameters); 125a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return str.hashCode(); 126a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 127a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 128a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 129a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Return the String representation of this object 130a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 131a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @see java.lang.Object#toString() 132a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 133a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public String toString() { 134a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return "Command[" + name + ":" + Arrays.asList(parameters) + "]"; 135a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 136a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 137a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 138a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Return the name, normalized to a common format - convert to upper case. 139a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 140a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the name converted to upper case 141a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 142a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public static String normalizeName(String name) { 143a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return name.toUpperCase(); 144a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 145a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 146a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 147a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Construct a shallow copy of the specified array 148a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 149a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param array - the array to copy 150a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return a new array with the same contents 151a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 152a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private static String[] copy(String[] array) { 153a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair String[] newArray = new String[array.length]; 154a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair System.arraycopy(array, 0, newArray, 0, array.length); 155a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return newArray; 156a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 157a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 158a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 159a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Assert that the index is valid 160a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 161a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param index - the index 162a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @throws org.mockftpserver.core.CommandSyntaxException 163a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * - if the parameter index is invalid 164a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 165a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private void assertValidIndex(int index) { 166a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair if (index < 0 || index >= parameters.length) { 167a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair throw new CommandSyntaxException("The parameter index " + index + " is not valid for " + this); 168a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 169a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 170a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 171a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair} 172