Skip to content

Commit 6f7a045

Browse files
isevdalinosapisevdalinosap
authored
Transparent proxy: Fix transparent proxy builders naming (#926)
1 parent 6d1f957 commit 6f7a045

File tree

3 files changed

+67
-67
lines changed

3 files changed

+67
-67
lines changed

‎cloudplatform/connectivity-destination-service/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/TransparentProxyDestination.java‎

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626
import lombok.extern.slf4j.Slf4j;
2727

2828
/**
29-
* Immutable implementation of the {@link HttpDestination} interface.
30-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-for-kubernetes
29+
* * Immutable implementation of the {@link HttpDestination} interface for using the
30+
* <a href="https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-for-kubernetes">transparent
31+
* proxy</a>.
3132
*/
3233
@Slf4j
33-
@com.google.common.annotations.Beta
3434
public class TransparentProxyDestination implements HttpDestination
3535
{
3636
static final String DESTINATION_NAME_HEADER_KEY = "x-destination-name";
@@ -249,14 +249,12 @@ public static Builder destination( @Nonnull final String uri )
249249
*
250250
* @param destinationName
251251
* The name of the destination to be resolved by the gateway.
252-
* @return A new {@link DestinationGatewayBuilder} instance.
252+
* @return A new {@link GatewayBuilder} instance.
253253
*/
254254
@Nonnull
255-
public static
256-
DestinationGatewayBuilder
257-
destinationGateway( @Nonnull final String destinationName, @Nonnull final String uri )
255+
public static GatewayBuilder gateway( @Nonnull final String destinationName, @Nonnull final String uri )
258256
{
259-
return new DestinationGatewayBuilder(destinationName, uri);
257+
return new GatewayBuilder(destinationName, uri);
260258
}
261259

262260
/**
@@ -363,8 +361,8 @@ public B header( @Nonnull final String headerName, @Nonnull final String headerV
363361
}
364362

365363
/**
366-
* Adds a tenant subdomain header to the destination. See
367-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy
364+
* Adds a tenant subdomain header to the destination. See <a href=
365+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy</a>
368366
* <p>
369367
* Note: Tenant subdomain and tenant ID cannot be set at the same time. Calling this method when a tenant ID
370368
* header is already present will throw an exception.
@@ -387,8 +385,8 @@ public B tenantSubdomain( @Nonnull final String tenantSubdomain )
387385

388386
/**
389387
* Adds a tenant ID header to the destination. Set automatically by the Cloud SDK per-request, if both tenant id
390-
* and tenant subdomain are left unset. See
391-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy
388+
* and tenant subdomain are left unset. See <a href=
389+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy</a>
392390
* <p>
393391
* Note: Tenant subdomain and tenant ID cannot be set at the same time. Calling this method when a tenant ID
394392
* header is already present will throw an exception.
@@ -410,9 +408,10 @@ public B tenantId( @Nonnull final String tenantId )
410408

411409
/**
412410
* Adds a token service tenant header to the destination. Is send to the destination service as x-tenant header
413-
* and should be used when tokenServiceURLType in the destination service is common. See
414-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/technical-user-propagation and
415-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-client-credentials-authentication-cf15900ca39242fb87a1fb081a54b9ca
411+
* and should be used when tokenServiceURLType in the destination service is common. See <a href=
412+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/technical-user-propagation">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/technical-user-propagation</a>
413+
* and <a href=
414+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-client-credentials-authentication-cf15900ca39242fb87a1fb081a54b9ca">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-client-credentials-authentication-cf15900ca39242fb87a1fb081a54b9ca</a>
416415
*
417416
* @param tokenServiceTenant
418417
* The token service tenant value.
@@ -425,8 +424,8 @@ public B tokenServiceTenant( @Nonnull final String tokenServiceTenant )
425424
}
426425

427426
/**
428-
* Adds a client assertion header to the destination. See
429-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers
427+
* Adds a client assertion header to the destination. See <a href=
428+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers</a>
430429
*
431430
* @param clientAssertion
432431
* The client assertion value.
@@ -439,8 +438,8 @@ public B clientAssertion( @Nonnull final String clientAssertion )
439438
}
440439

441440
/**
442-
* Adds a client assertion type header to the destination. See
443-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers
441+
* Adds a client assertion type header to the destination. See <a href=
442+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers</a>
444443
*
445444
* @param clientAssertionType
446445
* The client assertion type value.
@@ -453,8 +452,8 @@ public B clientAssertionType( @Nonnull final String clientAssertionType )
453452
}
454453

455454
/**
456-
* Adds a client assertion destination name header to the destination. See
457-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/client-assertion-with-automated-assertion-fetching-by-service
455+
* Adds a client assertion destination name header to the destination. See <a href=
456+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/client-assertion-with-automated-assertion-fetching-by-service">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/client-assertion-with-automated-assertion-fetching-by-service</a>
458457
*
459458
* @param clientAssertionDestinationName
460459
* The client assertion destination name value.
@@ -483,8 +482,8 @@ public B authorization( @Nonnull final String authorization )
483482
}
484483

485484
/**
486-
* Adds a subject token type header to the destination. See
487-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d
485+
* Adds a subject token type header to the destination. See <a href=
486+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d</a>
488487
*
489488
* @param subjectTokenType
490489
* The subject token type value.
@@ -497,8 +496,8 @@ public B subjectTokenType( @Nonnull final String subjectTokenType )
497496
}
498497

499498
/**
500-
* Adds an actor token header to the destination. See
501-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d
499+
* Adds an actor token header to the destination. See <a href=
500+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d</a>
502501
*
503502
* @param actorToken
504503
* The actor token value.
@@ -511,8 +510,8 @@ public B actorToken( @Nonnull final String actorToken )
511510
}
512511

513512
/**
514-
* Adds an actor token type header to the destination. See
515-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d
513+
* Adds an actor token type header to the destination. See <a href=
514+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d</a>
516515
*
517516
* @param actorTokenType
518517
* The actor token type value.
@@ -525,8 +524,8 @@ public B actorTokenType( @Nonnull final String actorTokenType )
525524
}
526525

527526
/**
528-
* Adds a redirect URI header to the destination. See
529-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770
527+
* Adds a redirect URI header to the destination. See <a href=
528+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770</a>
530529
*
531530
* @param redirectUri
532531
* The redirect URI value.
@@ -539,8 +538,8 @@ public B redirectUri( @Nonnull final String redirectUri )
539538
}
540539

541540
/**
542-
* Adds a code verifier header to the destination. See
543-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770
541+
* Adds a code verifier header to the destination. See <a href=
542+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770</a>
544543
*
545544
* @param codeVerifier
546545
* The code verifier value.
@@ -553,8 +552,8 @@ public B codeVerifier( @Nonnull final String codeVerifier )
553552
}
554553

555554
/**
556-
* Sets the chain name header for the destination. See
557-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion
555+
* Sets the chain name header for the destination. See <a href=
556+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion</a>
558557
*
559558
* @param chainName
560559
* The name of the chain.
@@ -567,8 +566,8 @@ public B chainName( @Nonnull final String chainName )
567566
}
568567

569568
/**
570-
* Sets the chain variable subject token header for the destination. See
571-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion
569+
* Sets the chain variable subject token header for the destination. See <a href=
570+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion</a>
572571
*
573572
* @param subjectToken
574573
* The subject token value.
@@ -581,8 +580,8 @@ public B chainVarSubjectToken( @Nonnull final String subjectToken )
581580
}
582581

583582
/**
584-
* Sets the chain variable subject token type header for the destination. See
585-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion
583+
* Sets the chain variable subject token type header for the destination. See <a href=
584+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion</a>
586585
*
587586
* @param subjectTokenType
588587
* The subject token type value.
@@ -595,8 +594,8 @@ public B chainVarSubjectTokenType( @Nonnull final String subjectTokenType )
595594
}
596595

597596
/**
598-
* Sets the chain variable SAML provider destination name header for the destination. See
599-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion
597+
* Sets the chain variable SAML provider destination name header for the destination. See <a href=
598+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion</a>
600599
*
601600
* @param samlProviderDestinationName
602601
* The SAML provider destination name.
@@ -622,8 +621,8 @@ public TransparentProxyDestination build()
622621
}
623622

624623
/**
625-
* Builder for creating a destination {@link TransparentProxyDestination}. See
626-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/destination-custom-resource
624+
* Builder for creating a destination {@link TransparentProxyDestination}. See <a href=
625+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/destination-custom-resource">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/destination-custom-resource</a>
627626
*/
628627
public static final class Builder extends AbstractBuilder<Builder>
629628
{
@@ -640,12 +639,12 @@ protected Builder getThis()
640639
}
641640

642641
/**
643-
* Builder for creating a destination-gateway {@link TransparentProxyDestination}. See
644-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations
642+
* Builder for creating a destination-gateway {@link TransparentProxyDestination}. See <a href=
643+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations</a>
645644
*/
646-
public static final class DestinationGatewayBuilder extends AbstractBuilder<DestinationGatewayBuilder>
645+
public static final class GatewayBuilder extends AbstractBuilder<GatewayBuilder>
647646
{
648-
private DestinationGatewayBuilder( @Nonnull final String destinationName, @Nonnull final String uri )
647+
private GatewayBuilder( @Nonnull final String destinationName, @Nonnull final String uri )
649648
{
650649
if( destinationName.isEmpty() ) {
651650
throw new IllegalArgumentException(
@@ -657,35 +656,35 @@ private DestinationGatewayBuilder( @Nonnull final String destinationName, @Nonnu
657656
}
658657

659658
@Override
660-
protected DestinationGatewayBuilder getThis()
659+
protected GatewayBuilder getThis()
661660
{
662661
return this;
663662
}
664663

665664
/**
666-
* Sets the fragment name for the destination-gateway. See
667-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations
665+
* Sets the fragment name for the destination-gateway. See <a href=
666+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations</a>
668667
*
669668
* @param fragmentName
670669
* The name of the fragment to use.
671670
* @return This builder instance for method chaining.
672671
*/
673672
@Nonnull
674-
public DestinationGatewayBuilder fragmentName( @Nonnull final String fragmentName )
673+
public GatewayBuilder fragmentName( @Nonnull final String fragmentName )
675674
{
676675
return header(new Header(FRAGMENT_NAME_HEADER_KEY, fragmentName));
677676
}
678677

679678
/**
680-
* Sets the fragment optional flag for the destination-gateway. See
681-
* https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations
679+
* Sets the fragment optional flag for the destination-gateway. See <a href=
680+
* "https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations">https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations</a>
682681
*
683682
* @param fragmentOptional
684683
* The value indicating if the fragment is optional.
685684
* @return This builder instance for method chaining.
686685
*/
687686
@Nonnull
688-
public DestinationGatewayBuilder fragmentOptional( final boolean fragmentOptional )
687+
public GatewayBuilder fragmentOptional( final boolean fragmentOptional )
689688
{
690689
return header(new Header(FRAGMENT_OPTIONAL_HEADER_KEY, Boolean.toString(fragmentOptional)));
691690
}

0 commit comments

Comments
 (0)