public abstract class AbstractLightResponse extends Object implements ILightResponse, Serializable
ILightResponse
interface.
This class uses the Builder Pattern.
Implementors of the ILightResponse
should extend this class and its Builder.
Modifier and Type | Class and Description |
---|---|
static class |
AbstractLightResponse.AbstractBuilder<B extends AbstractLightResponse.AbstractBuilder<B,T>,T extends LightResponse>
Abstract Builder pattern with self-bounding generics for
ILightResponse subtypes. |
Modifier | Constructor and Description |
---|---|
protected |
AbstractLightResponse(AbstractLightResponse.AbstractBuilder<?,?> builder) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
ImmutableAttributeMap |
getAttributes()
Returns the response attributes if the response is a success response , or an empty map if the response is a
failure response, never
null . |
String |
getConsent()
Returns the consent URI of this response.
|
String |
getId()
Returns the response ID.
|
String |
getInResponseToId()
Returns the ID of the request corresponding to this response.
|
String |
getIPAddress()
Returns the IP address of the connected end-user.
|
String |
getIssuer()
Returns the issuer URI of this response.
|
String |
getLevelOfAssurance()
Returns the level of assurance (LoA) in the authentication performed for this response, or
null if the
response is a failure response. |
String |
getRelayState()
Returns the the RelayState (to be) sent with Response with the proper binding
|
ResponseStatus |
getStatus()
The status of the response.
|
String |
getSubject()
Returns the Subject of this response, the assertion is issued for.
|
String |
getSubjectNameIdFormat()
Returns the NameID format of the Subject of the assertion.
|
int |
hashCode() |
String |
toString() |
protected StringBuilder |
toString(StringBuilder stringBuilder) |
static StringBuilder |
toString(StringBuilder stringBuilder,
ILightResponse response) |
protected AbstractLightResponse(@Nonnull AbstractLightResponse.AbstractBuilder<?,?> builder)
@Nonnull public final ImmutableAttributeMap getAttributes()
ILightResponse
null
.getAttributes
in interface ILightResponse
null
.@Nullable public final String getIPAddress()
ILightResponse
getIPAddress
in interface ILightResponse
@Nonnull public final String getId()
ILightResponse
This is a unique ID which must be used to prevent replay attacks.
getId
in interface ILightResponse
@Nullable public final String getRelayState()
ILightResponse
getRelayState
in interface ILightResponse
@Nonnull public final String getInResponseToId()
ILightResponse
This is the unique ID of the request which permits to correlate this response to the originating request.
getInResponseToId
in interface ILightResponse
@Nullable public final String getSubject()
ILightResponse
getSubject
in interface ILightResponse
@Nullable public final String getSubjectNameIdFormat()
ILightResponse
getSubjectNameIdFormat
in interface ILightResponse
@Nonnull public final String getIssuer()
ILightResponse
getIssuer
in interface ILightResponse
@Nonnull public final String getConsent()
ILightResponse
getConsent
in interface ILightResponse
@Nullable public final String getLevelOfAssurance()
ILightResponse
null
if the
response is a failure response.getLevelOfAssurance
in interface ILightResponse
null
if the
response is a failure response.@Nonnull public final ResponseStatus getStatus()
ILightResponse
This allows to determine whether this response is a success or a failure response and optionally to have more detailed status messages.
getStatus
in interface ILightResponse
protected StringBuilder toString(@Nonnull StringBuilder stringBuilder)
public static StringBuilder toString(@Nonnull StringBuilder stringBuilder, @Nonnull ILightResponse response)
Copyright © 2020. All Rights Reserved.