|
| 1 | +/* |
| 2 | + * Copyright 2002-2019 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package org.springframework.security.oauth2.client; |
| 17 | + |
| 18 | +import org.springframework.lang.Nullable; |
| 19 | +import org.springframework.security.core.Authentication; |
| 20 | +import org.springframework.security.oauth2.client.registration.ClientRegistration; |
| 21 | +import org.springframework.util.Assert; |
| 22 | +import org.springframework.util.CollectionUtils; |
| 23 | + |
| 24 | +import java.util.Collections; |
| 25 | +import java.util.HashMap; |
| 26 | +import java.util.LinkedHashMap; |
| 27 | +import java.util.Map; |
| 28 | + |
| 29 | +/** |
| 30 | + * Represents a request the {@link OAuth2AuthorizedClientManager} uses to |
| 31 | + * {@link OAuth2AuthorizedClientManager#authorize(OAuth2AuthorizeRequest) authorize} (or re-authorize) |
| 32 | + * the {@link ClientRegistration client} identified by the provided {@link #getClientRegistrationId() clientRegistrationId}. |
| 33 | + * |
| 34 | + * @author Joe Grandja |
| 35 | + * @since 5.2 |
| 36 | + * @see OAuth2AuthorizedClientManager |
| 37 | + */ |
| 38 | +public final class OAuth2AuthorizeRequest { |
| 39 | + private String clientRegistrationId; |
| 40 | + private OAuth2AuthorizedClient authorizedClient; |
| 41 | + private Authentication principal; |
| 42 | + private Map<String, Object> attributes; |
| 43 | + |
| 44 | + private OAuth2AuthorizeRequest() { |
| 45 | + } |
| 46 | + |
| 47 | + /** |
| 48 | + * Returns the identifier for the {@link ClientRegistration client registration}. |
| 49 | + * |
| 50 | + * @return the identifier for the client registration |
| 51 | + */ |
| 52 | + public String getClientRegistrationId() { |
| 53 | + return this.clientRegistrationId; |
| 54 | + } |
| 55 | + |
| 56 | + /** |
| 57 | + * Returns the {@link OAuth2AuthorizedClient authorized client} or {@code null} if it was not provided. |
| 58 | + * |
| 59 | + * @return the {@link OAuth2AuthorizedClient} or {@code null} if it was not provided |
| 60 | + */ |
| 61 | + @Nullable |
| 62 | + public OAuth2AuthorizedClient getAuthorizedClient() { |
| 63 | + return this.authorizedClient; |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Returns the {@code Principal} (to be) associated to the authorized client. |
| 68 | + * |
| 69 | + * @return the {@code Principal} (to be) associated to the authorized client |
| 70 | + */ |
| 71 | + public Authentication getPrincipal() { |
| 72 | + return this.principal; |
| 73 | + } |
| 74 | + |
| 75 | + /** |
| 76 | + * Returns the attributes associated to the request. |
| 77 | + * |
| 78 | + * @return a {@code Map} of the attributes associated to the request |
| 79 | + */ |
| 80 | + public Map<String, Object> getAttributes() { |
| 81 | + return this.attributes; |
| 82 | + } |
| 83 | + |
| 84 | + /** |
| 85 | + * Returns the value of an attribute associated to the request or {@code null} if not available. |
| 86 | + * |
| 87 | + * @param name the name of the attribute |
| 88 | + * @param <T> the type of the attribute |
| 89 | + * @return the value of the attribute associated to the request |
| 90 | + */ |
| 91 | + @Nullable |
| 92 | + @SuppressWarnings("unchecked") |
| 93 | + public <T> T getAttribute(String name) { |
| 94 | + return (T) this.getAttributes().get(name); |
| 95 | + } |
| 96 | + |
| 97 | + /** |
| 98 | + * Returns a new {@link Builder} initialized with the identifier for the {@link ClientRegistration client registration}. |
| 99 | + * |
| 100 | + * @param clientRegistrationId the identifier for the {@link ClientRegistration client registration} |
| 101 | + * @return the {@link Builder} |
| 102 | + */ |
| 103 | + public static Builder withClientRegistrationId(String clientRegistrationId) { |
| 104 | + return new Builder(clientRegistrationId); |
| 105 | + } |
| 106 | + |
| 107 | + /** |
| 108 | + * Returns a new {@link Builder} initialized with the {@link OAuth2AuthorizedClient authorized client}. |
| 109 | + * |
| 110 | + * @param authorizedClient the {@link OAuth2AuthorizedClient authorized client} |
| 111 | + * @return the {@link Builder} |
| 112 | + */ |
| 113 | + public static Builder withAuthorizedClient(OAuth2AuthorizedClient authorizedClient) { |
| 114 | + return new Builder(authorizedClient); |
| 115 | + } |
| 116 | + |
| 117 | + /** |
| 118 | + * A builder for {@link OAuth2AuthorizeRequest}. |
| 119 | + */ |
| 120 | + public static class Builder { |
| 121 | + private String clientRegistrationId; |
| 122 | + private OAuth2AuthorizedClient authorizedClient; |
| 123 | + private Authentication principal; |
| 124 | + private Map<String, Object> attributes; |
| 125 | + |
| 126 | + private Builder(String clientRegistrationId) { |
| 127 | + Assert.hasText(clientRegistrationId, "clientRegistrationId cannot be empty"); |
| 128 | + this.clientRegistrationId = clientRegistrationId; |
| 129 | + } |
| 130 | + |
| 131 | + private Builder(OAuth2AuthorizedClient authorizedClient) { |
| 132 | + Assert.notNull(authorizedClient, "authorizedClient cannot be null"); |
| 133 | + this.authorizedClient = authorizedClient; |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Sets the {@code Principal} (to be) associated to the authorized client. |
| 138 | + * |
| 139 | + * @param principal the {@code Principal} (to be) associated to the authorized client |
| 140 | + * @return the {@link Builder} |
| 141 | + */ |
| 142 | + public Builder principal(Authentication principal) { |
| 143 | + this.principal = principal; |
| 144 | + return this; |
| 145 | + } |
| 146 | + |
| 147 | + /** |
| 148 | + * Sets the attributes associated to the request. |
| 149 | + * |
| 150 | + * @param attributes the attributes associated to the request |
| 151 | + * @return the {@link Builder} |
| 152 | + */ |
| 153 | + public Builder attributes(Map<String, Object> attributes) { |
| 154 | + this.attributes = attributes; |
| 155 | + return this; |
| 156 | + } |
| 157 | + |
| 158 | + /** |
| 159 | + * Sets an attribute associated to the request. |
| 160 | + * |
| 161 | + * @param name the name of the attribute |
| 162 | + * @param value the value of the attribute |
| 163 | + * @return the {@link Builder} |
| 164 | + */ |
| 165 | + public Builder attribute(String name, Object value) { |
| 166 | + if (this.attributes == null) { |
| 167 | + this.attributes = new HashMap<>(); |
| 168 | + } |
| 169 | + this.attributes.put(name, value); |
| 170 | + return this; |
| 171 | + } |
| 172 | + |
| 173 | + /** |
| 174 | + * Builds a new {@link OAuth2AuthorizeRequest}. |
| 175 | + * |
| 176 | + * @return a {@link OAuth2AuthorizeRequest} |
| 177 | + */ |
| 178 | + public OAuth2AuthorizeRequest build() { |
| 179 | + Assert.notNull(this.principal, "principal cannot be null"); |
| 180 | + OAuth2AuthorizeRequest authorizeRequest = new OAuth2AuthorizeRequest(); |
| 181 | + if (this.authorizedClient != null) { |
| 182 | + authorizeRequest.clientRegistrationId = this.authorizedClient.getClientRegistration().getRegistrationId(); |
| 183 | + authorizeRequest.authorizedClient = this.authorizedClient; |
| 184 | + } else { |
| 185 | + authorizeRequest.clientRegistrationId = this.clientRegistrationId; |
| 186 | + } |
| 187 | + authorizeRequest.principal = this.principal; |
| 188 | + authorizeRequest.attributes = Collections.unmodifiableMap( |
| 189 | + CollectionUtils.isEmpty(this.attributes) ? |
| 190 | + Collections.emptyMap() : new LinkedHashMap<>(this.attributes)); |
| 191 | + return authorizeRequest; |
| 192 | + } |
| 193 | + } |
| 194 | +} |
0 commit comments