Package swiss.trustbroker.saml.dto
Class CpResponse
java.lang.Object
swiss.trustbroker.saml.dto.ResponseStatus
swiss.trustbroker.saml.dto.CpResponse
- All Implemented Interfaces:
Serializable,swiss.trustbroker.api.sessioncache.dto.CpResponseData
public class CpResponse
extends ResponseStatus
implements swiss.trustbroker.api.sessioncache.dto.CpResponseData
This class implement the processing context which is the core of the XTB processing model according.
The context is mapped from CP SAML response and/or stored as session state.
Note that original attributes should not be used in scripting except may be for read-only debugging.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classCpResponse.CpResponseBuilder<C extends CpResponse,B extends CpResponse.CpResponseBuilder<C, B>> Nested classes/interfaces inherited from class swiss.trustbroker.saml.dto.ResponseStatus
ResponseStatus.ResponseStatusBuilder<C extends ResponseStatus,B extends ResponseStatus.ResponseStatusBuilder<C, B>> -
Field Summary
Fields inherited from class swiss.trustbroker.saml.dto.ResponseStatus
flowPolicy, statusCode, statusMessage, statusNestedCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionCpResponse(String inResponseTo, String nameId, String originalNameId, String mappedNameId, String nameIdFormat, String subjectConfirmationMethod, String authStateInstant, List<String> contextClasses, String issuer, String homeName, String destination, String authLevel, String rpIssuer, String rpReferer, List<String> rpContextClasses, String rpDestination, String rpRecipient, String clientExtId, String clientName, String applicationName, String oidcClientId, Set<String> oidcScopes, String customIssuer, Map<String, String> rpContext, Map<Definition, List<String>> attributes, Map<Definition, List<String>> originalAttributes, IdmLookup idmLookup, Map<Definition, List<String>> userDetails, int originalUserDetailsCount, Map<Definition, List<String>> properties, int originalPropertiesCount, Map<Definition, List<String>> results, Map<String, Object> claims, Map<Object, Object> additionalIdmData, Set<String> queriedStores) Creates a newCpResponseinstance.protected -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAttribute(String name, String value) Script hook: Add CP/IDP claim value to existing attribute or create entry.voidAdd claim.voidaddJsonClaim(String name, Object value) Add claim.voidaddJsonClaim(String parent, String name, Object value) Add claim with optional link to parent.voidaddParsedJsonAsClaim(String parent, String name, String value) Parse value as JSON and add, with optional parent.voidaddProperties(String name, String fqName, List<String> values) Script hook use: Add values to an already available list value or create.voidaddProperty(String name, String value) Script hook use: Add value to an already available list value or create.voidaddProperty(String name, String fqName, String value) Script hook use: Add value to an already available list value or create.booleanaddPropertyIfMissing(String name, String fqName, String value) Add property if not yet set.voidaddUserDetail(String name, String value) Script hook: Add value to existing user claim or create entry.voidaddUserDetail(String name, String fqName, String value) Script hook: Add value to existing user claim or create entry.voidaddUserDetail(String name, String fqName, String value, String source) Script hook: Add value or create entry with optional source.booleanaddUserDetailIfMissing(String name, String fqName, String value) Add user details if not yet set.static CpResponse.CpResponseBuilder<?, ?> builder()protected booleanvoidcloneIdmLookup(IdmLookup originalIdmLookup) booleanAdditional exchanged between related API implementations.RP/OIDC context sending 'SAML clientId' in ProviderName.getAttribute(String name) Script hook: Get single-valued CP/IDP claimgetAttribute(String name, String source) Script hook: Get single-valued CP/IDP claim including source selector.The attributes map contains these attributes: CP SAML Response attributes extracted from the message Derived attributes computed in ScriptService BeforeIdm hooks The names in this map are usually fully qualified as represented in the SAML response from the CP.getAttributes(String name) Script hook: Get multi-valued CP/IDP claimgetAttributes(String name, String source) Script hook: Get multi-valued CP/IDP claim including source selector.Declared QoA CP side.Issuing instant of authentication statement.Get single value of by name.getClaimList(String name) Converts values to (possibly immutable) list if needed, empty list for null.The claims map contains these OIDC claims: Everything that was annotated with an oidcName in the configuration. All well known OIDC claims of the openid scope declared in AttributeName (StandardClaims). Everything added or removed in a OIDC OnToken groovy script hook. We use Object values because of nested collection support.Get claims by name.Retrieved IDM primary reference for internal reference.RelyingParty ClientName as used in the IDM credential SAML federation Issuer NameID.Authentication context classes.Override RP response issuer.AuthnRequest.AssertionConsumerUrl from our AuthnRequest.HomeName used by IdmService to query IDM.Contains theIdmLookupfor the corresponding RP.ID of the authentication request that lead to this CP response.CP Response issuer also referred to as HomeRealm.CP Response incoming subject name ID after CP side subject name mapping.Subject name ID.Format of the subject name ID.Incoming OIDC client_id.Incoming OIDC scopes.Copy of Attributes before filtering.CP Response incoming subject name ID used for internal processing.intintProperties contain computed values that can be sent as RP attributes based on incoming CP attributes and userdetails.getProperties(String name) Script hook use: Get property values by name or FQ name.getProperties(String name, String source) Script hook use: Get property values by name or FQ name with optional source.getProperty(String name) Script hook use: Get first property value using name or FQ name.getProperty(String name, String source) Script hook use: Get first property value using name or FQ name with optional source.Contains the stores of IDM lookups actually executed by the availableIdmQueryServiceimplementations - including those that did not find a result.The results map contains these SAML attributes: CP SAML Response attributes extracted from the message (PassThrough Claims from CP) Derived attributes computed in ScriptService BeforeIdm hooks (Computed CP claims) IDM attributes retrieved from the IDMService Derived attributes computed in ScriptService AfterIdm hooks (Computed IDM claims) The names in this map are usually fully qualified as represented in the SAML response from the CP.The HttpServletRequest params, some specific ones: username, Client_NetworkIncoming context class requirements on RP side.Override SAML Response.Destination on RP side.Incoming issuer on RP side.Override SAML SubjectConfirmationData.Recipient on RP side.Incoming HTTP referrer on RP side.getSsoSubjectFromCpResponse(String ssoSubjectClaim) Subject confirmation method.getUserDetail(String name) Script hook use: Get first value using name or FQ name.getUserDetail(String name, String source) Script hook use: Get first value using name or FQ name with optional source.IDM user data returned from IDM backends, filtered by RP setup.getUserDetails(String name) Script hook use: get all values using name or FQ name.getUserDetails(String name, String source) Get values using name or FQ name with optional source.inthashCode()booleanvoidremoveAttributes(String name) Remove CP/IDP claim with name or FQ name.voidremoveClaim(String name) Remove claim.removeProperty(String name) Script hook use: Remove entry by name or FQ name.removeUserDetails(String name) Script hook use: Remove entry by name or FQ name.removeUserDetails(String name, String source) Script hook use: Remove entry by name or FQ name from the optional source.voidsetAdditionalIdmData(Map<Object, Object> additionalIdmData) Additional exchanged between related API implementations.voidsetApplicationName(String applicationName) RP/OIDC context sending 'SAML clientId' in ProviderName.voidsetAttribute(String name, String value) Set single value attribute.voidsetAttribute(String name, String namespaceUri, String value) Set single value attribute with namespace.voidsetAttributes(String name, String namespaceUri, List<String> values) Set multi-value attribute with namespace.voidsetAttributes(String name, List<String> values) Set multi-value attribute.voidsetAttributes(Map<Definition, List<String>> attributes) The attributes map contains these attributes: CP SAML Response attributes extracted from the message Derived attributes computed in ScriptService BeforeIdm hooks The names in this map are usually fully qualified as represented in the SAML response from the CP.voidsetAttributes(Definition def, List<String> values) Set multi-value attribute with Definition key.voidsetAuthLevel(String authLevel) Declared QoA CP side.voidsetAuthStateInstant(String authStateInstant) Issuing instant of authentication statement.voidSet claim value or values.voidsetClaimList(String name, Object values) Converts values to (possibly immutable) list if needed, empty list for null.voidSet claim value or values.voidThe claims map contains these OIDC claims: Everything that was annotated with an oidcName in the configuration. All well known OIDC claims of the openid scope declared in AttributeName (StandardClaims). Everything added or removed in a OIDC OnToken groovy script hook. We use Object values because of nested collection support.voidsetClientExtId(String clientExtId) Retrieved IDM primary reference for internal reference.voidsetClientName(String clientName) RelyingParty ClientName as used in the IDM credential SAML federation Issuer NameID.voidsetContextClasses(List<String> contextClasses) Authentication context classes.voidsetCustomIssuer(String customIssuer) Override RP response issuer.voidsetDestination(String destination) AuthnRequest.AssertionConsumerUrl from our AuthnRequest.voidsetHomeName(String homeName) HomeName used by IdmService to query IDM.voidsetIdmLookup(IdmLookup idmLookup) Contains theIdmLookupfor the corresponding RP.voidsetInResponseTo(String inResponseTo) ID of the authentication request that lead to this CP response.voidCP Response issuer also referred to as HomeRealm.voidsetJsonClaim(String name, Object value) Set claim value from collection or other value.voidsetJsonClaims(String name, Object values) Set claim value from collection or other value.voidsetMappedNameId(String mappedNameId) CP Response incoming subject name ID after CP side subject name mapping.voidSubject name ID.voidsetNameIdFormat(String nameIdFormat) Format of the subject name ID.voidsetOidcClientId(String oidcClientId) Incoming OIDC client_id.voidsetOidcScopes(Set<String> oidcScopes) Incoming OIDC scopes.voidsetOriginalAttributes(Map<Definition, List<String>> originalAttributes) Copy of Attributes before filtering.voidsetOriginalNameId(String originalNameId) CP Response incoming subject name ID used for internal processing.voidsetOriginalPropertiesCount(int originalPropertiesCount) voidsetOriginalUserDetailsCount(int originalUserDetailsCount) voidsetParsedJsonAsClaim(String name, String value) Parse value as JSON and add.voidsetProperties(String name, String fqName, List<String> values) Script hook use: Add CP/IDP claims with a list value.using FQ name.voidsetProperties(String name, List<String> values) Script hook use: Add entry with a list value.voidsetProperties(Map<Definition, List<String>> properties) Properties contain computed values that can be sent as RP attributes based on incoming CP attributes and userdetails.voidsetProperty(String name, String value) Script hook use: Add entry with a single valuevoidsetProperty(String name, String fqName, String value) Script hook use: Add entry with a single valuevoidsetQueriedStores(Set<String> queriedStores) Contains the stores of IDM lookups actually executed by the availableIdmQueryServiceimplementations - including those that did not find a result.voidsetResult(Definition definition, List<String> values) Set results with definition as key.voidsetResults(Map<Definition, List<String>> results) The results map contains these SAML attributes: CP SAML Response attributes extracted from the message (PassThrough Claims from CP) Derived attributes computed in ScriptService BeforeIdm hooks (Computed CP claims) IDM attributes retrieved from the IDMService Derived attributes computed in ScriptService AfterIdm hooks (Computed IDM claims) The names in this map are usually fully qualified as represented in the SAML response from the CP.voidsetRpContext(Map<String, String> rpContext) The HttpServletRequest params, some specific ones: username, Client_NetworkvoidsetRpContextClasses(List<String> rpContextClasses) Incoming context class requirements on RP side.voidsetRpDestination(String rpDestination) Override SAML Response.Destination on RP side.voidsetRpIssuer(String rpIssuer) Incoming issuer on RP side.voidsetRpRecipient(String rpRecipient) Override SAML SubjectConfirmationData.Recipient on RP side.voidsetRpReferer(String rpReferer) Incoming HTTP referrer on RP side.voidsetSubjectConfirmationMethod(String subjectConfirmationMethod) Subject confirmation method.voidsetUserDetail(String name, String value) Script hook use: Add user claim with a single value.voidsetUserDetail(String name, String fqName, String value) Script hook use: Add entry with a single value and a FQ name for outbound mapping.voidsetUserDetails(String name, String fqName, List<String> values) Script hook use: Set user claims with a list value and a FQ name.voidsetUserDetails(String name, List<String> values) Script hook use: Set user claims with a list value.voidsetUserDetails(Map<Definition, List<String>> userDetails) IDM user data returned from IDM backends, filtered by RP setup.voidScript hook use: Skip a particular IDM query.toString()Methods inherited from class swiss.trustbroker.saml.dto.ResponseStatus
abort, abort, abort, addFeatureCondition, addFeatureCondition, copyAbortConditions, doAppRedirect, featureCondition, featureConditions, featureConditions, featureConditions, featureConditionSet, getFeatureConditions, getFlowPolicy, getStatusCode, getStatusMessage, getStatusNestedCode, hasFeatureCondition, isAborted, nestedStatusCode, nestedStatusCode, removeFeatureCondition, resetErrorPageStatus, setFeatureConditions, setFlowPolicy, setStatusCode, setStatusMessage, setStatusNestedCode, showErrorPage, statusMessage, statusMessage, uiErrorCode, uiFlags
-
Constructor Details
-
CpResponse
-
CpResponse
public CpResponse() -
CpResponse
public CpResponse(String inResponseTo, String nameId, String originalNameId, String mappedNameId, String nameIdFormat, String subjectConfirmationMethod, String authStateInstant, List<String> contextClasses, String issuer, String homeName, String destination, String authLevel, String rpIssuer, String rpReferer, List<String> rpContextClasses, String rpDestination, String rpRecipient, String clientExtId, String clientName, String applicationName, String oidcClientId, Set<String> oidcScopes, String customIssuer, Map<String, String> rpContext, Map<Definition, List<String>> attributes, Map<Definition, List<String>> originalAttributes, IdmLookup idmLookup, Map<Definition, List<String>> userDetails, int originalUserDetailsCount, Map<Definition, List<String>> properties, int originalPropertiesCount, Map<Definition, List<String>> results, Map<String, Object> claims, Map<Object, Object> additionalIdmData, Set<String> queriedStores) Creates a newCpResponseinstance.- Parameters:
inResponseTo- ID of the authentication request that lead to this CP response.nameId- Subject name ID.originalNameId- CP Response incoming subject name ID used for internal processing.mappedNameId- CP Response incoming subject name ID after CP side subject name mapping.nameIdFormat- Format of the subject name ID.subjectConfirmationMethod- Subject confirmation method.authStateInstant- Issuing instant of authentication statement.contextClasses- Authentication context classes.issuer- CP Response issuer also referred to as HomeRealm.homeName- HomeName used by IdmService to query IDM.destination- AuthnRequest.AssertionConsumerUrl from our AuthnRequest.authLevel- Declared QoA CP side.rpIssuer- Incoming issuer on RP side.rpReferer- Incoming HTTP referrer on RP side.rpContextClasses- Incoming context class requirements on RP side.rpDestination- Override SAML Response.Destination on RP side.rpRecipient- Override SAML SubjectConfirmationData.Recipient on RP side.clientExtId- Retrieved IDM primary reference for internal reference.clientName- RelyingParty ClientName as used in the IDM credential SAML federation Issuer NameID.applicationName- RP/OIDC context sending 'SAML clientId' in ProviderName.oidcClientId- Incoming OIDC client_id.oidcScopes- Incoming OIDC scopes.customIssuer- Override RP response issuer.rpContext- The HttpServletRequest params, some specific ones: username, Client_Networkattributes- The attributes map contains these attributes:- CP SAML Response attributes extracted from the message
- Derived attributes computed in ScriptService BeforeIdm hooks
originalAttributes- Copy of Attributes before filtering. Necessary for SSOidmLookup- Contains theIdmLookupfor the corresponding RP. The query list can originate from Groovy scripts.userDetails- IDM user data returned from IDM backends, filtered by RP setup.originalUserDetailsCount-properties- Properties contain computed values that can be sent as RP attributes based on incoming CP attributes and userdetails. They are selected by thePropertiesSelectionconfiguration.originalPropertiesCount-results- The results map contains these SAML attributes:- CP SAML Response attributes extracted from the message (PassThrough Claims from CP)
- Derived attributes computed in ScriptService BeforeIdm hooks (Computed CP claims)
- IDM attributes retrieved from the IDMService
- Derived attributes computed in ScriptService AfterIdm hooks (Computed IDM claims)
claims- The claims map contains these OIDC claims:- Everything that was annotated with an oidcName in the configuration.
- All well known OIDC claims of the openid scope declared in AttributeName (StandardClaims).
- Everything added or removed in a OIDC OnToken groovy script hook.
additionalIdmData- Additional exchanged between related API implementations.
This data is not persisted.
The map key indicates the source of the value item.queriedStores- Contains the stores of IDM lookups actually executed by the availableIdmQueryServiceimplementations - including those that did not find a result.- Since:
- 1.10.0, 1.12.0
- See Also:
-
-
Method Details
-
getAttributes
Script hook: Get multi-valued CP/IDP claim- Specified by:
getAttributesin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getAttribute
Script hook: Get single-valued CP/IDP claim- Specified by:
getAttributein interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getAttributes
Script hook: Get multi-valued CP/IDP claim including source selector. Source CP and null are equivalent for the time being. Future extensions might add new sources.- Since:
- 1.11.0
-
getAttribute
Script hook: Get single-valued CP/IDP claim including source selector. Source CP and null are equivalent for the time being. Future extensions might add new sources.- Since:
- 1.11.0
-
setAttribute
Set single value attribute. -
setAttribute
Set single value attribute with namespace. -
setAttributes
Set multi-value attribute with namespace.- Since:
- 1.11.0
-
setAttributes
Set multi-value attribute. -
setAttributes
Set multi-value attribute with Definition key. -
addAttribute
Script hook: Add CP/IDP claim value to existing attribute or create entry. -
removeAttributes
Remove CP/IDP claim with name or FQ name. -
getUserDetails
Script hook use: get all values using name or FQ name.- Specified by:
getUserDetailsin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getUserDetail
Script hook use: Get first value using name or FQ name.- Specified by:
getUserDetailin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getUserDetails
Get values using name or FQ name with optional source.- Specified by:
getUserDetailsin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getUserDetail
Script hook use: Get first value using name or FQ name with optional source.- Specified by:
getUserDetailin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
removeUserDetails
Script hook use: Remove entry by name or FQ name. -
removeUserDetails
Script hook use: Remove entry by name or FQ name from the optional source. -
setUserDetail
Script hook use: Add entry with a single value and a FQ name for outbound mapping. -
setUserDetail
Script hook use: Add user claim with a single value.- Since:
- 1.11.0
-
addUserDetail
Script hook: Add value to existing user claim or create entry. -
addUserDetail
Script hook: Add value to existing user claim or create entry.- Since:
- 1.11.0
-
addUserDetail
Script hook: Add value or create entry with optional source. -
addUserDetailIfMissing
Add user details if not yet set.- Returns:
- true if added
-
setUserDetails
Script hook use: Set user claims with a list value.- Since:
- 1.11.0
-
setUserDetails
Script hook use: Set user claims with a list value and a FQ name. -
setResult
Set results with definition as key. -
skipQuery
Script hook use: Skip a particular IDM query. -
getProperties
Script hook use: Get property values by name or FQ name.- Specified by:
getPropertiesin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getProperty
Script hook use: Get first property value using name or FQ name.- Specified by:
getPropertyin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getProperties
Script hook use: Get property values by name or FQ name with optional source. As source cannot be set directly on this class the default source CP used by ClaimsPartyService and null are equivalent.- Specified by:
getPropertiesin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getProperty
Script hook use: Get first property value using name or FQ name with optional source. As source cannot be set directly on this class the default source CP used by ClaimsPartyService and null are equivalent.- Specified by:
getPropertyin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
removeProperty
Script hook use: Remove entry by name or FQ name. -
setProperties
Script hook use: Add CP/IDP claims with a list value.using FQ name. -
setProperties
Script hook use: Add entry with a list value.- Since:
- 1.11.0
-
setProperty
Script hook use: Add entry with a single value- Since:
- 1.11.0
-
setProperty
Script hook use: Add entry with a single value -
addPropertyIfMissing
Add property if not yet set.- Returns:
- true if added
-
addProperty
Script hook use: Add value to an already available list value or create.- Since:
- 1.11.0
-
addProperty
Script hook use: Add value to an already available list value or create. -
addProperties
Script hook use: Add values to an already available list value or create. -
getClaims
Get claims by name.nullis returned as empty list. -
getClaimList
Converts values to (possibly immutable) list if needed, empty list for null. -
getClaim
Get single value of by name. -
setClaim
Set claim value or values. -
setJsonClaim
Set claim value from collection or other value. -
setClaims
Set claim value or values. -
setClaimList
Converts values to (possibly immutable) list if needed, empty list for null. -
setJsonClaims
Set claim value from collection or other value. -
addClaim
Add claim. -
addJsonClaim
Add claim. -
addJsonClaim
Add claim with optional link to parent. -
setParsedJsonAsClaim
Parse value as JSON and add. -
addParsedJsonAsClaim
Parse value as JSON and add, with optional parent. -
removeClaim
Remove claim. -
getIssuerId
- Specified by:
getIssuerIdin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getAttributeMap
- Specified by:
getAttributeMapin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getPropertyMap
- Specified by:
getPropertyMapin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getUserDetailMap
- Specified by:
getUserDetailMapin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
hasOriginalNameId
public boolean hasOriginalNameId() -
getSsoSubjectFromCpResponse
-
cloneIdmLookup
-
builder
-
toBuilder
-
getInResponseTo
ID of the authentication request that lead to this CP response. -
getNameId
Subject name ID.- Specified by:
getNameIdin interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getOriginalNameId
CP Response incoming subject name ID used for internal processing. -
getMappedNameId
CP Response incoming subject name ID after CP side subject name mapping.- Since:
- 1.10.0
- See Also:
-
getNameIdFormat
Format of the subject name ID. -
getSubjectConfirmationMethod
Subject confirmation method. -
getAuthStateInstant
Issuing instant of authentication statement. -
getContextClasses
Authentication context classes. -
getIssuer
CP Response issuer also referred to as HomeRealm. -
getHomeName
HomeName used by IdmService to query IDM.- Specified by:
getHomeNamein interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getDestination
AuthnRequest.AssertionConsumerUrl from our AuthnRequest. -
getAuthLevel
Declared QoA CP side. -
getRpIssuer
Incoming issuer on RP side. -
getRpReferer
Incoming HTTP referrer on RP side. -
getRpContextClasses
Incoming context class requirements on RP side. -
getRpDestination
Override SAML Response.Destination on RP side. -
getRpRecipient
Override SAML SubjectConfirmationData.Recipient on RP side. -
getClientExtId
Retrieved IDM primary reference for internal reference. -
getClientName
RelyingParty ClientName as used in the IDM credential SAML federation Issuer NameID.- Specified by:
getClientNamein interfaceswiss.trustbroker.api.sessioncache.dto.CpResponseData
-
getApplicationName
RP/OIDC context sending 'SAML clientId' in ProviderName. -
getOidcClientId
Incoming OIDC client_id. -
getOidcScopes
Incoming OIDC scopes. -
getCustomIssuer
Override RP response issuer. -
getRpContext
The HttpServletRequest params, some specific ones: username, Client_Network -
getAttributes
The attributes map contains these attributes:- CP SAML Response attributes extracted from the message
- Derived attributes computed in ScriptService BeforeIdm hooks
-
getOriginalAttributes
Copy of Attributes before filtering. Necessary for SSO -
getIdmLookup
Contains theIdmLookupfor the corresponding RP. The query list can originate from Groovy scripts. -
getUserDetails
IDM user data returned from IDM backends, filtered by RP setup. -
getOriginalUserDetailsCount
public int getOriginalUserDetailsCount() -
getProperties
Properties contain computed values that can be sent as RP attributes based on incoming CP attributes and userdetails. They are selected by thePropertiesSelectionconfiguration. -
getOriginalPropertiesCount
public int getOriginalPropertiesCount() -
getResults
The results map contains these SAML attributes:- CP SAML Response attributes extracted from the message (PassThrough Claims from CP)
- Derived attributes computed in ScriptService BeforeIdm hooks (Computed CP claims)
- IDM attributes retrieved from the IDMService
- Derived attributes computed in ScriptService AfterIdm hooks (Computed IDM claims)
-
getClaims
The claims map contains these OIDC claims:- Everything that was annotated with an oidcName in the configuration.
- All well known OIDC claims of the openid scope declared in AttributeName (StandardClaims).
- Everything added or removed in a OIDC OnToken groovy script hook.
-
getAdditionalIdmData
Additional exchanged between related API implementations.
This data is not persisted.
The map key indicates the source of the value item.- See Also:
-
getQueriedStores
Contains the stores of IDM lookups actually executed by the availableIdmQueryServiceimplementations - including those that did not find a result.- Since:
- 1.12.0
- See Also:
-
setInResponseTo
ID of the authentication request that lead to this CP response. -
setNameId
Subject name ID. -
setOriginalNameId
CP Response incoming subject name ID used for internal processing. -
setMappedNameId
CP Response incoming subject name ID after CP side subject name mapping.- Since:
- 1.10.0
- See Also:
-
setNameIdFormat
Format of the subject name ID. -
setSubjectConfirmationMethod
Subject confirmation method. -
setAuthStateInstant
Issuing instant of authentication statement. -
setContextClasses
Authentication context classes. -
setIssuer
CP Response issuer also referred to as HomeRealm. -
setHomeName
HomeName used by IdmService to query IDM. -
setDestination
AuthnRequest.AssertionConsumerUrl from our AuthnRequest. -
setAuthLevel
Declared QoA CP side. -
setRpIssuer
Incoming issuer on RP side. -
setRpReferer
Incoming HTTP referrer on RP side. -
setRpContextClasses
Incoming context class requirements on RP side. -
setRpDestination
Override SAML Response.Destination on RP side. -
setRpRecipient
Override SAML SubjectConfirmationData.Recipient on RP side. -
setClientExtId
Retrieved IDM primary reference for internal reference. -
setClientName
RelyingParty ClientName as used in the IDM credential SAML federation Issuer NameID. -
setApplicationName
RP/OIDC context sending 'SAML clientId' in ProviderName. -
setOidcClientId
Incoming OIDC client_id. -
setOidcScopes
Incoming OIDC scopes. -
setCustomIssuer
Override RP response issuer. -
setRpContext
The HttpServletRequest params, some specific ones: username, Client_Network -
setAttributes
The attributes map contains these attributes:- CP SAML Response attributes extracted from the message
- Derived attributes computed in ScriptService BeforeIdm hooks
-
setOriginalAttributes
Copy of Attributes before filtering. Necessary for SSO -
setIdmLookup
Contains theIdmLookupfor the corresponding RP. The query list can originate from Groovy scripts. -
setUserDetails
IDM user data returned from IDM backends, filtered by RP setup. -
setOriginalUserDetailsCount
public void setOriginalUserDetailsCount(int originalUserDetailsCount) -
setProperties
Properties contain computed values that can be sent as RP attributes based on incoming CP attributes and userdetails. They are selected by thePropertiesSelectionconfiguration. -
setOriginalPropertiesCount
public void setOriginalPropertiesCount(int originalPropertiesCount) -
setResults
The results map contains these SAML attributes:- CP SAML Response attributes extracted from the message (PassThrough Claims from CP)
- Derived attributes computed in ScriptService BeforeIdm hooks (Computed CP claims)
- IDM attributes retrieved from the IDMService
- Derived attributes computed in ScriptService AfterIdm hooks (Computed IDM claims)
-
setClaims
The claims map contains these OIDC claims:- Everything that was annotated with an oidcName in the configuration.
- All well known OIDC claims of the openid scope declared in AttributeName (StandardClaims).
- Everything added or removed in a OIDC OnToken groovy script hook.
-
setAdditionalIdmData
Additional exchanged between related API implementations.
This data is not persisted.
The map key indicates the source of the value item.- See Also:
-
setQueriedStores
Contains the stores of IDM lookups actually executed by the availableIdmQueryServiceimplementations - including those that did not find a result.- Since:
- 1.12.0
- See Also:
-
toString
- Overrides:
toStringin classResponseStatus
-
equals
- Overrides:
equalsin classResponseStatus
-
canEqual
- Overrides:
canEqualin classResponseStatus
-
hashCode
public int hashCode()- Overrides:
hashCodein classResponseStatus
-