com.nexmo.client.verify.endpoints

Class VerifyEndpoint

java.lang.Object

com.nexmo.client.voice.endpoints.AbstractMethod<VerifyRequest,VerifyResult>

com.nexmo.client.verify.endpoints.VerifyEndpoint

All Implemented Interfaces:

Method<VerifyRequest,VerifyResult>

public class VerifyEndpoint
extends AbstractMethod<VerifyRequest,VerifyResult>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class[]	getAcceptableAuthMethods()
org.apache.http.client.methods.RequestBuilder	makeRequest(VerifyRequest request) Construct and return a RequestBuilder instance from the provided request.
VerifyResult	parseResponse(org.apache.http.HttpResponse response) Construct a ResultT representing the contents of the HTTP response returned from the Nexmo Voice API.
protected VerifyResult	parseVerifyResponse(java.lang.String response)
VerifyResult	verify(java.lang.String number, java.lang.String brand)
VerifyResult	verify(java.lang.String number, java.lang.String brand, java.lang.String from)
VerifyResult	verify(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale)
VerifyResult	verify(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale, VerifyRequest.LineType type)
VerifyResult	verify(VerifyRequest 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

VerifyEndpoint

public VerifyEndpoint(HttpWrapper httpWrapper)

Create a new VerifyEndpoint.

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

Method Detail

getAcceptableAuthMethods

protected java.lang.Class[] getAcceptableAuthMethods()

Specified by:

getAcceptableAuthMethods in class AbstractMethod<VerifyRequest,VerifyResult>

makeRequest

public org.apache.http.client.methods.RequestBuilder makeRequest(VerifyRequest 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<VerifyRequest,VerifyResult>

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 VerifyResult 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<VerifyRequest,VerifyResult>

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

verify

public VerifyResult verify(java.lang.String number,
                           java.lang.String brand)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

verify

public VerifyResult verify(java.lang.String number,
                           java.lang.String brand,
                           java.lang.String from)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

verify

public VerifyResult verify(java.lang.String number,
                           java.lang.String brand,
                           java.lang.String from,
                           int length,
                           java.util.Locale locale)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

verify

public VerifyResult verify(java.lang.String number,
                           java.lang.String brand,
                           java.lang.String from,
                           int length,
                           java.util.Locale locale,
                           VerifyRequest.LineType type)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

verify

public VerifyResult verify(VerifyRequest request)
                    throws java.io.IOException,
                           NexmoClientException

Throws:

java.io.IOException

NexmoClientException

parseVerifyResponse

protected VerifyResult parseVerifyResponse(java.lang.String response)
                                    throws NexmoResponseParseException

Throws:

NexmoResponseParseException