org.mule.extension.powershell.internal.operation

Class PowershellOperations

java.lang.Object

org.mule.connectors.commons.template.operation.ConnectorOperations<PowershellConfiguration,PowershellConnection,PowershellService>

org.mule.extension.powershell.internal.operation.PowershellOperations

@Throws(value=PowershellErrorTypeProvider.class)
public class PowershellOperations
extends org.mule.connectors.commons.template.operation.ConnectorOperations<PowershellConfiguration,PowershellConnection,PowershellService>

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_OF_LOGGING
static String	LINE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PowershellOperations()

Method Summary

Modifier and Type	Method and Description
String	executeCommand(PowershellConfiguration config, PowershellConnection connection, String command) This operation executes the command on the machine.
String	executeCommandExceptionHandlingEnabled(PowershellConfiguration config, PowershellConnection connection, String command) This operation executes the command on the target machine and throws Powershell related exceptions if any.
String	executeScriptFile(PowershellConfiguration config, PowershellConnection connection, InputStream fileContent, Map<String,String> parameters) This operation executes the script file.
String	executeScriptFileWithExceptionHandling(PowershellConfiguration config, PowershellConnection connection, InputStream fileContent, Map<String,String> parameters) This operation executes the script file and throws Powershell related exceptions if any.

Methods inherited from class org.mule.connectors.commons.template.operation.ConnectorOperations

newExecutionBuilder

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

public static final String LINE_SEPARATOR

END_OF_LOGGING

public static final String END_OF_LOGGING

See Also:

Constant Field Values

Constructor Detail

PowershellOperations

public PowershellOperations()

Method Detail

executeScriptFile

@MediaType(value="text/plain")
 @Summary(value="This operation executes the script file.")
public String executeScriptFile(@Config
                                                                                                                           PowershellConfiguration config,
                                                                                                                           @Connection
                                                                                                                           PowershellConnection connection,
                                                                                                                           @Content @Summary(value="The file which contains the script.")
                                                                                                                           InputStream fileContent,
                                                                                                                           @Optional
                                                                                                                           Map<String,String> parameters)

This operation executes the script file.

Parameters:

config - PowerShell Configuration

connection - Connection for the Powershell.

fileContent - The file which contains the script.

parameters - The Parameters for the Script.

Returns:

The Response of the Script file.

executeScriptFileWithExceptionHandling

@MediaType(value="text/plain")
 @DisplayName(value="Execute script file (exception handling enabled)")
 @Summary(value="This operation executes the script file and throws Powershell related exceptions if any.")
public String executeScriptFileWithExceptionHandling(@Config
                                                                                                                                                                                                                                                                        PowershellConfiguration config,
                                                                                                                                                                                                                                                                        @Connection
                                                                                                                                                                                                                                                                        PowershellConnection connection,
                                                                                                                                                                                                                                                                        @Content @Summary(value="The file which contains the script.")
                                                                                                                                                                                                                                                                        InputStream fileContent,
                                                                                                                                                                                                                                                                        @Optional
                                                                                                                                                                                                                                                                        Map<String,String> parameters)

This operation executes the script file and throws Powershell related exceptions if any.

Parameters:

config - Powershell Configuration

connection - Connection for the PowerShell.

fileContent - The file which contains the script.

parameters - The Parameters for the Script.

Returns:

The Response of the Script file.

executeCommand

@MediaType(value="text/plain")
 @Summary(value="This operation executes the command on the machine.")
public String executeCommand(@Config
                                                                                                                                   PowershellConfiguration config,
                                                                                                                                   @Connection
                                                                                                                                   PowershellConnection connection,
                                                                                                                                   String command)

This operation executes the command on the machine.

Parameters:

config - PowerShell configuration

connection - Connection for the Powershell.

command - The command to Execute on the client machine.

Returns:

The response of the command.

executeCommandExceptionHandlingEnabled

@MediaType(value="text/plain")
 @DisplayName(value="Execute command (exception handling enabled)")
 @Summary(value="This operation executes the command on the target machine and throws powershell related\nexceptions if any.")
public String executeCommandExceptionHandlingEnabled(@Config
                                                                                                                                                                                                                                                                                       PowershellConfiguration config,
                                                                                                                                                                                                                                                                                       @Connection
                                                                                                                                                                                                                                                                                       PowershellConnection connection,
                                                                                                                                                                                                                                                                                       String command)

This operation executes the command on the target machine and throws Powershell related exceptions if any.

Parameters:

config - PowerShell configuration

connection - Connection for the Powershell.

command - The command to Execute on the client machine.

Returns:

The response of the command.