com.nexmo.client.numbers

Class SearchNumbersEndpoint

java.lang.Object

com.nexmo.client.voice.endpoints.AbstractMethod<SearchNumbersFilter,SearchNumbersResponse>

com.nexmo.client.numbers.SearchNumbersEndpoint

All Implemented Interfaces:

Method<SearchNumbersFilter,SearchNumbersResponse>

public class SearchNumbersEndpoint
extends AbstractMethod<SearchNumbersFilter,SearchNumbersResponse>

Internal class, representing the Nexmo API endpoint which can be used to search for available virtual numbers to buy.

Use NumbersClient.searchNumbers instead of this class directly.

Constructor Summary

Constructors

Constructor and Description
SearchNumbersEndpoint(HttpWrapper httpWrapper)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class[]	getAcceptableAuthMethods()
org.apache.http.client.methods.RequestBuilder	makeRequest(SearchNumbersFilter request) Construct and return a RequestBuilder instance from the provided request.
SearchNumbersResponse	parseResponse(org.apache.http.HttpResponse response) Construct a ResultT representing the contents of the HTTP response returned from the Nexmo Voice API.
SearchNumbersResponse	searchNumbers(SearchNumbersFilter request)

Methods inherited from class com.nexmo.client.voice.endpoints.AbstractMethod

applyAuth, execute, getAuthMethod, setHttpClient

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchNumbersEndpoint

public SearchNumbersEndpoint(HttpWrapper httpWrapper)

Method Detail

getAcceptableAuthMethods

protected java.lang.Class[] getAcceptableAuthMethods()

Specified by:

getAcceptableAuthMethods in class AbstractMethod<SearchNumbersFilter,SearchNumbersResponse>

makeRequest

public org.apache.http.client.methods.RequestBuilder makeRequest(SearchNumbersFilter request)
                                                          throws NexmoClientException,
                                                                 java.io.UnsupportedEncodingException

Description copied from class: AbstractMethod

Construct and return a RequestBuilder instance from the provided request.

Specified by:

makeRequest in class AbstractMethod<SearchNumbersFilter,SearchNumbersResponse>

Parameters:

request - A RequestT representing input to the REST call to be made

Returns:

A ResultT representing the response from the executed REST call

Throws:

NexmoClientException - if a problem is encountered constructing the request or response.

java.io.UnsupportedEncodingException - if UTF-8 encoding is not supported by the JVM

parseResponse

public SearchNumbersResponse parseResponse(org.apache.http.HttpResponse response)
                                    throws java.io.IOException

Description copied from class: AbstractMethod

Construct a ResultT representing the contents of the HTTP response returned from the Nexmo Voice API.

Specified by:

parseResponse in class AbstractMethod<SearchNumbersFilter,SearchNumbersResponse>

Parameters:

response - An HttpResponse returned from the Nexmo Voice API

Returns:

A ResultT type representing the result of the REST call

Throws:

java.io.IOException - if a problem occurs parsing the response

searchNumbers

public SearchNumbersResponse searchNumbers(SearchNumbersFilter request)
                                    throws java.io.IOException,
                                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException