org.qas.api.internal.util

Class Https

java.lang.Object

org.qas.api.internal.util.Https

public final class Https
extends java.lang.Object

Https

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_ELEMENT_FORMAT header element format.
static java.lang.String	QUERY_STRING_ELEMENT_FORMAT query string element format.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.String template, java.lang.Object... args) Substitutes each %s in template with an argument.
static boolean	isUsingNonDefaultPort(java.net.URI uri) Returns true if the specified URI is using a non-standard port.
static java.lang.String	pathEncode(java.lang.String resourcePath)
static java.lang.String	percentEncode(java.util.Iterator<?> iterator) Encodes the iterator as percent encode.
static java.lang.String	toHeaderElement(java.lang.String name, java.lang.String value) Helper method to concatenate a parameter and its value to a pair that can be used in an HTTP header.
static java.lang.String	toQueryElement(java.lang.String name, java.lang.String value) Helper method to concatenate a parameter and its value to a pair that can be used in an HTTP header.
static java.lang.String	toQueryString(java.util.Map<java.lang.String,java.lang.String> parameters, java.nio.charset.Charset encoding) Converts the parameter to query string parameter.
static java.lang.String	toSafeString(java.lang.Object source)
static boolean	usePayloadForQueryParameters(Request request) Returns true if the specified request has no payload and the POST method.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_ELEMENT_FORMAT

public static final java.lang.String HEADER_ELEMENT_FORMAT

header element format.

See Also:

Constant Field Values

QUERY_STRING_ELEMENT_FORMAT

public static final java.lang.String QUERY_STRING_ELEMENT_FORMAT

query string element format.

See Also:

Constant Field Values

Method Detail

isUsingNonDefaultPort

public static boolean isUsingNonDefaultPort(java.net.URI uri)

Returns true if the specified URI is using a non-standard port.

Parameters:

uri - the URI object to determine the default port.

Returns:

true if the specified URI is using a non-standard port, false otherwise.

pathEncode

public static java.lang.String pathEncode(java.lang.String resourcePath)

usePayloadForQueryParameters

public static boolean usePayloadForQueryParameters(Request request)

Returns true if the specified request has no payload and the POST method.

Parameters:

request - the Request to determine using payload for query parameter.

Returns:

true if the request has no payload and using payload for query parameter, false otherwise.

toSafeString

public static java.lang.String toSafeString(java.lang.Object source)

Parameters:

source - source

Returns:

the object representation as String.

percentEncode

public static java.lang.String percentEncode(java.util.Iterator<?> iterator)

Encodes the iterator as percent encode.

Parameters:

iterator - the given Iterator object to encode.

Returns:

the percent encode of object.

toQueryString

public static java.lang.String toQueryString(java.util.Map<java.lang.String,java.lang.String> parameters,
                                             java.nio.charset.Charset encoding)

Converts the parameter to query string parameter.

Parameters:

parameters - the given map of parameters.

encoding - the given encoding.

Returns:

the query string.

toHeaderElement

public static java.lang.String toHeaderElement(java.lang.String name,
                                               java.lang.String value)

Helper method to concatenate a parameter and its value to a pair that can be used in an HTTP header. This method percent encodes both parts before joining them.

Parameters:

name - the OAuth parameter name, e.g. oauth_token

value - the OAuth parameter value, e.g. 'hello oauth'

Returns:

a name/value pair, e.g. oauth_token="hello%20oauth"

toQueryElement

public static java.lang.String toQueryElement(java.lang.String name,
                                              java.lang.String value)

Helper method to concatenate a parameter and its value to a pair that can be used in an HTTP header. This method percent encodes both parts before joining them.

Parameters:

name - the OAuth parameter name, e.g. oauth_token

value - the OAuth parameter value, e.g. 'hello oauth'

Returns:

a name/value pair, e.g. oauth_token="hello%20oauth"

format

public static java.lang.String format(java.lang.String template,
                                      java.lang.Object... args)

Substitutes each %s in template with an argument. These are matched by position - the first %s gets args[0], etc. If there are more arguments than placeholders, the unmatched arguments will be appended to the end of the formatted message in square braces.

Parameters:

template - a non-null string containing 0 or more %s placeholders.

args - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object). Arguments can be null.

Returns:

string