Package com.oracle.bmc.http.client

Enum StandardHttpProviderCapability

java.lang.Object

java.lang.Enum<StandardHttpProviderCapability>

com.oracle.bmc.http.client.StandardHttpProviderCapability

All Implemented Interfaces:

HttpProviderCapability, Serializable, Comparable<StandardHttpProviderCapability>

public enum StandardHttpProviderCapability
extends Enum<StandardHttpProviderCapability>
implements HttpProviderCapability

Capabilities that an HTTP client library may support.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PARAMETERIZED_ENDPOINTS	This capability indicates that the HTTP provider can handle parameterized endpoints.

Method Summary

Modifier and Type	Method	Description
static StandardHttpProviderCapability	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StandardHttpProviderCapability[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARAMETERIZED_ENDPOINTS

public static final StandardHttpProviderCapability PARAMETERIZED_ENDPOINTS

This capability indicates that the HTTP provider can handle parameterized endpoints.

This means that the endpoints can contain placeholders in the format

1. "{parameterName}
2. "{parameterName+Dot}
3. "{optionName?trueValue:falseValue}"

where “parameterName” is the name of one of the required parameter of the operation being invoked; and where “optionName” is an option name, and “trueValue” is the literal replacement string it the option is enabled, and “falseValue” is the literal replacement string if the option is false. If the option is unknown, the entire construct is removed, meaning neither true nor the false replacement value is added.

If an HTTP provider has this capability, the oci-java-sdk-common library will call the HttpClient.createRequest(Method, Map, Map) and provide a map of required parameters to their parameter values, and map of options to their Boolean value.

If an HTTP provider does NOT have this capability, then the HttpClient.createRequest(Method) will be called instead.

Method Detail

values

public static StandardHttpProviderCapability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardHttpProviderCapability c : StandardHttpProviderCapability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardHttpProviderCapability valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null