Skip to content

Commit 8a2d967

Browse files
committed
add javadocs + getTransport -> getAuthTransport.
1 parent f36a19c commit 8a2d967

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ private ComputeEngineCredentials(ComputeEngineCredentials.Builder builder) {
189189
scopeList.removeAll(Arrays.asList("", null));
190190
this.scopes = ImmutableSet.<String>copyOf(scopeList);
191191
}
192-
this.transport = builder.getTransport();
192+
this.transport = builder.getAuthTransport();
193193
this.bindingEnforcement = builder.getBindingEnforcement();
194194
}
195195

@@ -735,12 +735,22 @@ public Builder setQuotaProjectId(String quotaProjectId) {
735735
return this;
736736
}
737737

738+
/**
739+
* Set the {@code AuthTransport} type.
740+
*
741+
* @param transport the transport type over which to authenticate to Google APIs
742+
*/
738743
@CanIgnoreReturnValue
739-
public Builder setTransport(AuthTransport transport) {
744+
public Builder setAuthTransport(AuthTransport transport) {
740745
this.transport = transport;
741746
return this;
742747
}
743748

749+
/**
750+
* Set the {@code BindingEnforcement} type.
751+
*
752+
* @param bindingEnforcement the token binding enforcement policy.
753+
*/
744754
@CanIgnoreReturnValue
745755
public Builder setBindingEnforcement(BindingEnforcement bindingEnforcement) {
746756
this.bindingEnforcement = bindingEnforcement;
@@ -759,10 +769,20 @@ public Collection<String> getDefaultScopes() {
759769
return defaultScopes;
760770
}
761771

762-
public AuthTransport getTransport() {
772+
/**
773+
* Get the {@code AuthTransport} type.
774+
*
775+
* @return the transport type over which to authenticate to Google APIs
776+
*/
777+
public AuthTransport getAuthTransport() {
763778
return transport;
764779
}
765780

781+
/**
782+
* Get the {@code BindingEnforcement} type.
783+
*
784+
* @return the token binding enforcement policy.
785+
*/
766786
public BindingEnforcement getBindingEnforcement() {
767787
return bindingEnforcement;
768788
}

oauth2_http/javatests/com/google/auth/oauth2/ComputeEngineCredentialsTest.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ public void buildTokenUrlWithScopes_defaultScopes() {
194194
public void buildTokenUrl_nullTransport() {
195195
ComputeEngineCredentials credentials =
196196
ComputeEngineCredentials.newBuilder()
197-
.setTransport(null)
197+
.setAuthTransport(null)
198198
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
199199
.build();
200200
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -206,7 +206,7 @@ public void buildTokenUrl_nullTransport() {
206206
public void buildTokenUrl_nullBindingEnforcement() {
207207
ComputeEngineCredentials credentials =
208208
ComputeEngineCredentials.newBuilder()
209-
.setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
209+
.setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
210210
.setBindingEnforcement(null)
211211
.build();
212212
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -218,7 +218,7 @@ public void buildTokenUrl_nullBindingEnforcement() {
218218
public void buildTokenUrlSoftMtlsBound_mtls_transport() {
219219
ComputeEngineCredentials credentials =
220220
ComputeEngineCredentials.newBuilder()
221-
.setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
221+
.setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
222222
.build();
223223
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
224224

@@ -240,7 +240,7 @@ public void buildTokenUrlSoftMtlsBound_iam_enforcement() {
240240
public void buildTokenUrlSoftMtlsBound_mtls_transport_iam_enforcement() {
241241
ComputeEngineCredentials credentials =
242242
ComputeEngineCredentials.newBuilder()
243-
.setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
243+
.setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
244244
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.IAM_POLICY)
245245
.build();
246246
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -263,7 +263,7 @@ public void buildTokenUrlHardMtlsBound_always_enforced() {
263263
public void buildTokenUrlHardMtlsBound_mtls_transport_always_enforced() {
264264
ComputeEngineCredentials credentials =
265265
ComputeEngineCredentials.newBuilder()
266-
.setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
266+
.setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
267267
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
268268
.build();
269269
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -275,7 +275,7 @@ public void buildTokenUrlHardMtlsBound_mtls_transport_always_enforced() {
275275
public void buildTokenUrlHardDirectPathBound_alts_transport() {
276276
ComputeEngineCredentials credentials =
277277
ComputeEngineCredentials.newBuilder()
278-
.setTransport(ComputeEngineCredentials.AuthTransport.ALTS)
278+
.setAuthTransport(ComputeEngineCredentials.AuthTransport.ALTS)
279279
.build();
280280
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
281281

0 commit comments

Comments
 (0)