com.liferay.portlet.workflow.service.http
Class WorkflowComponentServiceHttp

java.lang.Object
  extended by com.liferay.portlet.workflow.service.http.WorkflowComponentServiceHttp

public class WorkflowComponentServiceHttp
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a HTTP utility for the com.liferay.portlet.workflow.service.WorkflowComponentServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional com.liferay.portal.security.auth.HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
HttpPrincipal, WorkflowComponentServiceUtil, WorkflowComponentServiceSoap

Constructor Summary
WorkflowComponentServiceHttp()
           
 
Method Summary
static java.lang.String deploy(HttpPrincipal httpPrincipal, java.lang.String xml)
           
static java.util.List getCurrentTasks(HttpPrincipal httpPrincipal, long instanceId, long tokenId)
           
static java.lang.String getCurrentTasksXml(HttpPrincipal httpPrincipal, long instanceId, long tokenId)
           
static java.lang.Object getDefinition(HttpPrincipal httpPrincipal, long definitionId)
           
static java.util.List getDefinitions(HttpPrincipal httpPrincipal, long definitionId, java.lang.String name, int begin, int end)
           
static int getDefinitionsCount(HttpPrincipal httpPrincipal, long definitionId, java.lang.String name)
           
static java.lang.String getDefinitionsCountXml(HttpPrincipal httpPrincipal, long definitionId, java.lang.String name)
           
static java.lang.String getDefinitionsXml(HttpPrincipal httpPrincipal, long definitionId, java.lang.String name, int begin, int end)
           
static java.lang.String getDefinitionXml(HttpPrincipal httpPrincipal, long definitionId)
           
static java.util.List getInstances(HttpPrincipal httpPrincipal, long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int begin, int end)
           
