Package org.flowable.ui.admin.service.engine

Class FlowableClientService

java.lang.Object

org.flowable.ui.admin.service.engine.FlowableClientService

@Service
public class FlowableClientService
extends Object

Service for invoking Flowable REST services.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_FLOWABLE_CONTEXT_ROOT
static String	DEFAULT_FLOWABLE_REST_ROOT
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected static String[]	PAGING_AND_SORTING_PARAMETER_NAMES
protected ServerConfigService	serverConfigService

Constructor Summary

Constructors

Constructor	Description
FlowableClientService()

Method Summary

Modifier and Type	Method	Description
void	addParameterToBuilder(String name, com.fasterxml.jackson.databind.JsonNode bodyNode, org.apache.http.client.utils.URIBuilder builder)
org.apache.http.client.methods.HttpDelete	createDelete(org.apache.http.client.utils.URIBuilder builder, ServerConfig serverConfig)
org.apache.http.client.methods.HttpPost	createPost(String uri, ServerConfig serverConfig)
org.apache.http.client.methods.HttpPost	createPost(org.apache.http.client.utils.URIBuilder builder, ServerConfig serverConfig)
org.apache.http.client.methods.HttpPut	createPut(String uri, ServerConfig serverConfig)
org.apache.http.client.methods.HttpPut	createPut(org.apache.http.client.utils.URIBuilder builder, ServerConfig serverConfig)
org.apache.http.entity.StringEntity	createStringEntity(com.fasterxml.jackson.databind.JsonNode json)
org.apache.http.entity.StringEntity	createStringEntity(String json)
org.apache.http.client.utils.URIBuilder	createUriBuilder(String url)
ResponseInfo	execute(org.apache.http.client.methods.HttpUriRequest request, String userName, String password, int... expectedStatusCodes)
void	execute(org.apache.http.client.methods.HttpUriRequest request, javax.servlet.http.HttpServletResponse httpResponse, String userName, String password)
void	execute(org.apache.http.client.methods.HttpUriRequest request, javax.servlet.http.HttpServletResponse httpResponse, ServerConfig serverConfig)
ResponseInfo	execute(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig)
ResponseInfo	execute(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig, int... expectedStatusCodes)
AttachmentResponseInfo	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, String userName, String password)
AttachmentResponseInfo	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, String userName, String password, Integer... expectedStatusCodes)
com.fasterxml.jackson.databind.JsonNode	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, javax.servlet.http.HttpServletResponse httpResponse, String userName, String password, int expectedStatusCode)
com.fasterxml.jackson.databind.JsonNode	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, javax.servlet.http.HttpServletResponse httpResponse, ServerConfig serverConfig)
com.fasterxml.jackson.databind.JsonNode	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, javax.servlet.http.HttpServletResponse httpResponse, ServerConfig serverConfig, int expectedStatusCode)
AttachmentResponseInfo	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig)
AttachmentResponseInfo	executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig, Integer... expectedStatusCodes)
com.fasterxml.jackson.databind.JsonNode	executeRequest(org.apache.http.client.methods.HttpUriRequest request, String userName, String password)
com.fasterxml.jackson.databind.JsonNode	executeRequest(org.apache.http.client.methods.HttpUriRequest request, String userName, String password, int expectedStatusCode)	Execute the given request.
com.fasterxml.jackson.databind.JsonNode	executeRequest(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig)	Execute the given request.
com.fasterxml.jackson.databind.JsonNode	executeRequest(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig, int expectedStatusCode)
String	executeRequestAsString(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig, int expectedStatusCode)
void	executeRequestNoResponseBody(org.apache.http.client.methods.HttpUriRequest request, ServerConfig serverConfig, int expectedStatusCode)	Execute the given request, without using the response body.
String	extractError(com.fasterxml.jackson.databind.JsonNode errorBody, String defaultValue)
String	getAppServerUrl(ServerConfig serverConfig, String uri)
org.apache.http.impl.client.CloseableHttpClient	getHttpClient(String userName, String password)
org.apache.http.impl.client.CloseableHttpClient	getHttpClient(ServerConfig serverConfig)
String	getServerUrl(String contextRoot, String restRoot, String serverAddress, Integer port, String uri)
String	getServerUrl(ServerConfig serverConfig, String uri)
String	getServerUrl(ServerConfig serverConfig, org.apache.http.client.utils.URIBuilder builder)
String	getUriWithPagingAndOrderParameters(org.apache.http.client.utils.URIBuilder builder, com.fasterxml.jackson.databind.JsonNode bodyNode)
protected com.fasterxml.jackson.databind.JsonNode	readJsonContent(InputStream requestContent)
protected String	stripSlashes(String url)
FlowableServiceException	wrapException(Exception e, org.apache.http.client.methods.HttpUriRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PAGING_AND_SORTING_PARAMETER_NAMES

protected static final String[] PAGING_AND_SORTING_PARAMETER_NAMES

DEFAULT_FLOWABLE_CONTEXT_ROOT

public static final String DEFAULT_FLOWABLE_CONTEXT_ROOT

See Also:

Constant Field Values

DEFAULT_FLOWABLE_REST_ROOT

public static final String DEFAULT_FLOWABLE_REST_ROOT

See Also:

Constant Field Values

serverConfigService

@Autowired
protected ServerConfigService serverConfigService

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Detail

FlowableClientService

public FlowableClientService()

Method Detail

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient(ServerConfig serverConfig)

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient(String userName,
                                                                     String password)

executeRequest

public com.fasterxml.jackson.databind.JsonNode executeRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                              ServerConfig serverConfig)

