1 /* 2 * Copyright 2017 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 package com.google.api.gax.httpjson; 31 32 import com.google.api.core.BetaApi; 33 import com.google.api.pathtemplate.PathTemplate; 34 import java.util.Collections; 35 import java.util.List; 36 import java.util.Map; 37 38 /** Interface for classes that create parts of HTTP requests from a parameterized message. */ 39 public interface HttpRequestFormatter<MessageFormatT> { 40 /** 41 * Return a map where each entry is the name of a query param mapped to the values of the param. 42 */ getQueryParamNames(MessageFormatT apiMessage)43 Map<String, List<String>> getQueryParamNames(MessageFormatT apiMessage); 44 45 /** Return the serialized inner request body of the given message. */ getRequestBody(MessageFormatT apiMessage)46 String getRequestBody(MessageFormatT apiMessage); 47 48 /* Return the relative URL path created from the path parameters from the given message. */ getPath(MessageFormatT apiMessage)49 String getPath(MessageFormatT apiMessage); 50 51 /** Path template for endpoint URL path. */ getPathTemplate()52 PathTemplate getPathTemplate(); 53 54 /** Additional (alternative) path templates for endpoint URL path. */ 55 @BetaApi getAdditionalPathTemplates()56 default List<PathTemplate> getAdditionalPathTemplates() { 57 return Collections.emptyList(); 58 } 59 } 60