Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- allowDelegation() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Let remote commands use the caller's credentials to reach a further host — a UNC path on a file server, a database, another server — like
winrs -allowdelegate. - apply(W, R, S, T) - Method in interface org.metricshub.winrm.ShareRemoteDirectoryConsumer
-
Share the remote directory on the host.
- arc4(byte[]) - Static method in class org.metricshub.winrm.light.EncryptionUtils
- arraySeparator(String) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the string that joins the elements of a WMI array property in a WQL row, such as
IPAddressinWin32_NetworkAdapterConfiguration. - asMap() - Method in class org.metricshub.winrm.WqlRow
-
Get all properties of the row, in the order the server returned them.
- attributes() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the raw Windows
FileAttributesbit flags. - authentication(AuthScheme...) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the authentication schemes, tried in the given order until one succeeds.
- AuthenticationEnum - Enum in org.metricshub.winrm.service.client.auth
- AuthScheme - Enum in org.metricshub.winrm
-
Authentication scheme for
WinRMClient.builder(String).
B
- BASIC - Enum constant in enum org.metricshub.winrm.AuthScheme
-
HTTP Basic authentication — the credential rides the
Authorizationheader of every request. - BASIC - Enum constant in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
- build() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Build the client.
- buildEndpointUrl(WinRMHttpProtocolEnum, String, Integer) - Static method in class org.metricshub.winrm.service.WinRMEndpoint
-
Build the endpoint URL.
- builder(String) - Static method in class org.metricshub.winrm.WinRMClient
-
Start building a client for the given host.
- buildNamespace(String) - Static method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the namespace and replace '\' by '/' if necessary default: "ROOT\\CIMV2" if null
- buildNewOutputFileName() - Static method in class org.metricshub.winrm.WindowsRemoteProcessUtils
-
Builds a new output file name, with 99.9999999% chances of being unique on the remote system
- ByteArrayUtils - Class in org.metricshub.winrm.light
-
Code from io.cloudsoft.winrm4j.client.encryption.ByteArrayUtils release 0.12.3 @link https://github.com/cloudsoft/winrm4j
C
- calculateRC4(byte[], byte[]) - Static method in class org.metricshub.winrm.light.EncryptionUtils
-
Calculates RC4
- charset(Charset) - Method in class org.metricshub.winrm.CommandRequest
-
Set the charset used to decode the command output.
- checkArgumentNotZeroOrNegative(long, String) - Static method in class org.metricshub.winrm.Utils
-
Check if the required argument is not negative or zero.
- checkNonBlank(String, String) - Static method in class org.metricshub.winrm.Utils
-
Check if the required argument is not blank (null or empty).
- checkNonNull(T, String) - Static method in class org.metricshub.winrm.Utils
-
Check if the required argument is not null.
- checkNonNullField(T, String) - Static method in class org.metricshub.winrm.Utils
-
Check if the required field is not null.
- Chunk(byte[], byte[]) - Constructor for class org.metricshub.winrm.CommandCursor.Chunk
-
Create a chunk over the given stream bytes (not copied: a chunk is a transient carrier between the protocol loop and the decoder, not a retained value).
- CipherGen - Class in org.metricshub.winrm.light
-
Code from io.cloudsoft.winrm4j.client.ntlm.forks.httpclient.NTLMEngineImpl release 0.12.3 @link https://github.com/cloudsoft/winrm4j io.cloudsoft.winrm4j.client.ntlm.forks.httpclient is a fork of apache-httpclient 4.5.13
- CipherGen(Random, long, String, String, char[], byte[], byte[]) - Constructor for class org.metricshub.winrm.light.CipherGen
-
Create a generator for the NTLM responses of one authentication exchange.
- close() - Method in interface org.metricshub.winrm.CommandCursor
-
Terminate the command (when it is still running) with the WinRM terminate Signal and release the executor's connection.
- close() - Method in class org.metricshub.winrm.light.LightWinRMService
- close() - Method in class org.metricshub.winrm.RemoteProcess
-
Terminate the command (when it is still running) and release the client's connection.
- close() - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Close the executor and release its resources.
- close() - Method in class org.metricshub.winrm.WinRMClient
-
Close the client and release its connection.
- close() - Method in interface org.metricshub.winrm.WqlCursor
-
Release the enumeration and the executor's connection.
- columns() - Method in class org.metricshub.winrm.WqlResult
-
Get the column names, in the order they appear in the WQL query (
SELECT *yields them in case-insensitive alphabetical order). - command(String) - Method in class org.metricshub.winrm.WinRMClient
-
Prepare a command execution.
- CommandCursor - Interface in org.metricshub.winrm
-
A cursor over the raw output of a running remote command, returned by
WindowsRemoteExecutor.startCommand(String, String, long). - CommandCursor.Chunk - Class in org.metricshub.winrm
-
One Receive response's worth of raw output bytes, split by stream.
- CommandRequest - Class in org.metricshub.winrm
-
A command being prepared for execution, created by
WinRMClient.command(String). - CommandResult - Class in org.metricshub.winrm
-
The result of a command executed on the remote host: its output streams, its process exit code, and the time it took.
- concat(byte[]...) - Static method in class org.metricshub.winrm.light.ByteArrayUtils
- consoleCodePage(int) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the console code page of the remote command shell.
- copyLocalFilesToRemote(WindowsRemoteExecutor, String, List<String>, long) - Static method in class org.metricshub.winrm.ShellFileCopy
-
Copy the specified local files to a temporary directory on the remote host through the WinRM command shell, and return the command updated so that each reference to a local file path points to the corresponding remote copy.
- copyLocalFilesToRemote(WindowsRemoteExecutor, String, List<String>, Map<String, String>, long) - Static method in class org.metricshub.winrm.ShellFileCopy
-
Variant of
ShellFileCopy.copyLocalFilesToRemote(WindowsRemoteExecutor, String, List, long)that also sets environment variables in the remote shell. - copyLocalFileToRemoteFile(WindowsRemoteExecutor, Path, String, long) - Static method in class org.metricshub.winrm.ShellFileCopy
-
Copy one local file to an explicit path on the remote host through the WinRM command shell, creating the destination directory when needed.
- created() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the creation time.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>) - Static method in class org.metricshub.winrm.service.WinRMExecutorFactory
-
Create a
WindowsRemoteExecutor. - createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, boolean, SSLContext, boolean, int, boolean, int, long) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor that may delegate the caller's Kerberos credentials to the host, so remote commands can authenticate onward as the caller (the second hop), and may load the user profile in the command shell.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, boolean, SSLContext, boolean, int, boolean, String, int, int, long) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor that may delegate the caller's Kerberos credentials to the host, so remote commands can authenticate onward as the caller (the second hop), may load the user profile in the command shell, joins WMI array properties with a custom separator, and replaces the command shell after a given number of commands.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, boolean, SSLContext, boolean, int, boolean, String, int, long) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor that may delegate the caller's Kerberos credentials to the host, so remote commands can authenticate onward as the caller (the second hop), may load the user profile in the command shell, and joins WMI array properties with a custom separator.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor with an explicit TLS configuration, overriding the
org.metricshub.winrm.tls.insecuresystem property for this instance. - createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean) - Static method in class org.metricshub.winrm.service.WinRMExecutorFactory
-
Create a
WindowsRemoteExecutorwith an explicit TLS configuration, overriding theorg.metricshub.winrm.tls.insecuresystem property for this instance. - createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean, int) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor with an explicit console code page for the command shell.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean, int) - Static method in class org.metricshub.winrm.service.WinRMExecutorFactory
-
Create a
WindowsRemoteExecutorwith an explicit console code page for the command shell. - createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean, int, int, long) - Static method in class org.metricshub.winrm.light.LightWinRMService
-
Create a light WinRM executor with an opt-in retry policy for transient connection failures.
- createInstance(WinRMEndpoint, long, Path, List<AuthenticationEnum>, SSLContext, boolean, int, int, long) - Static method in class org.metricshub.winrm.service.WinRMExecutorFactory
-
Create a
WindowsRemoteExecutorwith an opt-in retry policy for transient connection failures. - createNetworkResource(String, String) - Static method in class org.metricshub.winrm.WmiHelper
-
The "network resource" is either just the namespace (for localhost), or \\hostname\\namespace.
- createRemoteDirectory(WindowsRemoteExecutor, String, long, long) - Static method in class org.metricshub.winrm.WindowsTempShare
-
Create the remote directory.
- credentials(String, char[]) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the credentials (mandatory).
D
- DEFAULT_ARRAY_SEPARATOR - Static variable in class org.metricshub.winrm.light.LightWinRMService
-
The default string joining the elements of a WMI array property in a WQL row.
- DEFAULT_CHARSET - Static variable in class org.metricshub.winrm.light.NTLMEngineUtils
-
Character encoding
- DEFAULT_MAX_BYTES - Static variable in class org.metricshub.winrm.RemoteFile
-
Default cap of
RemoteFile.readBytes()andRemoteFile.readText(Charset): 64 MiB. - DEFAULT_MAX_COMMANDS_PER_SHELL - Static variable in class org.metricshub.winrm.light.LightWinRMService
-
The default number of commands a remote command shell runs before the client replaces it.
- DEFAULT_NAMESPACE - Static variable in class org.metricshub.winrm.WmiHelper
- DEFAULT_WQL_MAX_ELEMENTS - Static variable in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Default WS-Enumeration
MaxElementsbatch size for WQL queries: how many rows the server may return per Enumerate/Pull response. - digest(String) - Method in class org.metricshub.winrm.RemoteFile
-
Compute the digest of the whole file on the host — nothing but the digest is transferred.
- directoriesOnly() - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report directories only.
- downloadFile(String, Path) - Method in class org.metricshub.winrm.WinRMClient
-
Copy a file from the remote host to a local file, through the WinRM connection itself — the counterpart of
WinRMClient.uploadFile(Path, String), and a shorthand forfile(remoteFile).downloadTo(localFile). - downloadTo(Path) - Method in class org.metricshub.winrm.RemoteFile
-
Download the whole file to a local file — the counterpart of
WinRMClient.uploadFile(Path, String), with the same guarantees: verified: the host first reports the size and the SHA-256 digest of the file, and the received bytes must match both, so the local file is exactly one version of the remote file, never a mix of two: a change that reaches bytes not transferred yet fails the download; no wasted transfer: when the local file already has that digest, nothing is transferred; atomic: the content goes to a temporary file next to the destination (<name>.<random>.part), which is flushed to disk, then moved onto the destination in one step.
E
- elapsed() - Method in class org.metricshub.winrm.CommandResult
-
Get the time the command took, from request to completion.
- elapsed() - Method in class org.metricshub.winrm.WqlResult
-
Get the time the query took, from request to complete result.
- EMPTY - Static variable in class org.metricshub.winrm.Utils
- EncryptionUtils - Class in org.metricshub.winrm.light
-
Code from io.cloudsoft.winrm4j.client.encryption.WinrmEncryptionUtils release 0.12.3 @link https://github.com/cloudsoft/winrm4j
- entries() - Method in class org.metricshub.winrm.RemoteFileList
-
Get the matching entries, in the order the host walked them: the entries of a directory together, depth-first.
- environment(String, String) - Method in class org.metricshub.winrm.CommandRequest
-
Set an environment variable in the remote shell — the equivalent of
winrs -env. - equals(Object) - Method in class org.metricshub.winrm.RemoteFileInfo
- equals(Object) - Method in class org.metricshub.winrm.service.WinRMEndpoint
- execute() - Method in class org.metricshub.winrm.CommandRequest
-
Execute the command and collect its complete output.
- execute() - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
List the directory and collect the result.
- execute() - Method in class org.metricshub.winrm.WqlRequest
-
Execute the query and collect the complete result.
- execute(String, WinRMHttpProtocolEnum, String, Integer, String, char[], String, long, List<String>, Path, List<AuthenticationEnum>) - Static method in class org.metricshub.winrm.command.WinRMCommandExecutor
-
Execute a command on a remote Windows system and return an object with the output of the command.
- execute(Callable<T>, long) - Static method in class org.metricshub.winrm.Utils
-
Run the given
Callableusing the passed timeout in seconds. - executeCommand(String, String, Charset, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- executeCommand(String, String, Charset, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Execute the command on the remote
- executeCommand(String, String, Map<String, String>, Charset, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- executeCommand(String, String, Map<String, String>, Charset, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Variant of
WindowsRemoteExecutor.executeCommand(String, String, Charset, long)that also sets environment variables in the remote shell. - executeWql(String, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- executeWql(String, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Execute a WQL query and process its result.
- executeWql(String, String, long, int, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- executeWql(String, String, long, int, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Execute a WQL query with explicit enumeration parameters: the WMI namespace, the WS-Enumeration
MaxElementsbatch size, and the per-PullMaxTime. - executeWql(WinRMHttpProtocolEnum, String, Integer, String, char[], String, String, long, Path, List<AuthenticationEnum>) - Static method in class org.metricshub.winrm.wql.WinRMWqlExecutor
-
Execute a WQL query and process its result.
- executeWqlInCimv2(WindowsRemoteExecutor, String, long) - Static method in class org.metricshub.winrm.WmiHelper
-
Execute one of the library's internal housekeeping WQL queries (encoding detection, Windows directory discovery) explicitly in the "ROOT\\CIMV2" namespace — where the standard
Win32_*classes live — regardless of the executor's configured default namespace, which the caller may have pointed at a custom namespace. - exists() - Method in class org.metricshub.winrm.RemoteFile
-
Tell whether the file or directory exists:
info().isPresent(). - exitCode() - Method in interface org.metricshub.winrm.CommandCursor
-
Get the command's exit code.
- exitCode() - Method in class org.metricshub.winrm.CommandResult
-
Get the process exit code of the command.
- exitCode() - Method in class org.metricshub.winrm.RemoteProcess
-
Get the exit code of the completed command.
- extractPropertiesFromResult(List<Map<String, Object>>, String) - Static method in class org.metricshub.winrm.WmiHelper
-
Extract the exact name of the properties from a WMI result.
- extractPropertiesFromResult(List<Map<String, Object>>, WqlQuery) - Static method in class org.metricshub.winrm.WmiHelper
-
Extract the exact name of the properties from a WMI result.
F
- file(String) - Method in class org.metricshub.winrm.WinRMClient
-
Prepare access to a file or directory on the remote host, through the WinRM connection itself: read a file's content (whole, as a byte range, or as a stream), compute its digest, get its properties, or list a directory.
- filesOnly() - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report files only (directories are still traversed with
RemoteDirectoryListing.recursive()). - formatHexDump(byte[]) - Static method in class org.metricshub.winrm.light.ByteArrayUtils
G
- get(String) - Method in class org.metricshub.winrm.WqlRow
-
Get the value of a property.
- getCleanWql() - Method in class org.metricshub.winrm.WqlQuery
- getComputerName() - Static method in class org.metricshub.winrm.Utils
- getCurrentTimeMillis() - Static method in class org.metricshub.winrm.Utils
-
Get the current time in Milliseconds.
- getDomain() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the domain from the raw username
- getEndpoint() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the endpoint in the form of http(s)://host:port/wsman
- getEndpointPort(WinRMHttpProtocolEnum, Integer) - Static method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the endpoint port: The port if provided 5986 if the protocol is HTTPS 5985 otherwise
- getExecutionTime() - Method in class org.metricshub.winrm.WindowsRemoteCommandResult
-
Get the execution time of the command in seconds.
- getExecutionTime() - Method in class org.metricshub.winrm.wql.WinRMWqlExecutor
-
Get the execution time of the query.
- getFaultCode() - Method in exception org.metricshub.winrm.exceptions.WinRMFaultException
-
Get the numeric WSManFault code, e.g.
- getFaultDetail() - Method in exception org.metricshub.winrm.exceptions.WinRMFaultException
-
Get the detailed WSManFault message — the provider-level detail where WMI puts mnemonics such as
WBEM_E_INVALID_CLASS. - getFaultReason() - Method in exception org.metricshub.winrm.exceptions.WinRMFaultException
-
Get the SOAP fault reason text.
- getHeaders() - Method in class org.metricshub.winrm.wql.WinRMWqlExecutor
-
Get the headers of the query.
- getHostname() - Method in class org.metricshub.winrm.light.LightWinRMService
- getHostname() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the hostname
- getHostname() - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Get the hostname.
- getHttpStatus() - Method in exception org.metricshub.winrm.exceptions.WinRMFaultException
-
Get the HTTP status of the faulting response (typically 500 for a SOAP fault).
- getLanManagerSessionKey() - Method in class org.metricshub.winrm.light.CipherGen
-
Get LAN Manager session key
- getLittleEndianUnsignedInt(long) - Static method in class org.metricshub.winrm.light.ByteArrayUtils
- getLM2SessionResponse() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate and return LM2 session response
- getLMResponse() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate and return the LMResponse
- getLMUserSessionKey() - Method in class org.metricshub.winrm.light.CipherGen
-
Get LMUserSessionKey
- getLMv2Response() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate the LMv2Response
- getMD5() - Static method in class org.metricshub.winrm.light.EncryptionUtils
- getNamespace() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the namespace
- getNTLM2SessionResponse() - Method in class org.metricshub.winrm.light.CipherGen
-
Get NTLM2SessionResponse
- getNTLM2SessionResponseUserSessionKey() - Method in class org.metricshub.winrm.light.CipherGen
-
Get NTLM2SessionResponseUserSessionKey
- getNTLMResponse() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate and return the NTLMResponse
- getNTLMUserSessionKey() - Method in class org.metricshub.winrm.light.CipherGen
-
Get NTLMUserSessionKey
- getNTLMv2Response() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate the NTLMv2Response
- getNTLMv2UserSessionKey() - Method in class org.metricshub.winrm.light.CipherGen
-
GetNTLMv2UserSessionKey
- getOrCreateShare(WindowsRemoteExecutor, long, ShareRemoteDirectoryConsumer<WindowsRemoteExecutor, String, String, Long>) - Static method in class org.metricshub.winrm.WindowsTempShare
-
Get the existing share on the host or create it if absent.
- getPassword() - Method in class org.metricshub.winrm.light.LightWinRMService
- getPassword() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the password
- getPassword() - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Get the password.
- getPort() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the resolved endpoint port (the port provided to the constructor, or the protocol default).
- getProtocol() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the protocol
- getRawUsername() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the username exactly as supplied in the constructor (could be in domain\\user form, and may contain the whitespace the caller typed).
- getRemainingTime(long, long, String) - Static method in class org.metricshub.winrm.TimeoutHelper
-
Get the remaining time before timeout.
- getRemotePath() - Method in class org.metricshub.winrm.WindowsTempShare
-
Get the remote path
- getRows() - Method in class org.metricshub.winrm.wql.WinRMWqlExecutor
-
Get the result rows of the query.
- getSecondaryKey() - Method in class org.metricshub.winrm.light.CipherGen
-
Calculate and return random secondary key
- getSelectedProperties() - Method in class org.metricshub.winrm.WqlQuery
-
Get the properties of the SELECT statement, in lower case.
- getShareName() - Method in class org.metricshub.winrm.WindowsTempShare
-
Get the share name
- getStatusCode() - Method in class org.metricshub.winrm.WindowsRemoteCommandResult
-
Get the return status code of the command
- getStderr() - Method in class org.metricshub.winrm.WindowsRemoteCommandResult
-
Get the stderr of the command.
- getStdout() - Method in class org.metricshub.winrm.WindowsRemoteCommandResult
-
Get the stdout of the command.
- getSubPropertiesMap() - Method in class org.metricshub.winrm.WqlQuery
-
Get the map of subproperties to retrieve inside each selected property, in lower case.
- getUncSharePath() - Method in class org.metricshub.winrm.WindowsTempShare
-
Get the UNC path of the share
- getUsername() - Method in class org.metricshub.winrm.light.LightWinRMService
- getUsername() - Method in class org.metricshub.winrm.service.WinRMEndpoint
-
Get the username part of the raw username
- getUsername() - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Get the username.
- getValueOf(String) - Static method in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
-
Get the value of the enum Name regardless the cardinality.
- getWindowsDirectory(WindowsRemoteExecutor, long) - Static method in class org.metricshub.winrm.WindowsTempShare
-
Get the Windows directory.
- getWindowsEncodingCharset(WindowsRemoteExecutor, long) - Static method in class org.metricshub.winrm.WindowsRemoteProcessUtils
-
Deprecated.
- getWindowsRemoteExecutor() - Method in class org.metricshub.winrm.WindowsTempShare
-
Get the WindowsRemoteExecutor instance
- glob(String) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report only the entries whose name (not path) matches the given Windows wildcard pattern:
*matches any sequence of characters (including none),?exactly one character, and every other character only itself, case-insensitively.
H
- hashCode() - Method in class org.metricshub.winrm.RemoteFileInfo
- hashCode() - Method in class org.metricshub.winrm.service.WinRMEndpoint
- hmacMd5(byte[], byte[]) - Static method in class org.metricshub.winrm.light.EncryptionUtils
- HMACMD5 - Class in org.metricshub.winrm.light
-
Cryptography support - HMACMD5 - algorithmically based on various web resources by Karl Wright Code from io.cloudsoft.winrm4j.client.ntlm.forks.httpclient.NTLMEngineImpl release 0.12.3 @link https://github.com/cloudsoft/winrm4j io.cloudsoft.winrm4j.client.ntlm.forks.httpclient is a fork of apache-httpclient 4.5.13
- hostname() - Method in class org.metricshub.winrm.WinRMClient
-
Get the hostname this client connects to.
- http() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Connect over HTTP (port 5985 unless
WinRMClient.Builder.port(int)is set) — the default. - HTTP - Enum constant in enum org.metricshub.winrm.WinRMHttpProtocolEnum
- https() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Connect over HTTPS (port 5986 unless
WinRMClient.Builder.port(int)is set). - HTTPS - Enum constant in enum org.metricshub.winrm.WinRMHttpProtocolEnum
I
- inaccessible() - Method in class org.metricshub.winrm.RemoteFileList
-
Get the directories that could not be read (typically access denied): their content is missing from
RemoteFileList.entries(), while the walk went on elsewhere. - info() - Method in class org.metricshub.winrm.RemoteFile
-
Get the properties of the file or directory: size, timestamps, attributes.
- interrupt() - Method in interface org.metricshub.winrm.CommandCursor
-
Interrupt the command the way a console Ctrl+C would — the WSMan Signal operation with the
ctrl_ccode. - interrupt() - Method in class org.metricshub.winrm.RemoteProcess
-
Interrupt the command the way a console Ctrl+C would — the WSMan
ctrl_cSignal. - isArchive() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is marked for archiving (backup).
- isBlank(String) - Static method in class org.metricshub.winrm.Utils
- isDirectory() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is a directory.
- isEmpty() - Method in class org.metricshub.winrm.WqlResult
-
Whether the query returned no rows.
- isEmpty(String) - Static method in class org.metricshub.winrm.Utils
- isHidden() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is hidden.
- isLocalNetworkResource(String) - Static method in class org.metricshub.winrm.WmiHelper
- isNotBlank(String) - Static method in class org.metricshub.winrm.Utils
- isReadOnly() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is read-only.
- isReparsePoint() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is a reparse point: a junction, a symbolic link, a mount point, or a cloud placeholder.
- isSystem() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Tell whether the entry is a system file or directory.
- isValidWql(String) - Static method in class org.metricshub.winrm.WmiHelper
-
Check whether the WQL query has one of the syntaxes
WqlQuery.newInstance(CharSequence)parses:SELECT * FROM Class [WHERE ...],SELECT a, b FROM Class [WHERE ...],[SELECT ... - iterator() - Method in class org.metricshub.winrm.WqlResult
K
- KERBEROS - Enum constant in enum org.metricshub.winrm.AuthScheme
-
Kerberos (SPNEGO) authentication — requires HTTPS and connecting by the FQDN the KDC knows.
- KERBEROS - Enum constant in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
L
- lastAccessed() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the time of the last access.
- lastModified() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the time of the last write.
- length(long) - Method in class org.metricshub.winrm.RemoteFile
-
Read at most the given number of bytes (from the
RemoteFile.offset(long), once resolved) instead of reading to the end of the file. - LightWinRMService - Class in org.metricshub.winrm.light
-
Dependency-free
WindowsRemoteExecutorbacked byWsmanClient. - list() - Method in class org.metricshub.winrm.RemoteFile
-
Prepare the listing of this path, a directory: set its filters, then call
RemoteDirectoryListing.execute()orRemoteDirectoryListing.stream(). - loadUserProfile() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Load the user profile in the remote command shell — the opposite of
winrs -noprofile.
M
- main(String[]) - Static method in class org.metricshub.winrm.cli.WinRmCli
-
Run the WinRM command-line client.
- maxBytes(long) - Method in class org.metricshub.winrm.RemoteFile
-
Set the size cap of
RemoteFile.readBytes()andRemoteFile.readText(Charset), which hold the whole content in memory: reading more than the cap fails instead of risking anOutOfMemoryError. - maxCommandsPerShell(int) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set how many commands the remote command shell runs before the client replaces it.
- maxDepth(int) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
List recursively, down to the given depth: 1 is the directory's own entries (the same as a non-recursive listing), 2 adds the entries of its subdirectories, and so on.
- maxSize(long) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report only the files of at most the given size.
- MD4 - Class in org.metricshub.winrm.light
-
Cryptography support - MD4.
- MD4() - Constructor for class org.metricshub.winrm.light.MD4
- md5digest(byte[]) - Static method in class org.metricshub.winrm.light.EncryptionUtils
- minSize(long) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report only the files of at least the given size.
- modifiedAfter(Instant) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report only the entries last modified strictly after the given instant.
- modifiedBefore(Instant) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Report only the entries last modified strictly before the given instant.
N
- name() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the last element of the path: the file or directory name (
C:for a drive root). - namespace(String) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the default WMI namespace for WQL queries.
- namespace(String) - Method in class org.metricshub.winrm.WqlRequest
-
Set the WMI namespace to query.
- NEW_LINE - Static variable in class org.metricshub.winrm.Utils
- newInstance(CharSequence) - Static method in class org.metricshub.winrm.WqlQuery
-
Parses the specified WQL query and returns a new instance of WqlQuery Supported WQL syntaxes: SELECT * FROM Class SELECT PropA, PropB FROM Class SELECT PropA, PropB FROM Class WHERE condition ASSOCIATORS OF { objectId } ASSOCIATORS OF { objectId } WHERE condition SELECT * FROM ASSOCIATORS OF { objectId } WHERE condition SELECT PropA, PropB FROM ASSOCIATORS OF { objectId } WHERE condition
- next() - Method in interface org.metricshub.winrm.CommandCursor
-
Block until the remote command produces output (or completes), for at most one per-round-trip timeout.
- next() - Method in interface org.metricshub.winrm.WqlCursor
-
Advance to the next row, issuing the next WS-Enumeration Pull when the current page is exhausted.
- NTLM - Enum constant in enum org.metricshub.winrm.AuthScheme
-
NTLM authentication — over HTTP (with message encryption) or HTTPS.
- NTLM - Enum constant in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
- NTLMEngineUtils - Class in org.metricshub.winrm.light
-
Code from io.cloudsoft.winrm4j.client.ntlm.forks.httpclient.NTLMEngineImpl release 0.12.3 @link https://github.com/cloudsoft/winrm4j io.cloudsoft.winrm4j.client.ntlm.forks.httpclient is a fork of apache-httpclient 4.5.13
- NtlmException - Exception in org.metricshub.winrm.light
-
Replaces org.apache.http.impl.auth.NTLMEngineException in the ported NTLM code.
- NtlmException(String) - Constructor for exception org.metricshub.winrm.light.NtlmException
- NtlmException(String, Throwable) - Constructor for exception org.metricshub.winrm.light.NtlmException
- NTLMSSP_NEGOTIATE_EXTENDED_SESSIONSECURITY - Static variable in class org.metricshub.winrm.light.NTLMEngineUtils
- NTLMSSP_NEGOTIATE_KEY_EXCH - Static variable in class org.metricshub.winrm.light.NTLMEngineUtils
O
- offset(long) - Method in class org.metricshub.winrm.RemoteFile
-
Start reading at the given byte position instead of the beginning of the file.
- onInaccessible(Consumer<String>) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Be told of each directory that could not be read (typically access denied): its path is given to the consumer as soon as the host reports it, and the walk goes on.
- onStderr(Consumer<String>) - Method in class org.metricshub.winrm.CommandRequest
-
Register a callback receiving each chunk of standard error as it arrives, while
CommandRequest.execute()is still running. - onStdout(Consumer<String>) - Method in class org.metricshub.winrm.CommandRequest
-
Register a callback receiving each chunk of standard output as it arrives, while
CommandRequest.execute()is still running — a middle ground between collecting everything and managing aRemoteProcess: tail the output live, but keep the blocking terminal and its completeCommandResult. - openReader(Charset) - Method in class org.metricshub.winrm.RemoteFile
-
Open the content (the whole file, or the configured range) as a character stream decoded with the given charset:
RemoteFile.openStream()behind anInputStreamReader, with the same lifecycle — close it. - openStream() - Method in class org.metricshub.winrm.RemoteFile
-
Open the content (the whole file, or the configured range) as a stream, passed on as it arrives: memory is bounded by one protocol response, not by the file, and there is no size cap.
- org.metricshub.winrm - package org.metricshub.winrm
- org.metricshub.winrm.cli - package org.metricshub.winrm.cli
- org.metricshub.winrm.command - package org.metricshub.winrm.command
- org.metricshub.winrm.exceptions - package org.metricshub.winrm.exceptions
- org.metricshub.winrm.light - package org.metricshub.winrm.light
- org.metricshub.winrm.service - package org.metricshub.winrm.service
- org.metricshub.winrm.service.client.auth - package org.metricshub.winrm.service.client.auth
- org.metricshub.winrm.wql - package org.metricshub.winrm.wql
P
- pageSize(int) - Method in class org.metricshub.winrm.WqlRequest
-
Set the enumeration batch size: how many rows the server may return per WSMan Enumerate/Pull response (
MaxElements). - path() - Method in class org.metricshub.winrm.RemoteFile
-
Get the path of the file on the remote host.
- path() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the full path of the entry, as reported by the host (absolute, with backslashes).
- poll(long) - Method in interface org.metricshub.winrm.CommandCursor
-
Bounded variant of
CommandCursor.next(): block at most the given wait for output. - poll(long, long) - Method in interface org.metricshub.winrm.CommandCursor
-
Cadence variant of
CommandCursor.poll(long): ask the server to answer withinaskMillis— the polling cadence — while allowing the answer itself up tomaxWaitMillisto arrive. - poll(Duration) - Method in class org.metricshub.winrm.RemoteProcess
-
Advance the stream by at most one bounded protocol round trip: ask the server to answer within the given wait — with output when it has any, with the protocol's "nothing yet" otherwise — buffer whatever arrives for the readers, and report whether the command has completed.
- port(int) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the port.
- powerShell(String) - Method in class org.metricshub.winrm.WinRMClient
-
Prepare a PowerShell script execution.
- pullTimeout(Duration) - Method in class org.metricshub.winrm.WqlRequest
-
Set the maximum time the server may hold a single Pull request open before answering with the rows it has (
MaxTime).
R
- readBytes() - Method in class org.metricshub.winrm.RemoteFile
-
Read the content (the whole file, or the configured range) into memory, byte-exact: nothing is converted, and a byte order mark is kept.
- readLittleEndianUnsignedInt(byte[], int) - Static method in class org.metricshub.winrm.light.ByteArrayUtils
- readText(Charset) - Method in class org.metricshub.winrm.RemoteFile
-
Read the content (the whole file, or the configured range) into memory and decode it with the given charset — no guessing, no default.
- recursive() - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
List the whole tree below the directory instead of its own entries only, depth-first.
- RemoteDirectoryListing - Class in org.metricshub.winrm
-
A listing of a remote directory being prepared, created by
RemoteFile.list(): set the filters, then collect the result withRemoteDirectoryListing.execute()or stream it withRemoteDirectoryListing.stream(). - RemoteFile - Class in org.metricshub.winrm
-
A file or directory on the remote host, obtained with
WinRMClient.file(String): read a file's content — whole, as a byte range, or as a stream — download it to a local file, or compute its digest, get its properties (RemoteFile.info(),RemoteFile.exists()), orRemoteFile.list()a directory. - RemoteFileInfo - Class in org.metricshub.winrm
-
The properties of a file or directory on the remote host, as returned by
RemoteFile.info()andRemoteDirectoryListing: an immutable value. - RemoteFileList - Class in org.metricshub.winrm
-
The result of
RemoteDirectoryListing.execute(): the matching entries, and the directories that could not be read. - RemoteProcess - Class in org.metricshub.winrm
-
A running remote command, created by
CommandRequest.start()— the streaming counterpart ofCommandRequest.execute(), shaped likeProcess. - retries(int, Duration) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Retry transient connection failures.
- rows() - Method in class org.metricshub.winrm.WqlResult
-
Get the result rows.
S
- send(byte[], boolean) - Method in interface org.metricshub.winrm.CommandCursor
-
Feed standard input to the running command — the WSMan Send operation, carrying the bytes to the command's
stdinstream. - ShareRemoteDirectoryConsumer<W extends WindowsRemoteExecutor,
R, S, T> - Interface in org.metricshub.winrm - SHELL_OUTPUT_CHARSET - Static variable in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Charset of the output of every command run through this executor: UTF-8, because the remote command shell is created with console code page 65001.
- ShellFileCopy - Class in org.metricshub.winrm
-
Copies local files to the remote host through the WinRM command shell itself, without SMB.
- size() - Method in class org.metricshub.winrm.RemoteFileInfo
-
Get the size of the file.
- size() - Method in class org.metricshub.winrm.WqlResult
-
Get the number of rows.
- sleep(long) - Static method in class org.metricshub.winrm.Utils
-
Wrapper for Thread.sleep(millis)
- sslContext(SSLContext) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Use a custom
SSLContextfor HTTPS — e.g. one built around a dedicated trust store. - stagedSleep(long, long, String) - Static method in class org.metricshub.winrm.TimeoutHelper
-
Sub to make the thread sleep in a stepped delay.
- start() - Method in class org.metricshub.winrm.CommandRequest
-
Start the command and return a
RemoteProcesshandle over it — the streaming counterpart ofCommandRequest.execute(): stdout and stderr can be consumed while the command is still running, and the handle exposes the eventual exit code. - startCommand(String, String, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- startCommand(String, String, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Start a command on the remote host and return a
CommandCursorover its raw output: chunks can be consumed as the WSMan Receive responses arrive, before the command exits. - startCommand(String, String, long, boolean) - Method in class org.metricshub.winrm.light.LightWinRMService
- startCommand(String, String, long, boolean) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Variant of
WindowsRemoteExecutor.startCommand(String, String, long)making theWINRS_CONSOLEMODE_STDINoption explicit. - startCommand(String, String, Map<String, String>, long, boolean) - Method in class org.metricshub.winrm.light.LightWinRMService
- startCommand(String, String, Map<String, String>, long, boolean) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Variant of
WindowsRemoteExecutor.startCommand(String, String, long, boolean)that also sets environment variables in the remote shell. - stderr() - Method in class org.metricshub.winrm.CommandCursor.Chunk
-
Get the raw stderr bytes of this chunk.
- stderr() - Method in class org.metricshub.winrm.CommandResult
-
Get the standard error of the command.
- stderr() - Method in class org.metricshub.winrm.RemoteProcess
-
Get the standard error of the remote command, decoded incrementally: lines can be read while the command is still running.
- stdin() - Method in class org.metricshub.winrm.CommandRequest
-
Declare that the command will be fed standard input interactively, through
RemoteProcess.stdin(), without pre-supplying it: the remote stdin switches to pipe semantics (WINRS_CONSOLEMODE_STDIN=FALSE), so closing the writer actually delivers EOF — a console-mode stdin never reaches EOF for tools likesortorfindstr. - stdin() - Method in class org.metricshub.winrm.RemoteProcess
-
Get the standard input of the remote command.
- stdin(InputStream) - Method in class org.metricshub.winrm.CommandRequest
-
Feed the given stream to the command's standard input, reading it to its end.
- stdin(String) - Method in class org.metricshub.winrm.CommandRequest
-
Feed the given text to the command's standard input.
- stdin(Path) - Method in class org.metricshub.winrm.CommandRequest
-
Feed the content of the given local file to the command's standard input — the equivalent of a local
< fileredirection. - stdinCharset(Charset) - Method in class org.metricshub.winrm.CommandRequest
-
Set the charset used to encode the command's standard input, when it differs from the output charset.
- stdout() - Method in class org.metricshub.winrm.CommandCursor.Chunk
-
Get the raw stdout bytes of this chunk.
- stdout() - Method in class org.metricshub.winrm.CommandResult
-
Get the standard output of the command.
- stdout() - Method in class org.metricshub.winrm.RemoteProcess
-
Get the standard output of the remote command, decoded incrementally: lines can be read while the command is still running.
- stream() - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
List the directory and stream the entries as the host reports them: memory stays bounded whatever the size of the tree.
- stream() - Method in class org.metricshub.winrm.WqlRequest
-
Execute the query and stream the rows lazily: each row is yielded as soon as it is parsed, and the next WS-Enumeration page is pulled from the server only as the stream advances — memory stays bounded by one page (
WqlRequest.pageSize(int)) instead of the whole result set. - streamWql(String, String, long, int, long) - Method in class org.metricshub.winrm.light.LightWinRMService
- streamWql(String, String, long, int, long) - Method in interface org.metricshub.winrm.WindowsRemoteExecutor
-
Start a WQL enumeration and return a lazy
WqlCursorover its rows: rows can be consumed as the WS-Enumeration pages arrive, and memory stays bounded by one page. - string(String) - Method in class org.metricshub.winrm.WqlRow
-
Get the value of a property as a string.
T
- ticketCache(Path) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the Kerberos ticket cache path.
- timeout(Duration) - Method in class org.metricshub.winrm.CommandRequest
-
Set the timeout of this command.
- timeout(Duration) - Method in class org.metricshub.winrm.RemoteDirectoryListing
-
Override the client's timeout for this request.
- timeout(Duration) - Method in class org.metricshub.winrm.RemoteFile
-
Override the client's timeout for this request.
- timeout(Duration) - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Set the default timeout of every operation — a wall-clock deadline covering authentication, every WSMan round trip, and result collection.
- timeout(Duration) - Method in class org.metricshub.winrm.WqlRequest
-
Set the timeout of this query.
- TimeoutHelper - Class in org.metricshub.winrm
-
for stagged timeout handling.
- toString() - Method in class org.metricshub.winrm.CommandResult
- toString() - Method in class org.metricshub.winrm.RemoteFileInfo
- toString() - Method in class org.metricshub.winrm.RemoteFileList
- toString() - Method in class org.metricshub.winrm.service.WinRMEndpoint
- toString() - Method in class org.metricshub.winrm.WindowsRemoteCommandResult
- toString() - Method in class org.metricshub.winrm.WqlQuery
- toString() - Method in class org.metricshub.winrm.WqlResult
- toString() - Method in class org.metricshub.winrm.WqlRow
- trustAllCertificates() - Method in class org.metricshub.winrm.WinRMClient.Builder
-
Trust every server certificate and skip hostname verification over HTTPS — for self-signed test hosts.
- Type3Message - Class in org.metricshub.winrm.light
-
Type 3 message assembly class Code from io.cloudsoft.winrm4j.client.ntlm.forks.httpclient.NTLMEngineImpl release 0.12.3 @link https://github.com/cloudsoft/winrm4j io.cloudsoft.winrm4j.client.ntlm.forks.httpclient is a fork of apache-httpclient 4.5.13
U
- UNICODE_LITTLE_UNMARKED - Static variable in class org.metricshub.winrm.light.NTLMEngineUtils
-
Unicode encoding
- upload(Path...) - Method in class org.metricshub.winrm.CommandRequest
-
Copy local files to the remote host (through the WinRM connection itself) before running the command.
- uploadFile(Path, String) - Method in class org.metricshub.winrm.WinRMClient
-
Copy a local file to an explicit path on the remote host, through the WinRM connection itself (no SMB, no extra port).
- Utils - Class in org.metricshub.winrm
- Utils() - Constructor for class org.metricshub.winrm.Utils
V
- valueOf(String) - Static method in enum org.metricshub.winrm.AuthScheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.metricshub.winrm.WinRMHttpProtocolEnum
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.metricshub.winrm.AuthScheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.metricshub.winrm.service.client.auth.AuthenticationEnum
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.metricshub.winrm.WinRMHttpProtocolEnum
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- waitFor() - Method in class org.metricshub.winrm.RemoteProcess
-
Wait for the command to complete, buffering any unread output in the meantime (read it afterward from
RemoteProcess.stdout()/RemoteProcess.stderr()). - waitFor(Duration) - Method in class org.metricshub.winrm.RemoteProcess
-
Wait at most the given duration for the command to complete — an overall deadline, on top of the per-response inactivity timeout.
- WindowsRemoteCommandResult - Class in org.metricshub.winrm
-
The result of a command run by the legacy WinRMCommandExecutor: its output, exit code and execution time.
- WindowsRemoteCommandResult(String, String, float, int) - Constructor for class org.metricshub.winrm.WindowsRemoteCommandResult
-
Command Result constructor
- WindowsRemoteException - Exception in org.metricshub.winrm.exceptions
- WindowsRemoteException(String) - Constructor for exception org.metricshub.winrm.exceptions.WindowsRemoteException
- WindowsRemoteException(String, Object...) - Constructor for exception org.metricshub.winrm.exceptions.WindowsRemoteException
- WindowsRemoteException(Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WindowsRemoteException
- WindowsRemoteException(Throwable, String) - Constructor for exception org.metricshub.winrm.exceptions.WindowsRemoteException
- WindowsRemoteException(Throwable, String, Object...) - Constructor for exception org.metricshub.winrm.exceptions.WindowsRemoteException
- WindowsRemoteExecutor - Interface in org.metricshub.winrm
- WindowsRemoteProcessUtils - Class in org.metricshub.winrm
- WindowsTempShare - Class in org.metricshub.winrm
- WindowsTempShare(WindowsRemoteExecutor, String, String) - Constructor for class org.metricshub.winrm.WindowsTempShare
-
Constructor of WindowsTempShare
- WinRMAuthenticationException - Exception in org.metricshub.winrm.exceptions
-
The remote host rejected the credentials (or every authentication scheme of an ordered fallback list).
- WinRMAuthenticationException(String) - Constructor for exception org.metricshub.winrm.exceptions.WinRMAuthenticationException
-
Create the exception with a message.
- WinRmCli - Class in org.metricshub.winrm.cli
-
Command-line interface for WQL queries and remote command execution through WinRM, built on the streaming terminals of the fluent
WinRMClientAPI. - WinRMClient - Class in org.metricshub.winrm
-
The fluent entry point of the library: a reusable WinRM connection to one host, created with a builder and closed with try-with-resources.
- WinRMClient.Builder - Class in org.metricshub.winrm
-
Builder of
WinRMClientinstances: connection-scoped settings with sensible defaults. - WinRMClientException - Exception in org.metricshub.winrm.exceptions
-
Base unchecked exception of the fluent
WinRMClientAPI. - WinRMClientException(String) - Constructor for exception org.metricshub.winrm.exceptions.WinRMClientException
-
Create the exception with a message.
- WinRMClientException(String, Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WinRMClientException
-
Create the exception with a message and the underlying cause.
- WinRMCommandExecutor - Class in org.metricshub.winrm.command
- WinRMEndpoint - Class in org.metricshub.winrm.service
- WinRMEndpoint(WinRMHttpProtocolEnum, String, Integer, String, char[], String) - Constructor for class org.metricshub.winrm.service.WinRMEndpoint
-
Constructor of the endpoint and credentials for WinRM.
- WinRMException - Exception in org.metricshub.winrm.exceptions
- WinRMException(String) - Constructor for exception org.metricshub.winrm.exceptions.WinRMException
- WinRMException(String, Object...) - Constructor for exception org.metricshub.winrm.exceptions.WinRMException
- WinRMException(Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WinRMException
- WinRMException(Throwable, String) - Constructor for exception org.metricshub.winrm.exceptions.WinRMException
- WinRMExecutorFactory - Class in org.metricshub.winrm.service
-
Creates the
WindowsRemoteExecutorthat fulfils a request. - WinRMFaultException - Exception in org.metricshub.winrm.exceptions
-
The remote WinRM service answered with a WSMan fault (or a non-success HTTP status).
- WinRMFaultException(String, int, String, String, String) - Constructor for exception org.metricshub.winrm.exceptions.WinRMFaultException
-
Create the exception.
- WinRMHttpProtocolEnum - Enum in org.metricshub.winrm
-
Enumeration for protocol to use.
- WinRMTimeoutException - Exception in org.metricshub.winrm.exceptions
-
The operation did not complete within its timeout — the whole operation is bounded by a wall-clock deadline, covering authentication, every WSMan round trip, and result collection.
- WinRMTimeoutException(String, Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WinRMTimeoutException
-
Create the exception with a message and the underlying cause.
- WinRMWqlExecutor - Class in org.metricshub.winrm.wql
- WinRMWqlExecutor(long, List<String>, List<List<String>>) - Constructor for class org.metricshub.winrm.wql.WinRMWqlExecutor
-
The WinRMWqlExecutor constructor
- WmiHelper - Class in org.metricshub.winrm
- workingDirectory(String) - Method in class org.metricshub.winrm.CommandRequest
-
Set the working directory of the remote process.
- wql(String) - Method in class org.metricshub.winrm.WinRMClient
-
Prepare a WQL query.
- WqlCursor - Interface in org.metricshub.winrm
-
A lazily-advancing cursor over the rows of a WQL enumeration, returned by
WindowsRemoteExecutor.streamWql(String, String, long, int, long). - WqlQuery - Class in org.metricshub.winrm
- WqlQuerySyntaxException - Exception in org.metricshub.winrm.exceptions
-
Exception for a syntax error in the WQL Query parameter.
- WqlQuerySyntaxException(String) - Constructor for exception org.metricshub.winrm.exceptions.WqlQuerySyntaxException
- WqlQuerySyntaxException(Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WqlQuerySyntaxException
- WqlRequest - Class in org.metricshub.winrm
-
A WQL query being prepared for execution, created by
WinRMClient.wql(String). - WqlResult - Class in org.metricshub.winrm
-
The complete result of a WQL query: the rows, the column names in query order, and the time the query took.
- WqlRow - Class in org.metricshub.winrm
-
One row of a WQL query result: an immutable, ordered view of the instance properties.
- WqlSyntaxException - Exception in org.metricshub.winrm.exceptions
-
The WQL query is syntactically invalid — the unchecked counterpart of the legacy
WqlQuerySyntaxException, thrown by the fluentWinRMClientAPI before anything is sent to the remote host. - WqlSyntaxException(String, Throwable) - Constructor for exception org.metricshub.winrm.exceptions.WqlSyntaxException
-
Create the exception with a message and the underlying cause.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
CodeSetis the remote machine's ANSI code page, whilecmd.exewrites its output in the console (OEM) code page — the two differ on every non-English locale. Command output is now decoded withWindowsRemoteExecutor.SHELL_OUTPUT_CHARSET, the code page the remote shell is created with. Use this method only to decode data that a Windows application genuinely wrote in the ANSI code page.