org.apache.sshd.sftp.reply.SshFxpHandleReply Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sshd-sftp Show documentation

There is a newer version: 2.14.0

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.sshd.sftp.reply;

import org.apache.sshd.sftp.Handle;
import org.apache.sshd.sftp.subsystem.SftpConstants;

/**
 * Data container for 'SSH_FXP_HANDLE' reply.
 * 
 * @author Apache MINA Project
 */
public class SshFxpHandleReply extends BaseReply {

	private final Handle handle;

	/**
	 * Creates a SshFxpHandleReply instance.
	 * 
	 * @param id       The reply id.
	 * @param handle   The handle.
	 */
	public SshFxpHandleReply(final int id, final Handle handle) {
        super(id);
		this.handle = handle;
	}

	/**
	 * {@inheritDoc}
	 */
    public SftpConstants.Type getMessage() {
        return SftpConstants.Type.SSH_FXP_HANDLE;
    }

	/**
	 * {@inheritDoc}
	 */
	public String toString() {
		return getName() + "[handle=" + handle.getId() + ", file=" + handle.getFile().getAbsolutePath();
	}

	/**
	 * Returns the handle.
	 * 
	 * @return The handle.
	 */
	public Handle getHandle() {
		return handle;
	}
}