com.suse.salt.netapi.calls

Class LocalCall<R>

java.lang.Object

com.suse.salt.netapi.calls.AbstractCall<R>

com.suse.salt.netapi.calls.LocalCall<R>

Type Parameters:

R - the return type of the called function

All Implemented Interfaces:

Call<R>

public class LocalCall<R>
extends AbstractCall<R>

Class representing a function call of a salt execution module.

Constructor Summary

Constructors

Constructor and Description
LocalCall(String functionName, Optional<List<?>> arg, Optional<Map<String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType)
LocalCall(String functionName, Optional<List<?>> arg, Optional<Map<String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, Optional<?> metadata)
LocalCall(String functionName, Optional<List<?>> arg, Optional<Map<String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, Optional<?> metadata, Optional<Integer> timeout, Optional<Integer> gatherJobTimeout)
LocalCall(String functionName, Optional<List<?>> arg, Optional<Map<String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, Optional<Integer> timeout, Optional<Integer> gatherJobTimeout)

Method Summary

Modifier and Type	Method and Description
Map<String,CompletionStage<Result<R>>>	callAsync(FunctionE<LocalCall<R>,LocalAsyncResult<R>> localAsync, FunctionE<RunnerCall<Map<String,R>>,RunnerAsyncResult<Map<String,R>>> runnerAsync, EventStream events, CompletionStage<GenericError> cancel) Calls this salt call via the async client and returns the results as they come in via the event stream.
LocalAsyncResult<R>	callAsync(SaltClient client, Target<?> target) Calls a execution module function on the given target asynchronously and returns information about the scheduled job that can be used to query the result.
Map<String,CompletionStage<Result<R>>>	callAsync(SaltClient client, Target<?> target, EventStream events, CompletionStage<GenericError> cancel) Calls this salt call via the async client and returns the results as they come in via the event stream.
LocalAsyncResult<R>	callAsync(SaltClient client, Target<?> target, String username, String password, AuthModule authModule) Calls a execution module function on the given target asynchronously and returns information about the scheduled job that can be used to query the result.
Map<String,CompletionStage<Result<R>>>	callAsync(SaltClient client, Target<?> target, String username, String password, AuthModule authModule, EventStream events, CompletionStage<GenericError> cancel) Calls this salt call via the async client and returns the results as they come in via the event stream.
Map<String,Result<R>>	callSync(SaltClient client, Target<?> target) Calls a execution module function on the given target and synchronously waits for the result.
List<Map<String,Result<R>>>	callSync(SaltClient client, Target<?> target, Batch batch) Calls a execution module function on the given target with batching and synchronously waits for the result.
Map<String,Result<R>>	callSync(SaltClient client, Target<?> target, String username, String password, AuthModule authModule) Calls a execution module function on the given target and synchronously waits for the result.
List<Map<String,Result<R>>>	callSync(SaltClient client, Target<?> target, String username, String password, AuthModule authModule, Batch batch) Calls a execution module function on the given target with batching and synchronously waits for the result.
Map<String,Result<SSHResult<R>>>	callSyncSSH(SaltClient client, SSHTarget<?> target, SaltSSHConfig cfg) Call an execution module function on the given target via salt-ssh and synchronously wait for the result.
Map<String,Object>	getPayload() Return the call payload as a map of key/value pairs.
LocalCall<R>	withMetadata(Object metadata)
LocalCall<R>	withoutMetadata()
LocalCall<R>	withoutTimeouts()
LocalCall<R>	withTimeouts(Optional<Integer> timeout, Optional<Integer> gatherJobTimeout)

Methods inherited from class com.suse.salt.netapi.calls.AbstractCall

getFunctionName, getModuleName, getReturnType

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCall

public LocalCall(String functionName,
                 Optional<List<?>> arg,
                 Optional<Map<String,?>> kwarg,
                 com.google.gson.reflect.TypeToken<R> returnType,
                 Optional<?> metadata,
                 Optional<Integer> timeout,
                 Optional<Integer> gatherJobTimeout)

LocalCall

public LocalCall(String functionName,
                 Optional<List<?>> arg,
                 Optional<Map<String,?>> kwarg,
                 com.google.gson.reflect.TypeToken<R> returnType,
                 Optional<Integer> timeout,
                 Optional<Integer> gatherJobTimeout)

LocalCall

public LocalCall(String functionName,
                 Optional<List<?>> arg,
                 Optional<Map<String,?>> kwarg,
                 com.google.gson.reflect.TypeToken<R> returnType,
                 Optional<?> metadata)

LocalCall

public LocalCall(String functionName,
                 Optional<List<?>> arg,
                 Optional<Map<String,?>> kwarg,
                 com.google.gson.reflect.TypeToken<R> returnType)

Method Detail

withMetadata

public LocalCall<R> withMetadata(Object metadata)

withoutMetadata

public LocalCall<R> withoutMetadata()

withTimeouts

public LocalCall<R> withTimeouts(Optional<Integer> timeout,
                                 Optional<Integer> gatherJobTimeout)

withoutTimeouts

public LocalCall<R> withoutTimeouts()

getPayload

public Map<String,Object> getPayload()

Return the call payload as a map of key/value pairs. Usually this contains the function name and arguments, but the various clients differ in the details.

Returns:

call payload as a map of key/value pairs

callAsync