Execute the given request. Will return the parsed JSON present in the response-body, in case the status code is 200 - OK. In case the response returns a different status-code, an FlowableServiceException is thrown with the error message received from the client, if possible.

executeRequest

public com.fasterxml.jackson.databind.JsonNode executeRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                              ServerConfig serverConfig,
                                                              int expectedStatusCode)

executeRequest

public com.fasterxml.jackson.databind.JsonNode executeRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                              String userName,
                                                              String password)

executeRequest

public com.fasterxml.jackson.databind.JsonNode executeRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                              String userName,
                                                              String password,
                                                              int expectedStatusCode)

Execute the given request. Will return the parsed JSON present in the response-body, in case the status code is as expected. In case the response returns a different status-code, an FlowableServiceException is thrown with the error message received from the client, if possible.

executeDownloadRequest

public com.fasterxml.jackson.databind.JsonNode executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                                      javax.servlet.http.HttpServletResponse httpResponse,
                                                                      ServerConfig serverConfig)

executeDownloadRequest

public com.fasterxml.jackson.databind.JsonNode executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                                      javax.servlet.http.HttpServletResponse httpResponse,
                                                                      ServerConfig serverConfig,
                                                                      int expectedStatusCode)

executeDownloadRequest

public com.fasterxml.jackson.databind.JsonNode executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                                      javax.servlet.http.HttpServletResponse httpResponse,
                                                                      String userName,
                                                                      String password,
                                                                      int expectedStatusCode)

executeDownloadRequest

public AttachmentResponseInfo executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                     ServerConfig serverConfig)

executeDownloadRequest

public AttachmentResponseInfo executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                     ServerConfig serverConfig,
                                                     Integer... expectedStatusCodes)

executeDownloadRequest

public AttachmentResponseInfo executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                     String userName,
                                                     String password)

executeDownloadRequest

public AttachmentResponseInfo executeDownloadRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                     String userName,
                                                     String password,
                                                     Integer... expectedStatusCodes)

execute

public ResponseInfo execute(org.apache.http.client.methods.HttpUriRequest request,
                            ServerConfig serverConfig)

execute

public ResponseInfo execute(org.apache.http.client.methods.HttpUriRequest request,
                            ServerConfig serverConfig,
                            int... expectedStatusCodes)

execute

public ResponseInfo execute(org.apache.http.client.methods.HttpUriRequest request,
                            String userName,
                            String password,
                            int... expectedStatusCodes)

execute

public void execute(org.apache.http.client.methods.HttpUriRequest request,
                    javax.servlet.http.HttpServletResponse httpResponse,
                    ServerConfig serverConfig)

execute

public void execute(org.apache.http.client.methods.HttpUriRequest request,
                    javax.servlet.http.HttpServletResponse httpResponse,
                    String userName,
                    String password)

executeRequestAsString

public String executeRequestAsString(org.apache.http.client.methods.HttpUriRequest request,
                                     ServerConfig serverConfig,
                                     int expectedStatusCode)

wrapException

public FlowableServiceException wrapException(Exception e,
                                              org.apache.http.client.methods.HttpUriRequest request)

executeRequestNoResponseBody

public void executeRequestNoResponseBody(org.apache.http.client.methods.HttpUriRequest request,
                                         ServerConfig serverConfig,
                                         int expectedStatusCode)

Execute the given request, without using the response body. In case the response returns a different status-code than expected, an FlowableServiceException is thrown with the error message received from the client, if possible.

extractError

public String extractError(com.fasterxml.jackson.databind.JsonNode errorBody,
                           String defaultValue)

createPost

public org.apache.http.client.methods.HttpPost createPost(String uri,
                                                          ServerConfig serverConfig)

createPost

public org.apache.http.client.methods.HttpPost createPost(org.apache.http.client.utils.URIBuilder builder,
                                                          ServerConfig serverConfig)

createPut

public org.apache.http.client.methods.HttpPut createPut(String uri,
                                                        ServerConfig serverConfig)

createPut

public org.apache.http.client.methods.HttpPut createPut(org.apache.http.client.utils.URIBuilder builder,
                                                        ServerConfig serverConfig)

createDelete

public org.apache.http.client.methods.HttpDelete createDelete(org.apache.http.client.utils.URIBuilder builder,
                                                              ServerConfig serverConfig)

createStringEntity

public org.apache.http.entity.StringEntity createStringEntity(com.fasterxml.jackson.databind.JsonNode json)

createStringEntity

public org.apache.http.entity.StringEntity createStringEntity(String json)

getServerUrl

public String getServerUrl(ServerConfig serverConfig,
                           String uri)

getServerUrl

public String getServerUrl(String contextRoot,
                           String restRoot,
                           String serverAddress,
                           Integer port,
                           String uri)

getAppServerUrl

public String getAppServerUrl(ServerConfig serverConfig,
                              String uri)

createUriBuilder

public org.apache.http.client.utils.URIBuilder createUriBuilder(String url)

getServerUrl

public String getServerUrl(ServerConfig serverConfig,
                           org.apache.http.client.utils.URIBuilder builder)

getUriWithPagingAndOrderParameters

public String getUriWithPagingAndOrderParameters(org.apache.http.client.utils.URIBuilder builder,
                                                 com.fasterxml.jackson.databind.JsonNode bodyNode)
                                          throws URISyntaxException

Throws:

URISyntaxException

addParameterToBuilder

public void addParameterToBuilder(String name,
                                  com.fasterxml.jackson.databind.JsonNode bodyNode,
                                  org.apache.http.client.utils.URIBuilder builder)

stripSlashes

protected String stripSlashes(String url)

readJsonContent

protected com.fasterxml.jackson.databind.JsonNode readJsonContent(InputStream requestContent)