Package org.kie.server.client.impl
Class UIServicesClientImpl
- java.lang.Object
-
- org.kie.server.client.impl.AbstractKieServicesClientImpl
-
- org.kie.server.client.impl.UIServicesClientImpl
-
- All Implemented Interfaces:
UIServicesClient
public class UIServicesClientImpl extends AbstractKieServicesClientImpl implements UIServicesClient
-
-
Field Summary
-
Fields inherited from class org.kie.server.client.impl.AbstractKieServicesClientImpl
BYPASS_AUTH_USER, classLoader, config, loadBalancer, marshaller, owner
-
Fields inherited from interface org.kie.server.client.UIServicesClient
ANY_FORM, BOOTSTRAP_FORM_RENDERER, FORM_MODELLER_TYPE, FORM_TYPE, FREE_MARKER_TYPE, PATTERNFLY_FORM_RENDERER, WORKBENCH_FORM_RENDERER
-
-
Constructor Summary
Constructors Constructor Description UIServicesClientImpl(KieServicesConfiguration config)
UIServicesClientImpl(KieServicesConfiguration config, ClassLoader classLoader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
createColorURLParams(String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor)
String
getProcessForm(String containerId, String processId)
Returns process form for given process id that resides in given container - without filtering values by language.String
getProcessForm(String containerId, String processId, String language)
Returns process form for given process id that resides in given container.String
getProcessFormByType(String containerId, String processId, String formType)
Returns process form for given process id that resides in given container - without filtering values by languageString
getProcessFormByType(String containerId, String processId, String language, String formType)
Returns process form for given process id that resides in given containerString
getProcessImage(String containerId, String processId)
Returns process image (svg) of the given process id that belongs to given containerString
getProcessInstanceImage(String containerId, Long processInstanceId)
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given containerString
getProcessInstanceImageCustomColor(String containerId, Long processInstanceId, String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor)
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given containerString
getProcessRawForm(String containerId, String processId)
Returns process form for given process id that resides in given container - without filtering values by language.String
getTaskForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language.String
getTaskForm(String containerId, Long taskId, String language)
Returns task form for given task id that belongs to given container.String
getTaskFormAsUser(String containerId, Long taskId, String language, String userId)
Returns task form for given task id that belongs to given container as specified user.String
getTaskFormByType(String containerId, Long taskId, String formType)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language.String
getTaskFormByType(String containerId, Long taskId, String language, String formType)
Returns task form for given task id that belongs to given container.String
getTaskFormByTypeAsUser(String containerId, Long taskId, String language, String formType, String userId)
Returns task form for given task id that belongs to given container as specified user.String
getTaskRawForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language.String
getTaskRawFormAsUser(String containerId, Long taskId, String userId)
Returns task form for given task id that belongs to given container as specified user as raw content - without filtering values by language.String
renderCaseForm(String containerId, String caseDefinitionId)
Returns case form for given case definition that resides in given container - completely rendered so the output is HTMLString
renderCaseForm(String containerId, String caseDefinitionId, String renderer)
Returns case form for given case definition id that resides in given container - completely rendered so the output is HTMLString
renderProcessForm(String containerId, String processId)
Returns process form for given process id that resides in given container - completely rendered so the output is HTMLString
renderProcessForm(String containerId, String processId, String renderer)
Returns process form for given process id that resides in given container - completely rendered so the output is HTMLString
renderTaskForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTMLString
renderTaskForm(String containerId, Long taskId, String renderer)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTML-
Methods inherited from class org.kie.server.client.impl.AbstractKieServicesClientImpl
buildQueryString, checkResultType, close, createExceptionForUnexpectedResponseCode, deserialize, encode, executeJmsCommand, executeJmsCommand, executeJmsCommand, executeJmsCommand, getAdditionalParams, getConversationId, getHeaders, getLoadBalancer, getMediaType, getMessage, getPagingQueryString, getResponseHandler, getSortingQueryString, getUserAndAdditionalParam, getUserAndAdditionalParams, getUserAndPagingQueryString, getUserQueryStr, getUserQueryStr, initializeURI, invoke, makeBackwardCompatibleHttpPostRequestAndCreateServiceResponse, makeBackwardCompatibleHttpPostRequestAndCreateServiceResponse, makeBackwardCompatibleHttpPostRequestAndCreateServiceResponse, makeHttpDeleteRequestAndCreateCustomResponse, makeHttpDeleteRequestAndCreateServiceResponse, makeHttpGetRequestAndCreateCustomResponse, makeHttpGetRequestAndCreateCustomResponseWithHandleNotFound, makeHttpGetRequestAndCreateRawResponse, makeHttpGetRequestAndCreateRawResponse, makeHttpGetRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateCustomResponse, makeHttpPostRequestAndCreateCustomResponse, makeHttpPostRequestAndCreateCustomResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPostRequestAndCreateServiceResponse, makeHttpPutRequestAndCreateCustomResponse, makeHttpPutRequestAndCreateCustomResponse, makeHttpPutRequestAndCreateServiceResponse, makeHttpPutRequestAndCreateServiceResponse, newRequest, safeList, safeMap, sendTaskOperation, serialize, setOwner, setResponseHandler, shouldReturnWithNullResponse, throwExceptionOnFailure
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.kie.server.client.UIServicesClient
setResponseHandler
-
-
-
-
Constructor Detail
-
UIServicesClientImpl
public UIServicesClientImpl(KieServicesConfiguration config)
-
UIServicesClientImpl
public UIServicesClientImpl(KieServicesConfiguration config, ClassLoader classLoader)
-
-
Method Detail
-
getProcessForm
public String getProcessForm(String containerId, String processId, String language)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getProcessForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idlanguage
- language that form should be filtered for- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getProcessFormByType
public String getProcessFormByType(String containerId, String processId, String language, String formType)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container- Specified by:
getProcessFormByType
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getProcessRawForm
public String getProcessRawForm(String containerId, String processId)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getProcessRawForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- string representation of the process form without any marshalling
-
getProcessForm
public String getProcessForm(String containerId, String processId)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getProcessForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getProcessFormByType
public String getProcessFormByType(String containerId, String processId, String formType)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container - without filtering values by language- Specified by:
getProcessFormByType
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getTaskForm
public String getTaskForm(String containerId, Long taskId, String language)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getTaskForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered for- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormAsUser
public String getTaskFormAsUser(String containerId, Long taskId, String language, String userId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as specified user. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormForUserByType Introduced to allow client to take advantage of bypass auth user connecting to server.- Specified by:
getTaskFormAsUser
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered foruserId
- userId making the request to bypass auth user- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormByType
public String getTaskFormByType(String containerId, Long taskId, String language, String formType)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container.- Specified by:
getTaskFormByType
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormByTypeAsUser
public String getTaskFormByTypeAsUser(String containerId, Long taskId, String language, String formType, String userId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as specified user. Introduced to allow client to take advantage of bypass auth user connecting to server.- Specified by:
getTaskFormByTypeAsUser
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)userId
- userId making the request to bypass auth user- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskForm
public String getTaskForm(String containerId, Long taskId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getTaskForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormByType
public String getTaskFormByType(String containerId, Long taskId, String formType)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getTaskFormByType
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskRawForm
public String getTaskRawForm(String containerId, Long taskId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Specified by:
getTaskRawForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- string representation of the task form without any marshalling
-
getTaskRawFormAsUser
public String getTaskRawFormAsUser(String containerId, Long taskId, String userId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container as specified user as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType Introduced to allow client to take advantage of bypass auth user connecting to server.- Specified by:
getTaskRawFormAsUser
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task iduserId
- userId making the request to bypass auth user- Returns:
- string representation of the task form without any marshalling
-
getProcessImage
public String getProcessImage(String containerId, String processId)
Description copied from interface:UIServicesClient
Returns process image (svg) of the given process id that belongs to given container- Specified by:
getProcessImage
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- svg (xml) representing process image
-
getProcessInstanceImage
public String getProcessInstanceImage(String containerId, Long processInstanceId)
Description copied from interface:UIServicesClient
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given container- Specified by:
getProcessInstanceImage
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessInstanceId
- unique process instance id- Returns:
- svg (xml) representing process image annotated with active (in red) and completed (in grey) nodes
-
createColorURLParams
protected String createColorURLParams(String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor)
-
getProcessInstanceImageCustomColor
public String getProcessInstanceImageCustomColor(String containerId, Long processInstanceId, String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor)
Description copied from interface:UIServicesClient
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given container- Specified by:
getProcessInstanceImageCustomColor
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessInstanceId
- unique process instance idcompleteNodeColor
- process instance image complete node colorcompleteNodeBorderColor
- process instance image complete node border coloractiveNodeBorderColor
- process instance image active node border color- Returns:
- svg (xml) representing process image annotated with custom colors
-
renderProcessForm
public String renderProcessForm(String containerId, String processId)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container - completely rendered so the output is HTML- Specified by:
renderProcessForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- HTML representation of the process form
-
renderProcessForm
public String renderProcessForm(String containerId, String processId, String renderer)
Description copied from interface:UIServicesClient
Returns process form for given process id that resides in given container - completely rendered so the output is HTML- Specified by:
renderProcessForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the process form
-
renderCaseForm
public String renderCaseForm(String containerId, String caseDefinitionId)
Description copied from interface:UIServicesClient
Returns case form for given case definition that resides in given container - completely rendered so the output is HTML- Specified by:
renderCaseForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residescaseDefinitionId
- unique case definition id- Returns:
- HTML representation of the process form
-
renderCaseForm
public String renderCaseForm(String containerId, String caseDefinitionId, String renderer)
Description copied from interface:UIServicesClient
Returns case form for given case definition id that resides in given container - completely rendered so the output is HTML- Specified by:
renderCaseForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where process residescaseDefinitionId
- unique case definition idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the process form
-
renderTaskForm
public String renderTaskForm(String containerId, Long taskId)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container - completely rendered so the output is HTML- Specified by:
renderTaskForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- HTML representation of the task form
-
renderTaskForm
public String renderTaskForm(String containerId, Long taskId, String renderer)
Description copied from interface:UIServicesClient
Returns task form for given task id that belongs to given container - completely rendered so the output is HTML- Specified by:
renderTaskForm
in interfaceUIServicesClient
- Parameters:
containerId
- container identifier where task residestaskId
- unique task idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the task form
-
-