org.apache.sshd.sftp.request.SshFxpOpenRequest 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 org.apache.sshd.sftp.subsystem.SftpConstants;

/**
 * Data container for 'SSH_FXP_OPEN' request.
 * 
 * @author Apache MINA Project
 */
public class SshFxpOpenRequest extends BaseRequest {
    private final String path;
    private final int acc;
	private final int flags;

	/**
	 * Creates a SshFxpOpenRequest instance.
	 * 
	 * @param id     The request id.
	 * @param path   The path.
	 * @param flags  The flags.
	 */
	public SshFxpOpenRequest(final int id, String path, final int flags) {
        this(id, path, 0, flags);
	}

	/**
	 * Creates a SshFxpOpenRequest instance.
	 * 
	 * @param id     The request id.
	 * @param path   The path.
	 * @param acc    The acc.
	 * @param flags  The flags.
	 */
	public SshFxpOpenRequest(final int id, String path, final int acc, final int flags) {
		super(id);
		this.path = path;
		this.acc = acc;
		this.flags = flags;
	}

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

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

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

	/**
	 * Returns the flags.
	 * 
	 * @return The flags.
	 */
	public int getFlags() {
		return flags;
	}

	/**
	 * Returns the acc.
	 * 
	 * @return The acc.
	 */
	public int getAcc() {
		return acc;
	}
}