Package org.springframework.security.saml2.provider.service.registration

Class OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter

java.lang.Object

org.springframework.security.saml2.provider.service.registration.OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter

All Implemented Interfaces:

org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

public class OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter
extends java.lang.Object
implements org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

An HttpMessageConverter that takes an IDPSSODescriptor in an HTTP response and converts it into a RelyingPartyRegistration.Builder. The primary use case for this is constructing a RelyingPartyRegistration for inclusion in a RelyingPartyRegistrationRepository. To do so, you can include an instance of this converter in a RestOperations like so:

                RestOperations rest = new RestTemplate(Collections.singletonList(
                        new RelyingPartyRegistrationsBuilderHttpMessageConverter()));
                RelyingPartyRegistration.Builder builder = rest.getForObject
                                ("https://idp.example.org/metadata", RelyingPartyRegistration.Builder.class);
                RelyingPartyRegistration registration = builder.registrationId("registration-id").build();
 

Note that this will only configure the asserting party (IDP) half of the RelyingPartyRegistration, meaning where and how to send AuthnRequests, how to verify Assertions, etc. To further configure the RelyingPartyRegistration with relying party (SP) information, you may invoke the appropriate methods on the builder.

Since:

5.4

Constructor Summary

Constructors

Constructor	Description
OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter()	Creates a OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter

Method Summary

Modifier and Type	Method	Description
boolean	canRead(java.lang.Class<?> clazz, org.springframework.http.MediaType mediaType)
boolean	canWrite(java.lang.Class<?> clazz, org.springframework.http.MediaType mediaType)
java.util.List<org.springframework.http.MediaType>	getSupportedMediaTypes()
RelyingPartyRegistration.Builder	read(java.lang.Class<? extends RelyingPartyRegistration.Builder> clazz, org.springframework.http.HttpInputMessage inputMessage)
void	write(RelyingPartyRegistration.Builder builder, org.springframework.http.MediaType contentType, org.springframework.http.HttpOutputMessage outputMessage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

getSupportedMediaTypes

Constructor Detail

OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter

public OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter()

Creates a OpenSamlRelyingPartyRegistrationBuilderHttpMessageConverter

Method Detail

canRead

public boolean canRead(java.lang.Class<?> clazz,
                       org.springframework.http.MediaType mediaType)

Specified by:

canRead in interface org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

canWrite

public boolean canWrite(java.lang.Class<?> clazz,
                        org.springframework.http.MediaType mediaType)

Specified by:

canWrite in interface org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

getSupportedMediaTypes

public java.util.List<org.springframework.http.MediaType> getSupportedMediaTypes()

Specified by:

getSupportedMediaTypes in interface org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

read

public RelyingPartyRegistration.Builder read(java.lang.Class<? extends RelyingPartyRegistration.Builder> clazz,
                                             org.springframework.http.HttpInputMessage inputMessage)
                                      throws java.io.IOException,
                                             org.springframework.http.converter.HttpMessageNotReadableException

Specified by:

read in interface org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

Throws:

java.io.IOException

org.springframework.http.converter.HttpMessageNotReadableException

write

public void write(RelyingPartyRegistration.Builder builder,
                  org.springframework.http.MediaType contentType,
                  org.springframework.http.HttpOutputMessage outputMessage)
           throws org.springframework.http.converter.HttpMessageNotWritableException

Specified by:

write in interface org.springframework.http.converter.HttpMessageConverter<RelyingPartyRegistration.Builder>

Throws:

org.springframework.http.converter.HttpMessageNotWritableException