Package org.sentrysoftware.wmi.windows.remote.share

Class WindowsTempShare

java.lang.Object

org.sentrysoftware.wmi.windows.remote.share.WindowsTempShare

Direct Known Subclasses:

WinTempShare

public class WindowsTempShare
extends Object

Constructor Summary

Constructors

Constructor	Description
WindowsTempShare(WindowsRemoteExecutor windowsRemoteExecutor, String shareNameOrUnc, String remotePath)	Constructor of WindowsTempShare

Method Summary

Modifier and Type	Method	Description
static void	createRemoteDirectory(WindowsRemoteExecutor windowsRemoteExecutor, String remotePath, long timeout)	Create the remote directory.
static WindowsTempShare	getOrCreateShare(WindowsRemoteExecutor windowsRemoteExecutor, long timeout, ShareRemoteDirectoryConsumer<WindowsRemoteExecutor,String,String,Long> shareRemoteDirectory)	Get the existing share on the host or create it if absent.
String	getRemotePath()	Get the remote path
String	getShareName()	Get the share name
String	getUncSharePath()	Get the UNC path of the share
static String	getWindowsDirectory(WindowsRemoteExecutor windowsRemoteExecutor, long timeout)	Get the Windows directory.
WindowsRemoteExecutor	getWindowsRemoteExecutor()	Get the WindowsRemoteExecutor instance

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WindowsTempShare

public WindowsTempShare(WindowsRemoteExecutor windowsRemoteExecutor,
 String shareNameOrUnc,
 String remotePath)

Constructor of WindowsTempShare

Parameters:

windowsRemoteExecutor - the WindowsRemoteExecutor instance connected to the remote host (mandatory)

shareNameOrUnc - The name of the share, or its full UNC path (mandatory)

remotePath - The path on the remote system of the directory being shared

Method Details

getOrCreateShare

public static WindowsTempShare getOrCreateShare(WindowsRemoteExecutor windowsRemoteExecutor,
 long timeout,
 ShareRemoteDirectoryConsumer<WindowsRemoteExecutor,String,String,Long> shareRemoteDirectory)
                                         throws TimeoutException,
WindowsRemoteException

Get the existing share on the host or create it if absent.

Parameters:

windowsRemoteExecutor - WindowsRemoteExecutor instance. (mandatory)

timeout - Timeout in milliseconds. (throws an IllegalArgumentException if negative or zero)

shareRemoteDirectory - ShareRemoteDirectoryConsumer function (mandatory)

Returns:

The remote path.

Throws:

TimeoutException - To notify userName of timeout.

WindowsRemoteException - For any problem encountered.

getWindowsDirectory

public static String getWindowsDirectory(WindowsRemoteExecutor windowsRemoteExecutor,
 long timeout)
                                  throws WindowsRemoteException,
TimeoutException

Get the Windows directory.

Parameters:

windowsRemoteExecutor - WindowsRemoteExecutor instance. (mandatory)

timeout - Timeout in milliseconds. (throws an IllegalArgumentException if negative or zero)

Returns:

The Windows directory.

Throws:

WindowsRemoteException - For any problem encountered.

TimeoutException - To notify userName of timeout.

See Also:

• Win32_OperatingSystem class

createRemoteDirectory

public static void createRemoteDirectory(WindowsRemoteExecutor windowsRemoteExecutor,
 String remotePath,
 long timeout)
                                  throws WindowsRemoteException,
TimeoutException

Create the remote directory.

Parameters:

windowsRemoteExecutor - WindowsRemoteExecutor instance. (mandatory)

remotePath - The remote path to create

timeout - Timeout in milliseconds

Throws:

WindowsRemoteException - For any problem encountered.

TimeoutException - To notify userName of timeout.

getShareName

public String getShareName()

Get the share name

getUncSharePath

public String getUncSharePath()

Get the UNC path of the share

getRemotePath

public String getRemotePath()

Get the remote path

getWindowsRemoteExecutor

public WindowsRemoteExecutor getWindowsRemoteExecutor()

Get the WindowsRemoteExecutor instance