Package org.sentrysoftware.winrm.service

Class WinRMService

java.lang.Object

org.sentrysoftware.winrm.service.WinRMService

All Implemented Interfaces:

AutoCloseable, WindowsRemoteExecutor

public class WinRMService
extends Object
implements WindowsRemoteExecutor

Field Summary

Fields

Modifier and Type	Field	Description
static final List<AuthenticationEnum>	DEFAULT_AUTHENTICATION

Method Summary

Modifier and Type	Method	Description
void	checkConnectedFirst()	Check if it's connected.
void	close()
ResourceCreated	create(String workingDirectory)
static WinRMService	createInstance(WinRMEndpoint winRMEndpoint, long timeout, Path ticketCache, List<AuthenticationEnum> authentications)	Create a WinRMService instance
static WinRMInvocationHandler	createWinRMInvocationHandlerInstance(WinRMEndpoint winRMEndpoint, org.apache.cxf.Bus bus, long timeout, String resourceUri, Path ticketCache, List<AuthenticationEnum> authentications)
EnumerateResponse	enumerate(String wqlQuery)
int	execute(String command, Writer out, Writer err, Charset charset)
WindowsRemoteCommandResult	executeCommand(String command, String workingDirectory, Charset charset, long timeout)	Execute the command on the remote
List<Map<String,Object>>	executeWql(String wqlQuery, long timeout)	Execute a WQL query and process its result.
String	getContextIdFrom(EnumerationContextType context)
String	getHostname()	Get the hostname.
boolean	getItemsFrom(EnumerateResponse response, List<Node> items)	Retrieves the list of items from the given response, adding them to the given list and returns true if the response contains an 'end-of-sequence' marker.
char[]	getPassword()	Get the password.
SelectorSetType	getShellSelector()
int	getUseCount()
String	getUsername()	Get the username.
boolean	isConnected()
String	pull(String contextId, List<Node> nodes)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_AUTHENTICATION

public static final List<AuthenticationEnum> DEFAULT_AUTHENTICATION

Method Details

createInstance

public static WinRMService createInstance(WinRMEndpoint winRMEndpoint,
 long timeout,
 Path ticketCache,
 List<AuthenticationEnum> authentications)
                                   throws WinRMException

Create a WinRMService instance

Parameters:

winRMEndpoint - Endpoint with credentials (mandatory)

timeout - Timeout used for Connection, Connection Request and Receive Request in milliseconds (throws an IllegalArgumentException if negative or zero)

ticketCache - The Ticket Cache path

authentications - List of authentications. only NTLM if absent

Returns:

WinRMService instance

Throws:

WinRMException - For any problem encountered

getUseCount

public int getUseCount()

isConnected

public boolean isConnected()

Returns:

whether this WbemServices instance is connected and usable

checkConnectedFirst

public void checkConnectedFirst()

Check if it's connected. If not, throw an IllegalStateException.

close

public void close()

Specified by:

close in interface AutoCloseable

executeCommand

public WindowsRemoteCommandResult executeCommand(String command,
 String workingDirectory,
 Charset charset,
 long timeout)
                                          throws WinRMException,
TimeoutException

Description copied from interface: WindowsRemoteExecutor

Execute the command on the remote

Specified by:

executeCommand in interface WindowsRemoteExecutor

Parameters:

command - The command to execute

workingDirectory - Path of the directory for the spawned process on the remote system (can be null)

charset - The charset

timeout - Timeout in milliseconds

Returns:

The command result

Throws:

TimeoutException - To notify userName of timeout.

WinRMException

executeWql

public List<Map<String,Object>> executeWql(String wqlQuery,
 long timeout)
                                    throws WinRMException,
WqlQuerySyntaxException,
TimeoutException

Description copied from interface: WindowsRemoteExecutor

Execute a WQL query and process its result.

Specified by:

executeWql in interface WindowsRemoteExecutor

Parameters:

wqlQuery - the WQL query (required)

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

Returns:

a list of result rows. A result row is a Map(LinkedHashMap to preserve the query order) of properties/values.

Throws:

WqlQuerySyntaxException - if WQL query syntax is invalid

TimeoutException - to notify userName of timeout.

WinRMException

createWinRMInvocationHandlerInstance

public static WinRMInvocationHandler createWinRMInvocationHandlerInstance(WinRMEndpoint winRMEndpoint,
 org.apache.cxf.Bus bus,
 long timeout,
 String resourceUri,
 Path ticketCache,
 List<AuthenticationEnum> authentications)

enumerate

public EnumerateResponse enumerate(String wqlQuery)

pull

public String pull(String contextId,
 List<Node> nodes)
            throws WinRMException

Throws:

WinRMException

create

public ResourceCreated create(String workingDirectory)

execute

public int execute(String command,
 Writer out,
 Writer err,
 Charset charset)
            throws WinRMException

Throws:

WinRMException

getItemsFrom

public boolean getItemsFrom(EnumerateResponse response,
 List<Node> items)
                     throws WinRMException

Retrieves the list of items from the given response, adding them to the given list and returns true if the response contains an 'end-of-sequence' marker.

Throws:

WinRMException

getContextIdFrom

public String getContextIdFrom(EnumerationContextType context)
                        throws WinRMException

Throws:

WinRMException

getShellSelector

public SelectorSetType getShellSelector()

getHostname

public String getHostname()

Description copied from interface: WindowsRemoteExecutor

Get the hostname.

Specified by:

getHostname in interface WindowsRemoteExecutor

Returns:

getUsername

public String getUsername()

Description copied from interface: WindowsRemoteExecutor

Get the username.

Specified by:

getUsername in interface WindowsRemoteExecutor

Returns:

getPassword

public char[] getPassword()

Description copied from interface: WindowsRemoteExecutor

Get the password.

Specified by:

getPassword in interface WindowsRemoteExecutor

Returns: