Package org.craftercms.studio.api.v2.service.proxy

Interface ProxyService

All Known Implementing Classes:

ProxyServiceImpl, ProxyServiceInternalImpl

public interface ProxyService

Provides functionality to proxy request to Crafter Engine

Since:

4.0.1

Author:

jmendeza

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Object>	getSiteLogEvents(String body, String siteId, jakarta.servlet.http.HttpServletRequest request)	Proxies a request to Crafter Engine log monitor service, after checking current user has permission to access log data for siteId.
org.springframework.http.ResponseEntity<Object>	proxyEngine(String body, String siteId, jakarta.servlet.http.HttpServletRequest request)	Proxies a request to Crafter Engine.

Method Details

proxyEngine

org.springframework.http.ResponseEntity<Object> proxyEngine(String body,
 String siteId,
 jakarta.servlet.http.HttpServletRequest request)
                                                     throws URISyntaxException,
SiteNotFoundException

Proxies a request to Crafter Engine.

Parameters:

body - body of the request

siteId - ID of the crafter site

request - the request

Returns:

response from Crafter Engine

Throws:

URISyntaxException - if request URI is not valid

SiteNotFoundException - if site is not found

getSiteLogEvents

org.springframework.http.ResponseEntity<Object> getSiteLogEvents(String body,
 String siteId,
 jakarta.servlet.http.HttpServletRequest request)
                                                          throws URISyntaxException,
SiteNotFoundException

Proxies a request to Crafter Engine log monitor service, after checking current user has permission to access log data for siteId.

Parameters:

body - body of the request.

siteId - ID of the crafter site

request - the request

Returns:

response from Crafter Engine

Throws:

URISyntaxException - if request URI is not valid

SiteNotFoundException - if site is not found