Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-07-04 09:42:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Polish Javadoc

Browse Source 
Issue gh-6019
This commit is contained in:
Josh Cummings 2020-07-28 16:04:06 -06:00
parent 104d785210
commit a32de931d3
No known key found for this signature in database
GPG Key ID: 49EF60DD7FF83443
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2020 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -17,20 +17,19 @@
package org.springframework.security.saml2.provider.service.registration; package org.springframework.security.saml2.provider.service.registration;
/** /**
* Resolves a {@link RelyingPartyRegistration}, a configured service provider and remote identity provider pair * A repository for {@link RelyingPartyRegistration}s
* based on a unique registrationId. *
* @since 5.2 * @since 5.2
* @author Filip Hanik
*/ */
public interface RelyingPartyRegistrationRepository { public interface RelyingPartyRegistrationRepository {
/** /**
* Resolves an {@link RelyingPartyRegistration} by registrationId, or returns the default provider * Returns the relying party registration identified by the provided {@code registrationId},
* if no registrationId is provided * or {@code null} if not found.
* *
* @param registrationId - a provided registrationId, may be be null or empty * @param registrationId the registration identifier
* @return {@link RelyingPartyRegistration} if found, {@code null} if an registrationId is provided and * @return the {@link RelyingPartyRegistration} if found, otherwise {@code null}
* no registration is found. Returns a default, implementation specific,
* {@link RelyingPartyRegistration} if no registrationId is provided
*/ */
RelyingPartyRegistration findByRegistrationId(String registrationId); RelyingPartyRegistration findByRegistrationId(String registrationId);