Package com.oracle.bmc.identitydataplane.model

Class AuthenticateClientResult

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identitydataplane.model.AuthenticateClientResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class AuthenticateClientResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Note: Objects should always be created or deserialized using the AuthenticateClientResult.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AuthenticateClientResult.Builder, which maintain a set of all explicitly set fields called AuthenticateClientResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticateClientResult.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AuthenticateClientResult(Principal principal, String errorMessage)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AuthenticateClientResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getErrorMessage()	If the authentication fails for the original caller (not failing authentication of the calling service, in which case we return 401), we return a 200, but with null principal and an error message
Principal	getPrincipal()	The original caller’s resolved principal object if the authentication succeeds, null otherwise.
int	hashCode()
AuthenticateClientResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticateClientResult

@Deprecated
@ConstructorProperties({"principal","errorMessage"})
public AuthenticateClientResult(Principal principal,
                                String errorMessage)

Deprecated.

Method Detail

builder

public static AuthenticateClientResult.Builder builder()

Create a new builder.

toBuilder

public AuthenticateClientResult.Builder toBuilder()

getPrincipal

public Principal getPrincipal()

The original caller’s resolved principal object if the authentication succeeds, null otherwise.

Returns:

the value

getErrorMessage

public String getErrorMessage()

If the authentication fails for the original caller (not failing authentication of the calling service, in which case we return 401), we return a 200, but with null principal and an error message

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel