001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.activemq.command;
018    
019    import org.apache.activemq.state.CommandVisitor;
020    
021    /**
022     * Represents the end marker of a stream of {@link PartialCommand} instances.
023     * 
024     * @openwire:marshaller code="61"
025     * 
026     */
027    public class LastPartialCommand extends PartialCommand {
028    
029        public static final byte DATA_STRUCTURE_TYPE = CommandTypes.PARTIAL_LAST_COMMAND;
030    
031        public LastPartialCommand() {
032        }
033    
034        public byte getDataStructureType() {
035            return DATA_STRUCTURE_TYPE;
036        }
037    
038        public Response visit(CommandVisitor visitor) throws Exception {
039            throw new IllegalStateException("The transport layer should filter out LastPartialCommand instances but received: " + this);
040        }
041    
042        /**
043         * Lets copy across any transient fields from this command 
044         * to the complete command when it is unmarshalled on the other end
045         *
046         * @param completeCommand the newly unmarshalled complete command
047         */
048        public void configure(Command completeCommand) {
049            // copy across the transient properties added by the low level transport
050            completeCommand.setFrom(getFrom());
051        }
052    }