Top Description Inners Fields Constructors Methods
com.oracle.bmc.http.internal

public Class ResponseHelper

extends Object
Class Inheritance
Imports
com.oracle.bmc.InternalSdk, java.util.HashMap, .Map, .Objects, com.fasterxml.jackson.annotation.JsonAnySetter

A BmcException exception is thrown in response to failures from a REST endpoint. It contains the status code of the HTTP response as well as an application code and message describing the problem.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final Map<Integer, String>
private static final Logger
private static final int
private static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_ERROR_MESSAGESback to summary
public static final Map<Integer, String> DEFAULT_ERROR_MESSAGES
Annotations
@InternalSdk
LOGback to summary
private static final Logger LOG
MAX_RESPONSE_BUFFER_BYTESback to summary
private static final int MAX_RESPONSE_BUFFER_BYTES
OPC_REQUEST_ID_HEADERback to summary
private static final String OPC_REQUEST_ID_HEADER

Constructor Detail

ResponseHelperback to summary
public ResponseHelper()
com.oracle.bmc.http.internal back to summary

public final Class ResponseHelper.ErrorCodeAndMessage

extends Object
Class Inheritance
  • java.lang.Object
  • com.oracle.bmc.http.internal.ResponseHelper.ErrorCodeAndMessage

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final Map<String, String>
private final String
private final String
private final Map<String, String>
private final String
private final String

Constructor Summary

AccessConstructor and Description
pack-priv
ErrorCodeAndMessage(final String code, final String message, final String originalMessage, final String originalMessageTemplate, final Map<String, String> messageArguments)

Method Summary

Modifier and TypeMethod and Description
public static ResponseHelper.ErrorCodeAndMessage.Builder
public boolean
equals(final Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Map<String, String>
public String
public String
public Map<String, String>
public String
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

additionalPropertiesback to summary
private final Map<String, String> additionalProperties
codeback to summary
private final String code
messageback to summary
private final String message
messageArgumentsback to summary
private final Map<String, String> messageArguments
originalMessageback to summary
private final String originalMessage
originalMessageTemplateback to summary
private final String originalMessageTemplate

Constructor Detail

ErrorCodeAndMessageback to summary
pack-priv ErrorCodeAndMessage(final String code, final String message, final String originalMessage, final String originalMessageTemplate, final Map<String, String> messageArguments)
Annotations
@java.beans.ConstructorProperties

Method Detail

builderback to summary
public static ResponseHelper.ErrorCodeAndMessage.Builder builder()
equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAdditionalPropertiesback to summary
public Map<String, String> getAdditionalProperties()
getCodeback to summary
public String getCode()
getMessageback to summary
public String getMessage()
getMessageArgumentsback to summary
public Map<String, String> getMessageArguments()
getOriginalMessageback to summary
public String getOriginalMessage()
getOriginalMessageTemplateback to summary
public String getOriginalMessageTemplate()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setAdditionalPropertiesback to summary
public void setAdditionalProperties(String key, Object value)
Annotations
@JsonAnySetter
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
com.oracle.bmc.http.internal back to summary

public Class ResponseHelper.ErrorCodeAndMessage.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • com.oracle.bmc.http.internal.ResponseHelper.ErrorCodeAndMessage.Builder

Field Summary

Modifier and TypeField and Description
private String
private String
private Map<String, String>
private String
private String

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public ResponseHelper.ErrorCodeAndMessage
public ResponseHelper.ErrorCodeAndMessage.Builder

Returns:

this.
code
(final String code)

public ResponseHelper.ErrorCodeAndMessage.Builder

Returns:

this.
message
(final String message)

public ResponseHelper.ErrorCodeAndMessage.Builder
messageArguments(final Map<String, String> messageArguments)

public ResponseHelper.ErrorCodeAndMessage.Builder
originalMessage(final String originalMessage)

public ResponseHelper.ErrorCodeAndMessage.Builder
originalMessageTemplate(final String originalMessageTemplate)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

codeback to summary
private String code
messageback to summary
private String message
messageArgumentsback to summary
private Map<String, String> messageArguments
originalMessageback to summary
private String originalMessage
originalMessageTemplateback to summary
private String originalMessageTemplate

Constructor Detail

Builderback to summary
pack-priv Builder()

Method Detail

buildback to summary
public ResponseHelper.ErrorCodeAndMessage build()
codeback to summary
public ResponseHelper.ErrorCodeAndMessage.Builder code(final String code)
Returns:ResponseHelper.ErrorCodeAndMessage.Builder

this.

messageback to summary
public ResponseHelper.ErrorCodeAndMessage.Builder message(final String message)
Returns:ResponseHelper.ErrorCodeAndMessage.Builder

this.

messageArgumentsback to summary
public ResponseHelper.ErrorCodeAndMessage.Builder messageArguments(final Map<String, String> messageArguments)
originalMessageback to summary
public ResponseHelper.ErrorCodeAndMessage.Builder originalMessage(final String originalMessage)
originalMessageTemplateback to summary
public ResponseHelper.ErrorCodeAndMessage.Builder originalMessageTemplate(final String originalMessageTemplate)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override