com.nexmo.client.voice.endpoints.AbstractMethod Maven / Gradle / Ivy
Show all versions of client Show documentation
/*
* Copyright (c) 2011-2017 Nexmo Inc
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.nexmo.client.voice.endpoints;
import com.nexmo.client.HttpWrapper;
import com.nexmo.client.NexmoClientException;
import com.nexmo.client.NexmoMethodFailedException;
import com.nexmo.client.NexmoUnexpectedException;
import com.nexmo.client.auth.AuthMethod;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.http.HttpEntity;
import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.util.EntityUtils;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.HashSet;
import java.util.Set;
/**
* Abstract class to assist in implementing a call against a REST endpoint.
*
* Concrete implementations must implement {@link #makeRequest(Object)} to construct a {@link RequestBuilder} from the
* provided parameterized request object, and {@link #parseResponse(HttpResponse)} to construct the parameterized
* {@link HttpResponse} object.
*
* The REST call is executed by calling {@link #execute(Object)}.
*
* @param The type of the method-specific request object that will be used to construct an HTTP request
* @param The type of method-specific response object which will be constructed from the returned
* HTTP response
*/
public abstract class AbstractMethod implements Method {
private static final Log LOG = LogFactory.getLog(AbstractMethod.class);
private final HttpWrapper httpWrapper;
private Set acceptable;
public AbstractMethod(HttpWrapper httpWrapper) {
this.httpWrapper = httpWrapper;
}
/**
* Execute the REST call represented by this method object.
*
* @param request A RequestT representing input to the REST call to be made
* @return A ResultT representing the response from the executed REST call
* @throws IOException if an exception occurs making the REST call
* @throws NexmoClientException if there is a problem parsing the HTTP response
*/
// TODO: Consider wrapping IOException in a nexmo-specific transport exception.
public ResultT execute(RequestT request) throws IOException, NexmoClientException {
try {
RequestBuilder requestBuilder = applyAuth(makeRequest(request));
HttpUriRequest httpRequest = requestBuilder.build();
// If we have a URL Encoded form entity, we may need to regenerate it as UTF-8
// due to a bug (or two!) in RequestBuilder:
//
// This fix can be removed when HttpClient is upgraded to 4.5, although 4.5 also
// has a bug where RequestBuilder.put(uri) and RequestBuilder.post(uri) use the
// wrong encoding, whereas RequestBuilder.put().setUri(uri) uses UTF-8.
// - MS 2017-04-12
if (httpRequest instanceof HttpEntityEnclosingRequest) {
HttpEntityEnclosingRequest entityRequest =
(HttpEntityEnclosingRequest) httpRequest;
HttpEntity entity = entityRequest.getEntity();
if (entity != null && entity instanceof UrlEncodedFormEntity) {
entityRequest.setEntity(new UrlEncodedFormEntity(
requestBuilder.getParameters(),
Charset.forName("UTF-8")));
}
}
LOG.debug("Request: " + httpRequest);
if (LOG.isDebugEnabled() && httpRequest instanceof HttpEntityEnclosingRequestBase) {
HttpEntityEnclosingRequestBase enclosingRequest = (HttpEntityEnclosingRequestBase) httpRequest;
LOG.debug(EntityUtils.toString(enclosingRequest.getEntity()));
}
HttpResponse response = this.httpWrapper.getHttpClient().execute(httpRequest);
return parseResponse(response);
} catch (UnsupportedEncodingException uee) {
throw new NexmoUnexpectedException("UTF-8 encoding is not supported by this JVM.", uee);
}
}
/**
* Apply an appropriate authentication method (specified by {@link #getAcceptableAuthMethods()} to the provided
* {@link RequestBuilder}, and return the result.
*
* @param request A RequestBuilder which has not yet had authentication information applied
* @return A RequestBuilder with appropriate authentication information applied (may or not be the same instance as
* request
)
* @throws NexmoClientException If no appropriate {@link AuthMethod} is available
*/
protected RequestBuilder applyAuth(RequestBuilder request) throws NexmoClientException {
return getAuthMethod(getAcceptableAuthMethods()).apply(request);
}
/**
* Utility method for obtaining an appropriate {@link AuthMethod} for this call.
*
* @param acceptableAuthMethods an array of classes, representing authentication methods that are acceptable for
* this endpoint
* @return An AuthMethod created from one of the provided acceptableAuthMethods.
* @throws NexmoClientException If no AuthMethod is available from the provided array of acceptableAuthMethods.
*/
protected AuthMethod getAuthMethod(Class[] acceptableAuthMethods) throws NexmoClientException {
if (acceptable == null) {
this.acceptable = new HashSet<>();
for (Class c : acceptableAuthMethods) {
acceptable.add(c);
}
}
return this.httpWrapper.getAuthCollection().getAcceptableAuthMethod(acceptable);
}
public void setHttpClient(HttpClient client) {
this.httpWrapper.setHttpClient(client);
}
protected abstract Class[] getAcceptableAuthMethods();
/**
* Construct and return a RequestBuilder instance from the provided request.
*
* @param request A RequestT representing input to the REST call to be made
* @return A ResultT representing the response from the executed REST call
* @throws NexmoClientException if a problem is encountered constructing the request or response.
* @throws UnsupportedEncodingException if UTF-8 encoding is not supported by the JVM
*/
public abstract RequestBuilder makeRequest(RequestT request)
throws NexmoClientException, UnsupportedEncodingException;
/**
* Construct a ResultT representing the contents of the HTTP response returned from the Nexmo Voice API.
*
* @param response An HttpResponse returned from the Nexmo Voice API
* @return A ResultT type representing the result of the REST call
* @throws IOException if a problem occurs parsing the response
*/
public abstract ResultT parseResponse(HttpResponse response) throws IOException, NexmoClientException;
}