org.apache.sshd.sftp.request.SshFxpRealpathRequest 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.request;

import java.util.List;

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

/**
 * Data container for 'SSH_FXP_REALPATH' request.
 * 
 * @author Apache MINA Project
 */
public class SshFxpRealpathRequest extends BaseRequest {
	private final String path;
    private final byte options;
    private final List compose;

	/**
	 * Creates a SshFxpRealpathRequest instance.
	 * 
	 * @param id   The request id.
	 * @param path The requested file path.
	 */
	public SshFxpRealpathRequest(final int id, final String path, final byte options, final List compose) {
		super(id);
		this.path = path;
        this.options = options;
        this.compose = compose;
	}

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

	/**
	 * {@inheritDoc}
	 */
	public String toString() {
        return getName() + "[path=" + path + "]";
	}

	/**
	 * Returns the path.
	 * 
	 * @return The path.
	 */
	public String getPath() {
		return path;
	}

    public byte getOptions() {
        return options;
    }

    public List getCompose() {
        return compose;
    }
}