static int getInstancesCount(HttpPrincipal httpPrincipal, long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
static java.lang.String getInstancesCountXml(HttpPrincipal httpPrincipal, long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
static java.lang.String getInstancesXml(HttpPrincipal httpPrincipal, long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int begin, int end)
           
static com.liferay.portlet.workflow.model.WorkflowTask getTask(HttpPrincipal httpPrincipal, long taskId)
           
static java.util.List getTaskFormElements(HttpPrincipal httpPrincipal, long taskId)
           
static java.lang.String getTaskFormElementsXml(HttpPrincipal httpPrincipal, long taskId)
           
static java.util.List getTaskTransitions(HttpPrincipal httpPrincipal, long taskId)
           
static java.lang.String getTaskTransitionsXml(HttpPrincipal httpPrincipal, long taskId)
           
static java.lang.String getTaskXml(HttpPrincipal httpPrincipal, long taskId)
           
static java.util.List getUserTasks(HttpPrincipal httpPrincipal, long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int begin, int end)
           
static int getUserTasksCount(HttpPrincipal httpPrincipal, long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
static java.lang.String getUserTasksCountXml(HttpPrincipal httpPrincipal, long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
static java.lang.String getUserTasksXml(HttpPrincipal httpPrincipal, long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int begin, int end)
           
static void signalInstance(HttpPrincipal httpPrincipal, long instanceId)
           
static void signalToken(HttpPrincipal httpPrincipal, long instanceId, long tokenId)
           
static java.lang.String startWorkflow(HttpPrincipal httpPrincipal, long definitionId)
           
static java.util.Map updateTask(HttpPrincipal httpPrincipal, long taskId, java.lang.String transition, java.util.Map parameterMap)
           
static java.lang.String updateTaskXml(HttpPrincipal httpPrincipal, long taskId, java.lang.String transition, java.util.Map parameterMap)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowComponentServiceHttp

public WorkflowComponentServiceHttp()
Method Detail

getCurrentTasks

public static java.util.List getCurrentTasks(HttpPrincipal httpPrincipal,
                                             long instanceId,
                                             long tokenId)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getCurrentTasksXml

public static java.lang.String getCurrentTasksXml(HttpPrincipal httpPrincipal,
                                                  long instanceId,
                                                  long tokenId)
                                           throws com.liferay.portal.SystemException,
                                                  com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

deploy

public static java.lang.String deploy(HttpPrincipal httpPrincipal,
                                      java.lang.String xml)
                               throws com.liferay.portal.SystemException,
                                      com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinition

public static java.lang.Object getDefinition(HttpPrincipal httpPrincipal,
                                             long definitionId)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinitions

public static java.util.List getDefinitions(HttpPrincipal httpPrincipal,
                                            long definitionId,
                                            java.lang.String name,
                                            int begin,
                                            int end)
                                     throws com.liferay.portal.SystemException,
                                            com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinitionsXml

public static java.lang.String getDefinitionsXml(HttpPrincipal httpPrincipal,
                                                 long definitionId,
                                                 java.lang.String name,
                                                 int begin,
                                                 int end)
                                          throws com.liferay.portal.SystemException,
                                                 com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinitionsCount

public static int getDefinitionsCount(HttpPrincipal httpPrincipal,
                                      long definitionId,
                                      java.lang.String name)
                               throws com.liferay.portal.SystemException,
                                      com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinitionsCountXml

public static java.lang.String getDefinitionsCountXml(HttpPrincipal httpPrincipal,
                                                      long definitionId,
                                                      java.lang.String name)
                                               throws com.liferay.portal.SystemException,
                                                      com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getDefinitionXml

public static java.lang.String getDefinitionXml(HttpPrincipal httpPrincipal,
                                                long definitionId)
                                         throws com.liferay.portal.SystemException,
                                                com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getInstances

public static java.util.List getInstances(HttpPrincipal httpPrincipal,
                                          long definitionId,
                                          long instanceId,
                                          java.lang.String definitionName,
                                          java.lang.String definitionVersion,
                                          java.lang.String startDateGT,
                                          java.lang.String startDateLT,
                                          java.lang.String endDateGT,
                                          java.lang.String endDateLT,
                                          boolean hideEndedTasks,
                                          boolean retrieveUserInstances,
                                          boolean andOperator,
                                          int begin,
                                          int end)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getInstancesCount

public static int getInstancesCount(HttpPrincipal httpPrincipal,
                                    long definitionId,
                                    long instanceId,
                                    java.lang.String definitionName,
                                    java.lang.String definitionVersion,
                                    java.lang.String startDateGT,
                                    java.lang.String startDateLT,
                                    java.lang.String endDateGT,
                                    java.lang.String endDateLT,
                                    boolean hideEndedTasks,
                                    boolean retrieveUserInstances,
                                    boolean andOperator)
                             throws com.liferay.portal.SystemException,
                                    com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getInstancesCountXml

public static java.lang.String getInstancesCountXml(HttpPrincipal httpPrincipal,
                                                    long definitionId,
                                                    long instanceId,
                                                    java.lang.String definitionName,
                                                    java.lang.String definitionVersion,
                                                    java.lang.String startDateGT,
                                                    java.lang.String startDateLT,
                                                    java.lang.String endDateGT,
                                                    java.lang.String endDateLT,
                                                    boolean hideEndedTasks,
                                                    boolean retrieveUserInstances,
                                                    boolean andOperator)
                                             throws com.liferay.portal.SystemException,
                                                    com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getInstancesXml

public static java.lang.String getInstancesXml(HttpPrincipal httpPrincipal,
                                               long definitionId,
                                               long instanceId,
                                               java.lang.String definitionName,
                                               java.lang.String definitionVersion,
                                               java.lang.String startDateGT,
                                               java.lang.String startDateLT,
                                               java.lang.String endDateGT,
                                               java.lang.String endDateLT,
                                               boolean hideEndedTasks,
                                               boolean retrieveUserInstances,
                                               boolean andOperator,
                                               int begin,
                                               int end)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTask

public static com.liferay.portlet.workflow.model.WorkflowTask getTask(HttpPrincipal httpPrincipal,
                                                                      long taskId)
                                                               throws com.liferay.portal.SystemException,
                                                                      com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTaskXml

public static java.lang.String getTaskXml(HttpPrincipal httpPrincipal,
                                          long taskId)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTaskFormElements

public static java.util.List getTaskFormElements(HttpPrincipal httpPrincipal,
                                                 long taskId)
                                          throws com.liferay.portal.SystemException,
                                                 com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTaskFormElementsXml

public static java.lang.String getTaskFormElementsXml(HttpPrincipal httpPrincipal,
                                                      long taskId)
                                               throws com.liferay.portal.SystemException,
                                                      com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTaskTransitions

public static java.util.List getTaskTransitions(HttpPrincipal httpPrincipal,
                                                long taskId)
                                         throws com.liferay.portal.SystemException,
                                                com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getTaskTransitionsXml

public static java.lang.String getTaskTransitionsXml(HttpPrincipal httpPrincipal,
                                                     long taskId)
                                              throws com.liferay.portal.SystemException,
                                                     com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getUserTasks

public static java.util.List getUserTasks(HttpPrincipal httpPrincipal,
                                          long instanceId,
                                          java.lang.String taskName,
                                          java.lang.String definitionName,
                                          java.lang.String assignedTo,
                                          java.lang.String createDateGT,
                                          java.lang.String createDateLT,
                                          java.lang.String startDateGT,
                                          java.lang.String startDateLT,
                                          java.lang.String endDateGT,
                                          java.lang.String endDateLT,
                                          boolean hideEndedTasks,
                                          boolean andOperator,
                                          int begin,
                                          int end)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getUserTasksCount

public static int getUserTasksCount(HttpPrincipal httpPrincipal,
                                    long instanceId,
                                    java.lang.String taskName,
                                    java.lang.String definitionName,
                                    java.lang.String assignedTo,
                                    java.lang.String createDateGT,
                                    java.lang.String createDateLT,
                                    java.lang.String startDateGT,
                                    java.lang.String startDateLT,
                                    java.lang.String endDateGT,
                                    java.lang.String endDateLT,
                                    boolean hideEndedTasks,
                                    boolean andOperator)
                             throws com.liferay.portal.SystemException,
                                    com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getUserTasksCountXml

public static java.lang.String getUserTasksCountXml(HttpPrincipal httpPrincipal,
                                                    long instanceId,
                                                    java.lang.String taskName,
                                                    java.lang.String definitionName,
                                                    java.lang.String assignedTo,
                                                    java.lang.String createDateGT,
                                                    java.lang.String createDateLT,
                                                    java.lang.String startDateGT,
                                                    java.lang.String startDateLT,
                                                    java.lang.String endDateGT,
                                                    java.lang.String endDateLT,
                                                    boolean hideEndedTasks,
                                                    boolean andOperator)
                                             throws com.liferay.portal.SystemException,
                                                    com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

getUserTasksXml

public static java.lang.String getUserTasksXml(HttpPrincipal httpPrincipal,
                                               long instanceId,
                                               java.lang.String taskName,
                                               java.lang.String definitionName,
                                               java.lang.String assignedTo,
                                               java.lang.String createDateGT,
                                               java.lang.String createDateLT,
                                               java.lang.String startDateGT,
                                               java.lang.String startDateLT,
                                               java.lang.String endDateGT,
                                               java.lang.String endDateLT,
                                               boolean hideEndedTasks,
                                               boolean andOperator,
                                               int begin,
                                               int end)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

signalInstance

public static void signalInstance(HttpPrincipal httpPrincipal,
                                  long instanceId)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

signalToken

public static void signalToken(HttpPrincipal httpPrincipal,
                               long instanceId,
                               long tokenId)
                        throws com.liferay.portal.SystemException,
                               com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

startWorkflow

public static java.lang.String startWorkflow(HttpPrincipal httpPrincipal,
                                             long definitionId)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

updateTask

public static java.util.Map updateTask(HttpPrincipal httpPrincipal,
                                       long taskId,
                                       java.lang.String transition,
                                       java.util.Map parameterMap)
                                throws com.liferay.portal.SystemException,
                                       com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException

updateTaskXml

public static java.lang.String updateTaskXml(HttpPrincipal httpPrincipal,
                                             long taskId,
                                             java.lang.String transition,
                                             java.util.Map parameterMap)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.kernel.jbi.WorkflowComponentException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.kernel.jbi.WorkflowComponentException