com.suse.salt.netapi.calls

Class WheelCall<R>

java.lang.Object

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

Type Parameters:

R - the return type of the called function

All Implemented Interfaces:

Call<R>

public class WheelCall<R>
extends Object
implements Call<R>

Class representing a function call of a salt wheel module.

Constructor Summary

Constructors

Constructor and Description
WheelCall(String functionName, Optional<Map<String,?>> kwargs, com.google.gson.reflect.TypeToken<R> returnType)

Method Summary

Modifier and Type	Method and Description
WheelAsyncResult<R>	callAsync(SaltClient client) Calls a wheel module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
WheelAsyncResult<R>	callAsync(SaltClient client, String username, String password, AuthModule authModule) Calls a wheel module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
WheelResult<R>	callSync(SaltClient client) Calls a wheel module function on the master and synchronously waits for the result.
WheelResult<R>	callSync(SaltClient client, String username, String password, AuthModule authModule) Calls a wheel module function on the master and synchronously waits for the result.
Map<String,Object>	getPayload() Return the call payload as a map of key/value pairs.
com.google.gson.reflect.TypeToken<R>	getReturnType()

Methods inherited from class java.lang.Object

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

Constructor Detail

WheelCall

public WheelCall(String functionName,
                 Optional<Map<String,?>> kwargs,
                 com.google.gson.reflect.TypeToken<R> returnType)

Method Detail

getReturnType

public com.google.gson.reflect.TypeToken<R> getReturnType()

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.

Specified by:

getPayload in interface Call<R>

Returns:

call payload as a map of key/value pairs

callAsync

public WheelAsyncResult<R> callAsync(SaltClient client)
                              throws SaltException

Calls a wheel module function on the master 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

Returns:

information about the scheduled job

Throws:

SaltException - if anything goes wrong

callAsync

public WheelAsyncResult<R> callAsync(SaltClient client,
                                     String username,
                                     String password,
                                     AuthModule authModule)
                              throws SaltException

Calls a wheel module function on the master 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

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 WheelResult<R> callSync(SaltClient client)
                        throws SaltException

Calls a wheel module function on the master 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

Returns:

the result of the called function

Throws:

SaltException - if anything goes wrong

callSync

public WheelResult<R> callSync(SaltClient client,
                               String username,
                               String password,
                               AuthModule authModule)
                        throws SaltException

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

Parameters:

client - SaltClient instance

username - username for authentication

password - password for authentication

authModule - authentication module to use

Returns:

the result of the called function

Throws:

SaltException - if anything goes wrong