[MGNLRESTCL-14] Using the restclient with a proxy server Created: 06/Aug/15  Updated: 01/Nov/22  Resolved: 28/Jul/22

Status: Closed
Project: REST Client
Component/s: API
Affects Version/s: 1.0.4, 1.0.5
Fix Version/s: 2.0.4, 3.0.0

Type: Improvement Priority: Major
Reporter: Michaël van der Mark Assignee: Javier Benito
Resolution: Fixed Votes: 1
Labels: configuration, headless-team-support, maintenance, quickwin
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 3h Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
causality
dependency
is depended upon by MGNLHOOK-181 Make REST client to use a proxy on Sa... Closed
is depended upon by MGNLHOOK-190 Merge Webhooks integration on SaaS wh... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLRESTCL-182 Implement proxy settings definition Technical task Completed Javier Benito  
MGNLRESTCL-183 Review Technical task Completed Jaroslav Simak  
MGNLRESTCL-184 piQA Technical task Completed Jaroslav Simak  
MGNLRESTCL-185 QA Technical task Completed Oanh Thai Hoang  
MGNLRESTCL-186 Test Technical task Completed Javier Benito  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: Webhook on SaaS
Sprint: DevX 15
Story Points: 3
Team: DeveloperX

 Description   

At this moment we cannot add proxy settings:
Proxy server host
Proxy port
Proxy username
Proxy password

In the resteasy library there is a possibility to add a proxy. Please add this to the defaultRestClient.java or create a new implementation which can be used here.



 Comments   
Comment by Christopher Zimmermann [ 15/Apr/21 ]

Is the usecase that 1 restClient needs a proxy? Or is it that every request from Magnolia must go through a proxy?

I guess its common that every request must go through a proxy.
I wonder if there is a better way then needing to configure that on every restClient?
On the other hand it does seem logical for a developer that I could configure it directly on the restClient. (maybe an !include could be used.)

Comment by Christopher Zimmermann [ 15/Apr/21 ]

Maybe this can be solved with documentation improvement?
The docs mention: 

proxies optional 
List of ProxyDefinition objects.You can use definitions with client.proxy() in the DefaultRestClient.

But the link to ProxyDefinition is confusing - i'm not sure why it points were it does.

Maybe if the docs can be more specific, this problem is solved.

https://docs.magnolia-cms.com/product-docs/Modules/List-of-modules/REST-Client-module.html

Generated at Mon Feb 12 10:42:21 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.