public LocalAsyncResult<R> callAsync(SaltClient client,
                                     Target<?> target)
                              throws SaltException

Calls a execution module function on the given target asynchronously and returns information about the scheduled job that can be used to query the result. Authentication is done with the token therefore you have to login prior to using this function.

Parameters:

client - SaltClient instance

target - the target for the function

Returns:

information about the scheduled job

Throws:

SaltException - if anything goes wrong

callAsync

public Map<String,CompletionStage<Result<R>>> callAsync(SaltClient client,
                                                        Target<?> target,
                                                        String username,
                                                        String password,
                                                        AuthModule authModule,
                                                        EventStream events,
                                                        CompletionStage<GenericError> cancel)
                                                 throws SaltException

Calls this salt call via the async client and returns the results as they come in via the event stream.

Parameters:

client - SaltClient instance

target - the target for the function

username - username for authentication

password - password for authentication

authModule - authentication module to use

events - the event stream to use

cancel - future to cancel the action

Returns:

a map from minion id to future of the result.

Throws:

SaltException - if anything goes wrong

callAsync

public Map<String,CompletionStage<Result<R>>> callAsync(SaltClient client,
                                                        Target<?> target,
                                                        EventStream events,
                                                        CompletionStage<GenericError> cancel)
                                                 throws SaltException

Calls this salt call via the async client and returns the results as they come in via the event stream.

Parameters:

client - SaltClient instance

target - the target for the function

events - the event stream to use

cancel - future to cancel the action

Returns:

a map from minion id to future of the result.

Throws:

SaltException - if anything goes wrong

callAsync

public Map<String,CompletionStage<Result<R>>> callAsync(FunctionE<LocalCall<R>,LocalAsyncResult<R>> localAsync,
                                                        FunctionE<RunnerCall<Map<String,R>>,RunnerAsyncResult<Map<String,R>>> runnerAsync,
                                                        EventStream events,
                                                        CompletionStage<GenericError> cancel)
                                                 throws SaltException

Calls this salt call via the async client and returns the results as they come in via the event stream.

Parameters:

localAsync - function providing callAsync for LocalCalls

runnerAsync - function providing callAsync for RunnerCalls

events - the event stream to use

cancel - future to cancel the action

Returns:

a map from minion id to future of the result.

Throws:

SaltException - if anything goes wrong

callAsync

public LocalAsyncResult<R> callAsync(SaltClient client,
                                     Target<?> target,
                                     String username,
                                     String password,
                                     AuthModule authModule)
                              throws SaltException

Calls a execution module function on the given target asynchronously and returns information about the scheduled job that can be used to query the result. Authentication is done with the given credentials no session token is created.

Parameters:

client - SaltClient instance

target - the target for the function

username - username for authentication

password - password for authentication

authModule - authentication module to use

Returns:

information about the scheduled job

Throws:

SaltException - if anything goes wrong

callSync

public Map<String,Result<R>> callSync(SaltClient client,
                                      Target<?> target)
                               throws SaltException

Calls a execution module function on the given target and synchronously waits for the result. Authentication is done with the token therefore you have to login prior to using this function.

Parameters:

client - SaltClient instance

target - the target for the function

Returns:

a map containing the results with the minion name as key

Throws:

SaltException - if anything goes wrong

callSync

public List<Map<String,Result<R>>> callSync(SaltClient client,
                                            Target<?> target,
                                            Batch batch)
                                     throws SaltException

Calls a execution module function on the given target with batching and synchronously waits for the result. Authentication is done with the token therefore you have to login prior to using this function.

Parameters:

client - SaltClient instance

target - the target for the function

batch - the batch specification

Returns:

A list of maps with each list representing each batch, and maps containing the results with the minion names as keys.

Throws:

SaltException - if anything goes wrong

callSync

public Map<String,Result<R>> callSync(SaltClient client,
                                      Target<?> target,
                                      String username,
                                      String password,
                                      AuthModule authModule)
                               throws SaltException

Calls a execution module function on the given target and synchronously waits for the result. Authentication is done with the given credentials no session token is created.

Parameters:

client - SaltClient instance

target - the target for the function

username - username for authentication

password - password for authentication

authModule - authentication module to use

Returns:

a map containing the results with the minion name as key

Throws:

SaltException - if anything goes wrong

callSync

public List<Map<String,Result<R>>> callSync(SaltClient client,
                                            Target<?> target,
                                            String username,
                                            String password,
                                            AuthModule authModule,
                                            Batch batch)
                                     throws SaltException

Calls a execution module function on the given target with batching and synchronously waits for the result. Authentication is done with the given credentials no session token is created.

Parameters:

client - SaltClient instance

target - the target for the function

username - username for authentication

password - password for authentication

authModule - authentication module to use

batch - the batch specification

Returns:

A list of maps with each list representing each batch, and maps containing the results with the minion names as keys.

Throws:

SaltException - if anything goes wrong

callSyncSSH

public Map<String,Result<SSHResult<R>>> callSyncSSH(SaltClient client,
                                                    SSHTarget<?> target,
                                                    SaltSSHConfig cfg)
                                             throws SaltException

Call an execution module function on the given target via salt-ssh and synchronously wait for the result.

Parameters:

client - SaltClient instance

target - the target for the function

cfg - Salt SSH configuration object

Returns:

a map containing the results with the minion name as key

Throws:

SaltException - if anything goes wrong