001/*
002 * Copyright (c) 2011-2017 Nexmo Inc
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy
005 * of this software and associated documentation files (the "Software"), to deal
006 * in the Software without restriction, including without limitation the rights
007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008 * copies of the Software, and to permit persons to whom the Software is
009 * furnished to do so, subject to the following conditions:
010 *
011 * The above copyright notice and this permission notice shall be included in
012 * all copies or substantial portions of the Software.
013 *
014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
020 * THE SOFTWARE.
021 */
022package com.nexmo.client.numbers;
023
024
025import com.nexmo.client.HttpWrapper;
026import com.nexmo.client.NexmoClientException;
027import com.nexmo.client.auth.TokenAuthMethod;
028import com.nexmo.client.voice.endpoints.AbstractMethod;
029import org.apache.http.HttpResponse;
030import org.apache.http.client.methods.RequestBuilder;
031import org.apache.http.impl.client.BasicResponseHandler;
032
033import java.io.IOException;
034import java.io.UnsupportedEncodingException;
035
036/**
037 * Internal class, representing the Nexmo API endpoint which can be used to search for available virtual numbers to buy.
038 * <p>
039 * Use {@link NumbersClient#searchNumbers} instead of this class directly.
040 */
041public class SearchNumbersEndpoint extends AbstractMethod<SearchNumbersFilter, SearchNumbersResponse> {
042    private static final String DEFAULT_URI = "https://rest.nexmo.com/number/search";
043    private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
044    private String uri = DEFAULT_URI;
045
046    public SearchNumbersEndpoint(HttpWrapper httpWrapper) {
047        super(httpWrapper);
048    }
049
050    @Override
051    protected Class[] getAcceptableAuthMethods() {
052        return ALLOWED_AUTH_METHODS;
053    }
054
055    @Override
056    public RequestBuilder makeRequest(SearchNumbersFilter request) throws NexmoClientException,
057                                                                          UnsupportedEncodingException {
058        RequestBuilder requestBuilder = RequestBuilder.get().setUri(uri);
059        request.addParams(requestBuilder);
060        return requestBuilder;
061    }
062
063    @Override
064    public SearchNumbersResponse parseResponse(HttpResponse response) throws IOException {
065        String json = new BasicResponseHandler().handleResponse(response);
066        return SearchNumbersResponse.fromJson(json);
067    }
068
069    public SearchNumbersResponse searchNumbers(SearchNumbersFilter request) throws IOException, NexmoClientException {
070        return this.execute(request);
071    }
072}