Package com.vonage.client.auth

Class ApiKeyQueryParamsAuthMethod

java.lang.Object

com.vonage.client.auth.AbstractAuthMethod

com.vonage.client.auth.ApiKeyQueryParamsAuthMethod

All Implemented Interfaces:

ApiKeyAuthMethod, AuthMethod, QueryParamsAuthMethod, Comparable<AuthMethod>

public class ApiKeyQueryParamsAuthMethod
extends AbstractAuthMethod

API key and secret in query parameters.

Since:

8.8.0

Constructor Summary

Constructors

Constructor	Description
ApiKeyQueryParamsAuthMethod(String apiKey, String apiSecret)

Method Summary

Modifier and Type	Method	Description
BasicAuthMethod	asBasicHeader()	Converts this to a BasicAuthMethod.
String	getApiKey()
Map<String,String>	getAuthParams(RequestQueryParams requestParams)	Gets the auth parameters to be included in the query string.
int	getSortKey()

Methods inherited from class com.vonage.client.auth.AbstractAuthMethod

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.auth.AuthMethod

compareTo

Constructor Details

ApiKeyQueryParamsAuthMethod

public ApiKeyQueryParamsAuthMethod(String apiKey,
 String apiSecret)

Method Details

asBasicHeader

public BasicAuthMethod asBasicHeader()

Converts this to a BasicAuthMethod.

Returns:

A new ApiKeyHeaderAuthMethod with this object's API key and secret.

getAuthParams

public Map<String,String> getAuthParams(RequestQueryParams requestParams)

Description copied from interface: QueryParamsAuthMethod

Gets the auth parameters to be included in the query string.

Specified by:

getAuthParams in interface QueryParamsAuthMethod

Parameters:

requestParams - List of existing request parameters, which may be used in the computation.

Returns:

A new Map containing only the authentication parameters.

getSortKey

public int getSortKey()

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface ApiKeyAuthMethod