org.filesys.smb.server.NegotiateContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
The newest version!
/*
 * Copyright (C) 2018 GK Spencer
 *
 * JFileServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JFileServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JFileServer. If not, see .
 */

package org.filesys.smb.server;

import org.filesys.smb.DialectSelector;

/**
 * Negotiate Context class
 *
 * Contains the list of SMB dialects requested by the client. Can be extended to add other negotiate specific values
 * that need to be passed between the parsing of the incoming negotiate request and the packing of the negotiate response
 * @author gkspencer
 */
public class NegotiateContext {

    // List of SMB dialects requested by the client
    private DialectSelector m_dialects;

    // Client/server capabilities
    private int m_capabilities;

    /**
     * Class constructor
     */
    public NegotiateContext() {
    }

    /**
     * Class constructor
     *
     * @param dialects DialectSelector
     */
    public NegotiateContext( DialectSelector dialects) {
        setDialects( dialects);
    }

    /**
     * Find the highest available SMB dialect that the server supports that the client
     * is requesting
     *
     * @param diaSelector DialectSelector
     * @return int
     */
    public int findHighestDialect( DialectSelector diaSelector) {
        return diaSelector.findHighestDialect(getDialects());
    }

    /**
     * Get the list of requested dialects
     *
     * @return DialectSelector
     */
    public DialectSelector getDialects() {
        return m_dialects;
    }

    /**
     * Set the list of requested dialects
     *
     * @param dialects DialectSelector
     */
    public void setDialects( DialectSelector dialects) {
        m_dialects = dialects;
    }

    /**
     * Get the client/server capabilities
     *
     * @return int
     */
    public final int getCapabilities() {
        return m_capabilities;
    }

    /**
     * Check if the specified capability is enabled
     *
     * @param capab int
     * @return boolean
     */
    public final boolean hasCapability(int capab) {
        return (m_capabilities & capab) != 0;
    }

    /**
     * Set the client/server capabilities
     *
     * @param capab int
     */
    public final void setCapabilities( int capab) {
        m_capabilities = capab;
    }

    /**
     * Return the negotiate context as a string
     *
     * @return String
     */
    public String toString() {

        StringBuffer str = new StringBuffer();

        str.append( "[NegCtx dialects=");
        if ( m_dialects != null)
            str.append( m_dialects.toString());
        else
            str.append( "null");
        str.append( "]");

        return str.toString();
    }
}