org.keycloak.protocol.saml

Interface ArtifactResolver

All Superinterfaces:

Provider

All Known Implementing Classes:

DefaultSamlArtifactResolver

public interface ArtifactResolver
extends Provider

Provides a way to create and resolve artifacts for SAML Artifact binding

Method Summary

Modifier and Type	Method and Description
String	buildArtifact(AuthenticatedClientSessionModel clientSessionModel, String entityId, String artifactResponse) Creates and stores an artifact
String	resolveArtifact(AuthenticatedClientSessionModel clientSessionModel, String artifact) Returns a serialized Saml ArtifactResponse corresponding to the artifact that was created by buildArtifact
ClientModel	selectSourceClient(KeycloakSession session, String artifact) Returns client model that issued artifact

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

selectSourceClient

ClientModel selectSourceClient(KeycloakSession session,
                               String artifact)
                        throws ArtifactResolverProcessingException

Returns client model that issued artifact

Parameters:

session - KeycloakSession for searching for client corresponding client

artifact - the artifact

Returns:

the client model that issued the artifact

Throws:

ArtifactResolverProcessingException - When an error occurs during client search

buildArtifact

String buildArtifact(AuthenticatedClientSessionModel clientSessionModel,
                     String entityId,
                     String artifactResponse)
              throws ArtifactResolverProcessingException

Creates and stores an artifact

Parameters:

clientSessionModel - client session model that can be used for storing the response for artifact

entityId - id of an issuer that issued the artifactResponse

artifactResponse - serialized Saml ArtifactResponse that represents the response for created artifact

Returns:

the artifact

Throws:

ArtifactResolverProcessingException - When an error occurs during creation of the artifact.

resolveArtifact

String resolveArtifact(AuthenticatedClientSessionModel clientSessionModel,
                       String artifact)
                throws ArtifactResolverProcessingException

Returns a serialized Saml ArtifactResponse corresponding to the artifact that was created by buildArtifact

Parameters:

clientSessionModel - client session model that can be used for obtaining the artifact response

artifact - the artifact

Returns:

serialized Saml ArtifactResponse corresponding to the artifact

Throws:

ArtifactResolverProcessingException - When an error occurs during resolution of the artifact.