-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add oauth client credentials to connectivity model
Signed-off-by: Dominik Guggemos <dominik.guggemos@bosch.io>
- Loading branch information
Showing
15 changed files
with
434 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
241 changes: 241 additions & 0 deletions
241
...vity/model/src/main/java/org/eclipse/ditto/connectivity/model/OAuthClientCredentials.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,241 @@ | ||
| /* | ||
| * Copyright (c) 2019 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.ditto.connectivity.model; | ||
|
|
||
| import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| import javax.annotation.concurrent.Immutable; | ||
|
|
||
| import org.eclipse.ditto.json.JsonFactory; | ||
| import org.eclipse.ditto.json.JsonFieldDefinition; | ||
| import org.eclipse.ditto.json.JsonObject; | ||
| import org.eclipse.ditto.json.JsonObjectBuilder; | ||
|
|
||
| /** | ||
| * Credentials used to retrieve a new access token using client credentials flow with the given | ||
| * client id, secret and scope. | ||
| * | ||
| * @since 2.2.0 | ||
| */ | ||
| @Immutable | ||
| public final class OAuthClientCredentials implements Credentials { | ||
|
|
||
| /** | ||
| * Credential type name. | ||
| */ | ||
| public static final String TYPE = "oauth-client-credentials"; | ||
|
|
||
| private final String tokenEndpoint; | ||
| private final String clientId; | ||
| private final String clientSecret; | ||
| private final String scope; | ||
|
|
||
| private OAuthClientCredentials(final String tokenEndpoint, final String clientId, final String clientSecret, | ||
| final String scope) { | ||
| this.tokenEndpoint = tokenEndpoint; | ||
| this.clientId = clientId; | ||
| this.clientSecret = clientSecret; | ||
| this.scope = scope; | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T accept(final CredentialsVisitor<T> visitor) { | ||
| return visitor.oauthClientCredentials(this); | ||
| } | ||
|
|
||
| /** | ||
| * @return the token endpoint | ||
| */ | ||
| public String getTokenEndpoint() { | ||
| return tokenEndpoint; | ||
| } | ||
|
|
||
| /** | ||
| * @return the client id | ||
| */ | ||
| public String getClientId() { | ||
| return clientId; | ||
| } | ||
|
|
||
| /** | ||
| * @return the client secret | ||
| */ | ||
| public String getClientSecret() { | ||
| return clientSecret; | ||
| } | ||
|
|
||
| /** | ||
| * @return the scope | ||
| */ | ||
| public String getScope() { | ||
| return scope; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(final Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| final OAuthClientCredentials that = (OAuthClientCredentials) o; | ||
| return tokenEndpoint.equals(that.tokenEndpoint) && clientId.equals(that.clientId) && | ||
| clientSecret.equals(that.clientSecret) && scope.equals(that.scope); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(tokenEndpoint, clientId, clientSecret, scope); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return getClass().getSimpleName() + " [" + | ||
| "tokenEndpoint=" + tokenEndpoint + | ||
| ", clientId=" + clientId + | ||
| ", clientSecret=" + clientSecret + | ||
| ", scope=" + scope + | ||
| "]"; | ||
| } | ||
|
|
||
| @Override | ||
| public JsonObject toJson() { | ||
| final JsonObjectBuilder jsonObjectBuilder = JsonFactory.newObjectBuilder(); | ||
| jsonObjectBuilder.set(Credentials.JsonFields.TYPE, TYPE); | ||
| jsonObjectBuilder.set(JsonFields.TOKEN_ENDPOINT, tokenEndpoint, Objects::nonNull); | ||
| jsonObjectBuilder.set(JsonFields.CLIENT_ID, clientId, Objects::nonNull); | ||
| jsonObjectBuilder.set(JsonFields.CLIENT_SECRET, clientSecret, Objects::nonNull); | ||
| jsonObjectBuilder.set(JsonFields.SCOPE, scope, Objects::nonNull); | ||
| return jsonObjectBuilder.build(); | ||
| } | ||
|
|
||
| static OAuthClientCredentials fromJson(final JsonObject jsonObject) { | ||
| final Builder builder = newBuilder(); | ||
| jsonObject.getValue(JsonFields.TOKEN_ENDPOINT).ifPresent(builder::tokenEndpoint); | ||
| jsonObject.getValue(JsonFields.CLIENT_ID).ifPresent(builder::clientId); | ||
| jsonObject.getValue(JsonFields.CLIENT_SECRET).ifPresent(builder::clientSecret); | ||
| jsonObject.getValue(JsonFields.SCOPE).ifPresent(builder::scope); | ||
| return builder.build(); | ||
| } | ||
|
|
||
| /** | ||
| * Create empty credentials with no certificates. | ||
| * | ||
| * @return empty credentials. | ||
| */ | ||
| public static OAuthClientCredentials empty() { | ||
| return newBuilder().build(); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new builder initialized with fields of this object. | ||
| * | ||
| * @return a new builder. | ||
| */ | ||
| public Builder toBuilder() { | ||
| return new Builder().clientId(clientId).clientSecret(clientSecret).tokenEndpoint(tokenEndpoint).scope(scope); | ||
| } | ||
|
|
||
| /** | ||
| * Create an empty builder. | ||
| * | ||
| * @return a new builder. | ||
| */ | ||
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| /** | ||
| * Builder of {@code X509Credentials}. | ||
| */ | ||
| public static final class Builder { | ||
|
|
||
| private String tokenEndpoint; | ||
| private String clientId; | ||
| private String clientSecret; | ||
| private String scope; | ||
|
|
||
| /** | ||
| * @param tokenEndpoint the token endpoint | ||
| * @return this builder | ||
| */ | ||
| public Builder tokenEndpoint(final String tokenEndpoint) { | ||
| this.tokenEndpoint = checkNotNull(tokenEndpoint, "tokenEndpoint"); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @param clientId the clientId | ||
| * @return this builder | ||
| */ | ||
| public Builder clientId(final String clientId) { | ||
| this.clientId = checkNotNull(clientId, "clientId"); | ||
| ; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @param clientSecret the clientSecret | ||
| * @return this builder | ||
| */ | ||
| public Builder clientSecret(final String clientSecret) { | ||
| this.clientSecret = checkNotNull(clientSecret, "clientSecret"); | ||
| ; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @param scope the scope | ||
| * @return this builder | ||
| */ | ||
| public Builder scope(final String scope) { | ||
| this.scope = checkNotNull(scope, "scope"); | ||
| ; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Build a new {@code OAuthClientCredentials}. | ||
| * | ||
| * @return the credentials. | ||
| */ | ||
| public OAuthClientCredentials build() { | ||
| return new OAuthClientCredentials(tokenEndpoint, clientId, clientSecret, scope); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * JSON field definitions. | ||
| */ | ||
| public static final class JsonFields extends Credentials.JsonFields { | ||
|
|
||
| /** | ||
| * JSON field definition of OAuth token endpoint. | ||
| */ | ||
| public static final JsonFieldDefinition<String> TOKEN_ENDPOINT = JsonFieldDefinition.ofString("tokenEndpoint"); | ||
|
|
||
| /** | ||
| * JSON field definition of client ID. | ||
| */ | ||
| public static final JsonFieldDefinition<String> CLIENT_ID = JsonFieldDefinition.ofString("id"); | ||
|
|
||
| /** | ||
| * JSON field definition of client secret. | ||
| */ | ||
| public static final JsonFieldDefinition<String> CLIENT_SECRET = JsonFieldDefinition.ofString("secret"); | ||
|
|
||
| /** | ||
| * JSON field definition of scope. | ||
| */ | ||
| public static final JsonFieldDefinition<String> SCOPE = JsonFieldDefinition.ofString("scope"); | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
.../model/src/test/java/org/eclipse/ditto/connectivity/model/OAuthClientCredentialsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright (c) 2021 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.ditto.connectivity.model; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mutabilitydetector.unittesting.MutabilityAssert.assertInstancesOf; | ||
| import static org.mutabilitydetector.unittesting.MutabilityMatchers.areImmutable; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| import nl.jqno.equalsverifier.EqualsVerifier; | ||
|
|
||
| /** | ||
| * Tests {@link org.eclipse.ditto.connectivity.model.OAuthClientCredentials}. | ||
| */ | ||
| public final class OAuthClientCredentialsTest { | ||
|
|
||
| @Test | ||
| public void testHashCodeAndEquals() { | ||
| EqualsVerifier.forClass(OAuthClientCredentials.class).verify(); | ||
| } | ||
|
|
||
| @Test | ||
| public void assertImmutability() { | ||
| assertInstancesOf(OAuthClientCredentials.class, areImmutable()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testJsonSerialization() { | ||
| final Credentials original = OAuthClientCredentials.newBuilder().clientId("clientId").clientSecret( | ||
| "clientSecret").scope("scope").tokenEndpoint("http://localhost/token").build(); | ||
| final Credentials deserialized = Credentials.fromJson(original.toJson()); | ||
| assertThat(deserialized).isEqualTo(original); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.