Package com.styra.opa.openapi.utils

Class Utils

java.lang.Object

com.styra.opa.openapi.utils.Utils

public final class Utils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Utils.Function<S,T>
static final class	Utils.HttpResponseCached
static enum	Utils.JsonShape
static final class	Utils.TypeReferenceWithShape

Method Summary

Modifier and Type	Method	Description
static boolean	allowIntrospection(Class<?> cls)
static <T> T	asType(EventStreamMessage x, com.fasterxml.jackson.databind.ObjectMapper mapper, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
static Utils.HttpResponseCached	cache(HttpResponse<InputStream> response)	Fully reads the body of the given response and caches it in memory.
static void	checkArgument(boolean expression, String message)
static <T> T	checkNotNull(T object, String name)
static HTTPRequest	configureSecurity(HTTPRequest request, Object security)
static boolean	contentTypeMatches(String contentType, String pattern)
static Object	convertToShape(Object o, Utils.JsonShape shape, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
static com.fasterxml.jackson.databind.JavaType	convertToStringShape(com.fasterxml.jackson.databind.type.TypeFactory f, com.fasterxml.jackson.databind.JavaType a)
static HttpRequest.Builder	copy(HttpRequest request)	Returns an HttpRequest.Builder which is initialized with the state of the given HttpRequest.
static HttpRequest.Builder	copy(HttpRequest request, BiPredicate<String,String> filter)	Returns an HttpRequest.Builder which is initialized with the state of the given HttpRequest.
static HTTPClient	createTestHTTPClient(SpeakeasyHTTPClient client, String testName)
static HTTPClient	createTestHTTPClient(String testName)
static String	discriminatorToString(Object o)
static <K, V> Map<K,V>	emptyMapIfNull(Map<K,V> map)
static String	environmentVariable(String name, String defaultValue)	Internal use.
static byte[]	extractByteArrayFromBody(HttpResponse<InputStream> response)
static <T> String	generateURL(Class<T> type, String baseURL, String path, Optional<? extends T> params, Map<String,Map<String,Map<String,Object>>> globals)
static <T> String	generateURL(Class<T> type, String baseURL, String path, org.openapitools.jackson.nullable.JsonNullable<? extends T> params, Map<String,Map<String,Map<String,Object>>> globals)
static <T> String	generateURL(Class<T> type, String baseURL, String path, T params, Map<String,Map<String,Map<String,Object>>> globals)
static String	generateURL(String baseURL, String path)
static Map<String,List<String>>	getHeadersFromMetadata(Object headers, Map<String,Map<String,Map<String,Object>>> globals)
static <T> List<QueryParameter>	getQueryParams(Class<T> type, Optional<? extends T> params, Map<String,Map<String,Map<String,Object>>> globals)
static <T> List<QueryParameter>	getQueryParams(Class<T> type, org.openapitools.jackson.nullable.JsonNullable<? extends T> params, Map<String,Map<String,Map<String,Object>>> globals)
static <T> List<QueryParameter>	getQueryParams(Class<T> type, T params, Map<String,Map<String,Map<String,Object>>> globals)
static boolean	isPresentAndNotNull(Optional<?> x)
static boolean	isPresentAndNotNull(org.openapitools.jackson.nullable.JsonNullable<?> x)
static String	json(EventStreamMessage m, com.fasterxml.jackson.databind.ObjectMapper mapper, boolean dataIsPlainText)
static com.fasterxml.jackson.databind.ObjectMapper	mapper()
static Object	populateGlobal(Object value, String fieldName, String paramType, Map<String,Map<String,Map<String,Object>>> globals)
static String	prefixBearer(String authHeaderValue)
static byte[]	readBytes(File file)
static byte[]	readBytes(InputStream in)
static byte[]	readBytes(String filename)
static byte[]	readBytesAndClose(InputStream in)
static <T> T	readDefaultOrConstValue(String name, String json, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
static void	recordTest(String id)
static boolean	referenceEquals(Object a, Object b)
static Object	resolveOptionals(Object o)
static SerializedBody	serializeRequestBody(Object request, String requestField, String serializationMethod, boolean nullable)
static String	sessionKey(String... items)
static void	setSseSentinel(Object o, String value)
static String	sortJSONObjectKeys(String json, String... fields)
static String	sortQueryParameters(String url)	Returns an equivalent url with query parameters sorted by name.
static Object	sortSerializedMaps(Object input, String regex, String delim)
static boolean	statusCodeMatches(int statusCode, String... expectedStatusCodes)
static boolean	statusCodeMatchesOne(int statusCode, String expectedStatusCode)
static <T> Stream<T>	stream(Callable<Optional<T>> first, Utils.Function<T,Optional<T>> next)
static String	templateUrl(String url, Map<String,String> params)
static byte[]	toByteArrayAndClose(InputStream in)
static String	toHex(byte[] bytes)
static List<?>	toList(Object o)
static <T> Optional<T>	toOptional(org.openapitools.jackson.nullable.JsonNullable<T> a)
static String	toString(Class<?> cls, Object... items)
static String	toUtf8AndClose(InputStream in)
static String	valToString(Object value)
static <T> T	valueOrElse(Optional<T> value, T valueIfNotPresent)
static <T> T	valueOrElse(org.openapitools.jackson.nullable.JsonNullable<T> value, T valueIfNotPresent)
static <T> T	valueOrElse(T value, T valueIfNotPresent)
static <T> T	valueOrNull(Optional<T> value)
static <T> T	valueOrNull(org.openapitools.jackson.nullable.JsonNullable<T> value)
static <T> T	valueOrNull(T value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

referenceEquals

public static boolean referenceEquals(Object a,
 Object b)

generateURL

public static String generateURL(String baseURL,
 String path)
                          throws IllegalArgumentException,
IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException

generateURL

public static <T> String generateURL(Class<T> type,
 String baseURL,
 String path,
 org.openapitools.jackson.nullable.JsonNullable<? extends T> params,
 Map<String,Map<String,Map<String,Object>>> globals)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
IllegalArgumentException,
IllegalAccessException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IllegalArgumentException

IllegalAccessException

generateURL

public static <T> String generateURL(Class<T> type,
 String baseURL,
 String path,
 Optional<? extends T> params,
 Map<String,Map<String,Map<String,Object>>> globals)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
IllegalArgumentException,
IllegalAccessException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IllegalArgumentException

IllegalAccessException

generateURL

public static <T> String generateURL(Class<T> type,
 String baseURL,
 String path,
 T params,
 Map<String,Map<String,Map<String,Object>>> globals)
                              throws IllegalArgumentException,
IllegalAccessException,
com.fasterxml.jackson.core.JsonProcessingException

Throws:

IllegalArgumentException

IllegalAccessException

com.fasterxml.jackson.core.JsonProcessingException

contentTypeMatches

public static boolean contentTypeMatches(String contentType,
 String pattern)

allowIntrospection

public static boolean allowIntrospection(Class<?> cls)

serializeRequestBody

public static SerializedBody serializeRequestBody(Object request,
 String requestField,
 String serializationMethod,
 boolean nullable)
                                           throws NoSuchFieldException,
IllegalArgumentException,
IllegalAccessException,
UnsupportedOperationException,
IOException

Throws:

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

UnsupportedOperationException

IOException

getQueryParams

public static <T> List<QueryParameter> getQueryParams(Class<T> type,
 Optional<? extends T> params,
 Map<String,Map<String,Map<String,Object>>> globals)
                                               throws Exception

Throws:

Exception

getQueryParams

public static <T> List<QueryParameter> getQueryParams(Class<T> type,
 org.openapitools.jackson.nullable.JsonNullable<? extends T> params,
 Map<String,Map<String,Map<String,Object>>> globals)
                                               throws Exception

Throws:

Exception

getQueryParams

public static <T> List<QueryParameter> getQueryParams(Class<T> type,
 T params,
 Map<String,Map<String,Map<String,Object>>> globals)
                                               throws Exception

Throws:

Exception

configureSecurity

public static HTTPRequest configureSecurity(HTTPRequest request,
 Object security)
                                     throws Exception

Throws:

Exception

templateUrl

public static String templateUrl(String url,
 Map<String,String> params)

getHeadersFromMetadata

public static Map<String,List<String>> getHeadersFromMetadata(Object headers,
 Map<String,Map<String,Map<String,Object>>> globals)
                                                       throws Exception

Throws:

Exception

valToString

public static String valToString(Object value)

prefixBearer

public static String prefixBearer(String authHeaderValue)

populateGlobal

public static Object populateGlobal(Object value,
 String fieldName,
 String paramType,
 Map<String,Map<String,Map<String,Object>>> globals)

checkNotNull

public static <T> T checkNotNull(T object,
 String name)

checkArgument

public static void checkArgument(boolean expression,
 String message)

emptyMapIfNull

public static <K,
V> Map<K,V> emptyMapIfNull(Map<K,V> map)

toString

public static String toString(Class<?> cls,
 Object... items)

resolveOptionals

public static Object resolveOptionals(Object o)

toList

public static List<?> toList(Object o)

readDefaultOrConstValue

public static <T> T readDefaultOrConstValue(String name,
 String json,
 com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

extractByteArrayFromBody

public static byte[] extractByteArrayFromBody(HttpResponse<InputStream> response)
                                       throws IOException

Throws:

IOException

toByteArrayAndClose

public static byte[] toByteArrayAndClose(InputStream in)
                                  throws IOException

Throws:

IOException

toUtf8AndClose

public static String toUtf8AndClose(InputStream in)
                             throws IOException

Throws:

IOException

convertToShape

public static Object convertToShape(Object o,
 Utils.JsonShape shape,
 com.fasterxml.jackson.core.type.TypeReference<?> typeReference)

convertToStringShape

public static com.fasterxml.jackson.databind.JavaType convertToStringShape(com.fasterxml.jackson.databind.type.TypeFactory f,
 com.fasterxml.jackson.databind.JavaType a)

stream

public static <T> Stream<T> stream(Callable<Optional<T>> first,
 Utils.Function<T,Optional<T>> next)

statusCodeMatches

public static boolean statusCodeMatches(int statusCode,
 String... expectedStatusCodes)

statusCodeMatchesOne

public static boolean statusCodeMatchesOne(int statusCode,
 String expectedStatusCode)

copy

public static HttpRequest.Builder copy(HttpRequest request)

Returns an HttpRequest.Builder which is initialized with the state of the given HttpRequest.

Parameters:

request - request to copy

Returns:

a builder initialized with values from request

copy

public static HttpRequest.Builder copy(HttpRequest request,
 BiPredicate<String,String> filter)

Returns an HttpRequest.Builder which is initialized with the state of the given HttpRequest.

Parameters:

request - request to copy

filter - selects which header key-values to include in the copied request

Returns:

a builder initialized with values from request

mapper

public static com.fasterxml.jackson.databind.ObjectMapper mapper()

asType

public static <T> T asType(EventStreamMessage x,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

json

public static String json(EventStreamMessage m,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 boolean dataIsPlainText)
                   throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

cache

public static Utils.HttpResponseCached cache(HttpResponse<InputStream> response)
                                      throws IOException

Fully reads the body of the given response and caches it in memory. The returned response has utility methods to view the body (bodyAsUtf8(), bodyAsBytes() and the body() method can be called multiple times, each returning a fresh InputStream that will read from the cached byte array.

This method is most likely to be used in a diagnostic/logging situtation so that the contents of a response can be viewed without affecting processing. Using this method with a very large body may be problematic in terms of memory use.

Parameters:

response - response to cache

Returns:

response with a cached body

Throws:

IOException

readBytes

public static byte[] readBytes(String filename)

readBytes

public static byte[] readBytes(File file)

readBytesAndClose

public static byte[] readBytesAndClose(InputStream in)

readBytes

public static byte[] readBytes(InputStream in)

toHex

public static String toHex(byte[] bytes)

discriminatorToString

public static String discriminatorToString(Object o)

recordTest

public static void recordTest(String id)

sortQueryParameters

public static String sortQueryParameters(String url)

Returns an equivalent url with query parameters sorted by name. Sort is stable in that parameters with the same name will not be reordered.

Parameters:

url - input

Returns:

url with query parameters sorted by name

sortSerializedMaps

public static Object sortSerializedMaps(Object input,
 String regex,
 String delim)

isPresentAndNotNull

public static boolean isPresentAndNotNull(Optional<?> x)

isPresentAndNotNull

public static boolean isPresentAndNotNull(org.openapitools.jackson.nullable.JsonNullable<?> x)

setSseSentinel

public static void setSseSentinel(Object o,
 String value)

sessionKey

public static String sessionKey(String... items)

createTestHTTPClient

public static HTTPClient createTestHTTPClient(String testName)

createTestHTTPClient

public static HTTPClient createTestHTTPClient(SpeakeasyHTTPClient client,
 String testName)

environmentVariable

public static String environmentVariable(String name,
 String defaultValue)

Internal use. Returns the system property with key = "env." + name and if doesn't exist returns the value of the environment variable with the given name of if it doesn't exist returns defaultValue.

Parameters:

name - variable name

defaultValue - default value if system property and environment variable don't exist

Returns:

system property with name prepended with ".env" or environment variable of given name or default value

toOptional

public static <T> Optional<T> toOptional(org.openapitools.jackson.nullable.JsonNullable<T> a)

sortJSONObjectKeys

public static String sortJSONObjectKeys(String json,
 String... fields)

valueOrElse

public static <T> T valueOrElse(T value,
 T valueIfNotPresent)

valueOrElse

public static <T> T valueOrElse(Optional<T> value,
 T valueIfNotPresent)

valueOrElse

public static <T> T valueOrElse(org.openapitools.jackson.nullable.JsonNullable<T> value,
 T valueIfNotPresent)

valueOrNull

public static <T> T valueOrNull(T value)

valueOrNull

public static <T> T valueOrNull(Optional<T> value)

valueOrNull

public static <T> T valueOrNull(org.openapitools.jackson.nullable.JsonNullable<T> value)