com.nexmo.client.verify.endpoints

Class SearchEndpoint

java.lang.Object

com.nexmo.client.voice.endpoints.AbstractMethod<SearchRequest,SearchResult[]>

com.nexmo.client.verify.endpoints.SearchEndpoint

All Implemented Interfaces:

Method<SearchRequest,SearchResult[]>

public class SearchEndpoint
extends AbstractMethod<SearchRequest,SearchResult[]>

Constructor Summary

Constructors

Constructor and Description
SearchEndpoint(HttpWrapper httpWrapper) Create a new SearchEndpoint.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class[]	getAcceptableAuthMethods()
org.apache.http.client.methods.RequestBuilder	makeRequest(SearchRequest request) Construct and return a RequestBuilder instance from the provided request.
protected static SearchResult.VerifyCheck	parseCheckXmlNode(org.w3c.dom.Element root)
SearchResult[]	parseResponse(org.apache.http.HttpResponse response) Construct a ResultT representing the contents of the HTTP response returned from the Nexmo Voice API.
protected SearchResult[]	parseSearchResponse(java.lang.String response)
protected static SearchResult	parseVerifyRequestXmlNode(org.w3c.dom.Element root)
SearchResult[]	search(java.lang.String... requestIds)
SearchResult	search(java.lang.String requestId)

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

SearchEndpoint

public SearchEndpoint(HttpWrapper httpWrapper)

Create a new SearchEndpoint.

This client is used for calling the verify API's search endpoint.

Method Detail

getAcceptableAuthMethods

protected java.lang.Class[] getAcceptableAuthMethods()

Specified by:

getAcceptableAuthMethods in class AbstractMethod<SearchRequest,SearchResult[]>

makeRequest

public org.apache.http.client.methods.RequestBuilder makeRequest(SearchRequest 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<SearchRequest,SearchResult[]>

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 SearchResult[] 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<SearchRequest,SearchResult[]>

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

search

public SearchResult search(java.lang.String requestId)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

search

public SearchResult[] search(java.lang.String... requestIds)
                      throws java.io.IOException,
                             NexmoClientException

Throws:

java.io.IOException

NexmoClientException

parseSearchResponse

protected SearchResult[] parseSearchResponse(java.lang.String response)
                                      throws NexmoResponseParseException

Throws:

NexmoResponseParseException

parseVerifyRequestXmlNode

protected static SearchResult parseVerifyRequestXmlNode(org.w3c.dom.Element root)
                                                 throws NexmoResponseParseException

Throws:

NexmoResponseParseException

parseCheckXmlNode

protected static SearchResult.VerifyCheck parseCheckXmlNode(org.w3c.dom.Element root)
                                                     throws NexmoResponseParseException

Throws:

NexmoResponseParseException