org.filesys.util.win32.Win32Utils 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) 2006-2010 Alfresco Software Limited.
 * Copyright (C) 2018 GK Spencer
 *
 * This file is part of Alfresco
 *
 * Alfresco 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.
 *
 * Alfresco 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 Alfresco. If not, see .
 */

package org.filesys.util.win32;

import com.sun.jna.platform.win32.BaseTSD.SIZE_T;
import com.sun.jna.platform.win32.WinNT.HANDLE;

import com.sun.jna.platform.win32.Winnetwk.ConnectFlag;
import com.sun.jna.platform.win32.Winnetwk.NETRESOURCE;
import com.sun.jna.platform.win32.Winnetwk.RESOURCETYPE;
import com.sun.jna.platform.win32.Mpr;
import com.sun.jna.platform.win32.Kernel32;

/**
 * Win32 Specific Utility Class
 *
 * @author gkspencer
 */
public class Win32Utils {

    /**
     * Set the process working set size so that the Java VM does not get swapped out of memory.
     *
     * Setting a value of -1 for the minSize or maxSize can force the Java process to be swapped out
     * of memory.
     *
     * @param minSize long
     * @param maxSize long
     * @return boolean
     */
    public static boolean SetWorkingSetSize(long minSize, long maxSize)
    {
        // Get the current process
        HANDLE handle = Kernel32.INSTANCE.GetCurrentProcess();

        // Set the working set size
        return Kernel32Ex.INSTANCE.SetProcessWorkingSetSize( handle, new SIZE_T( minSize), new SIZE_T( maxSize));
    }

    /**
     * Map a network drive optinally assigning a local drive letter to the mapped drive.
     *
     * @param remPath     UNC path to the remote disk share to map to
     * @param localDev    Local device name (such as 'Z:') to map the remote share to
     * @param userName    If null the default username is used.
     * @param password    If null the default password is used, if an empty string then no password is used.
     * @param interactive If true Windows can display a dialog to prompt for the username/password if the
     *                    specified username/password are not valid.
     * @param prompt      If true then always allow the user to override the specified username/password.
     * @return int
     */
    public static int MapNetworkDrive(String remPath, String localDev, String userName, String password,
                                             boolean interactive, boolean prompt)
    {
        // Set the drive mapping details
        NETRESOURCE resource = new NETRESOURCE();

        resource.dwDisplayType = 0;
        resource.dwScope = 0;
        resource.dwType = RESOURCETYPE.RESOURCETYPE_DISK;
        resource.lpRemoteName = remPath;
        resource.lpLocalName  = localDev;

        int flags = 0;

        if ( interactive)
            flags += ConnectFlag.CONNECT_INTERACTIVE;

        if ( prompt)
            flags += ConnectFlag.CONNECT_PROMPT;

        // Establish a new one
        return Mpr.INSTANCE.WNetUseConnection(null, resource, password, userName, flags, null, null, null);
    }

    /**
     * Disconnect a mapped drive and delete the local drive.
     *
     * @param devName    Either the remote UNC path or the local drive name
     * @param updProfile If true then the user profile is updated to indicate the mapped drive is no longer
     *                   persistent and will not be restored next time the user logs on
     * @param force      If true the drive is disconnected even if there are open files
     * @return int
     */
    public static int DeleteNetworkDrive(String devName, boolean updProfile, boolean force)
    {
        // Initialize the flags
        int flags = 0;

        if ( updProfile)
            flags += ConnectFlag.CONNECT_UPDATE_PROFILE;

        // Disconnect the mapped drive
        return Mpr.INSTANCE.WNetCancelConnection2( devName, flags, force);
    }
}