Package de.uplanet.lucy.server.workflow.action.rest

Klasse RestCallWorkflowAction

java.lang.Object
de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
de.uplanet.lucy.server.workflow.action.rest.RestCallWorkflowAction
Alle implementierten Schnittstellen:
IActivatableWorkflowObject, ILogLevelAware, INamedWorkflowObject, INeedWorkflow, IWorkflowAction, IWorkflowObject, Serializable
public final class RestCallWorkflowAction extends AbstractWorkflowAction implements ILogLevelAware
A workflow action to execute REST calls.
Siehe auch:

  • Felddetails

  • Konstruktordetails

    • RestCallWorkflowAction

      public RestCallWorkflowAction(String p_strGuid)
      Parameter:
      p_strGuid - The GUID of the workflow action.
      Löst aus:
      IllegalArgumentException - If the GUID parameter is null or if it does not represent a valid GUID.

  • Methodendetails

    • process

      public WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws Exception
      Beschreibung aus Schnittstelle kopiert: IWorkflowAction
      Process a workflow event in the given context.

      Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

      Angegeben von:
      process in Schnittstelle IWorkflowAction
      Parameter:
      p_evt - The event to be processed.
      p_wfCtx - The workflow processing context.
      p_ctx - The processing context.
      Gibt zurück:
      The efferent transition, or null.
      Löst aus:
      Exception - If an error occurred.

    • getAlias

      public String getAlias()

    • setAlias

      public void setAlias(String p_strAlias)

    • getAuthType

      public String getAuthType()
      Get the authentication type.

      Supported authentication types are

      Gibt zurück:
      The authentication type.

    • setAuthType

      public void setAuthType(String p_strAuthType)
      Set the authentication type.

      Supported authentication types are

      Parameter:
      p_strAuthType - The authentication type.

    • getToken

      public String getToken()
      Get the authenication token, i.e. API key or bearer token.
      Gibt zurück:
      The authenication token.

    • setToken

      public void setToken(String p_strToken)
      Set the authenication token.
      Parameter:
      p_strToken - The authenication token, e.g. API key or bearer token.

    • getUsername

      public String getUsername()
      Get the user name for authentication.
      Gibt zurück:
      The user name.

    • setUsername

      public void setUsername(String p_strUserName)
      Set the user name for authentication.
      Parameter:
      p_strUserName - The user name.

    • getPassword

      public String getPassword()
      Get the password for authentication.
      Gibt zurück:
      The password.

    • setPassword

      public void setPassword(String p_strPassword)
      Set the password for authentication.
      Parameter:
      p_strPassword - The password.

    • getAuthHeader

      public String getAuthHeader()
      Get the header used for authentication.
      Gibt zurück:
      The header used for authentication.

    • setAuthHeader

      public void setAuthHeader(String p_strAuthHeader)
      Set the header used for authentication.
      Parameter:
      p_strAuthHeader - The header used for authentication.

    • isRetainClient

      public boolean isRetainClient()
      Flag indicating if the client should be kept for re-use in later calls (only in the current workflow execution).
      Gibt zurück:
      true if the client should be kept for re-use, or false otherwise.

    • setRetainClient

      public void setRetainClient(boolean p_bRetainClient)
      Flag indicating if the client should be kept for re-use in later calls (only in the current workflow execution).
      Parameter:
      p_bRetainClient - true if the client should be kept for re-use, or false otherwise.

    • getScheme

      public String getScheme()
      Get the URI scheme.
      Gibt zurück:
      The URI scheme.

    • setScheme

      public void setScheme(String p_strScheme)
      Set the URI scheme.
      Parameter:
      p_strScheme - The URI scheme (should be https).

    • getHost

      public String getHost()
      Get the URI host.
      Gibt zurück:
      The URI host.

    • setHost

      public void setHost(String p_strHost)
      Set the URI host.
      Parameter:
      p_strHost - The URI host.

    • getPort

      public String getPort()
      Get the URI port.
      Gibt zurück:
      The URI port.

    • setPort

      public void setPort(String p_strPort)
      Set the URI port.
      Parameter:
      p_strPort - The URI port.

    • getPath

      public String getPath()
      Get the URI path.
      Gibt zurück:
      The URI path.

    • setPath

      public void setPath(String p_strPath)
      Set the URI path.
      Parameter:
      p_strPath - The URI path.

    • getQueryParameters

      public Map<String,String> getQueryParameters()
      Get the URI's query parameters.
      Gibt zurück:
      The URI's query parameters.

    • setQueryParameters

      public void setQueryParameters(Map<String,String> p_queryParameters)
      Set the URI's query parameters.
      Parameter:
      p_queryParameters - The URI's query parameters.

    • getHttpVerb

      public String getHttpVerb()
      Get the HTTP method (verb).
      Gibt zurück:
      The HTTP method.

    • setHttpVerb

      public void setHttpVerb(String p_strHttpMethod)
      Set the HTTP method (verb).
      Parameter:
      p_strHttpMethod - The HTTP method (must be uppercase).

    • getBodyType

      public String getBodyType()
      Get the HTTP request body type.

      Supported body types are

      Gibt zurück:
      The HTTP request body type.

    • setBodyType

      public void setBodyType(String p_strBodyType)
      Set the HTTP request body type.

      Supported body types are

      Parameter:
      p_strBodyType - The HTTP request body type.

    • getBody

      public String getBody()
      Get the request body content (payload).
      Gibt zurück:
      The HTTP request body content.

    • setBody

      public void setBody(String p_strBody)
      Set the request body content (payload).
      Parameter:
      p_strBody - The HTTP request body content.

    • isParseJson

      public boolean isParseJson()
      This flag determines if JSON should be parsed or not.
      Gibt zurück:
      true if JSON should be parsed, or false otherwise.

    • setParseJson

      public void setParseJson(boolean p_bParseJson)
      This flag determines if JSON should be parsed or not.
      Parameter:
      p_bParseJson - true if JSON should be parsed, or false otherwise.

    • getResourceMapping

      public Map<String,String> getResourceMapping()
      Get the mapping of placeholders to resources in Intrexx.
      Gibt zurück:
      The mapping.

    • setResourceMapping

      public void setResourceMapping(Map<String,String> p_resourceMapping)
      Set the mapping of placeholders to resources in Intrexx.
      Parameter:
      p_resourceMapping - The mapping.

    • getHeaders

      public Map<String,String> getHeaders()
      Get the user-defined request headers.
      Gibt zurück:
      The request headers.

    • setHeaders

      public void setHeaders(Map<String,String> p_headers)
      Set user-defined request headers.
      Parameter:
      p_headers - The request headers.

    • getFilenameDownload

      public String getFilenameDownload()
      Get the filename used for downloads if content disposition is missing.
      Gibt zurück:
      The filename.

    • setFilenameDownload

      public void setFilenameDownload(String p_strFilenameDownload)
      Set the filename used for downloads if content disposition is missing.
      Parameter:
      p_strFilenameDownload - The filename.

    • getMultipartElements

      public List<String> getMultipartElements()
      Get the multipart elements configured for the request.
      Gibt zurück:
      The multipart elements.

    • setMultipartElements

      public void setMultipartElements(List<String> p_multipartElements)
      Set the multipart elements configured for the request.
      Parameter:
      p_multipartElements - The multipart elements.

    • isTrustAllCertificates

      public boolean isTrustAllCertificates()
      This flag determines if all certificates should be trusted.

      The default value is false.

      Gibt zurück:
      true if all certificates should be trusted, or false otherwise.

    • setTrustAllCertificates

      public void setTrustAllCertificates(boolean p_bTrustAllCertificates)
      This flag determines if all certificates should be trusted.

      The default value is false.

      Parameter:
      p_bTrustAllCertificates - true if all certificates should be trusted, or false otherwise.

    • isHostnameVerification

      public boolean isHostnameVerification()
      This flag determines if hostnames should be verified.

      The default value is true.

      Gibt zurück:
      true if hostnames should be verified, or false otherwise.

    • setHostnameVerification

      public void setHostnameVerification(boolean p_bHostnameVerification)
      This flag determines if hostnames should be verified.

      The default value is true.

      Parameter:
      p_bHostnameVerification - true if hostnames should be verified, or false otherwise.

    • isFollowRedirects

      public boolean isFollowRedirects()
      This flag determines if redirects should be followed.

      The default value is false.

      Gibt zurück:
      true if redirects should be followed, or false otherwise.

    • setFollowRedirects

      public void setFollowRedirects(boolean p_bFollowRedirects)
      This flag determines if redirects should be followed.

      The default value is false.

      Parameter:
      p_bFollowRedirects - true if redirects should be followed, or false otherwise.

    • getOnErrorMode

      public ON_ERROR_MODE getOnErrorMode()
      This property determines if an exception should be thrown if request processing fails.

      The default value is ON_ERROR_MODE.THROW_EXCEPTION.

      Gibt zurück:
      The error handling mode.

    • setOnErrorMode

      public void setOnErrorMode(ON_ERROR_MODE p_onErrorMode)
      This property determines if an exception should be thrown if request processing fails.

      The default value is ON_ERROR_MODE.THROW_EXCEPTION.

      Parameter:
      p_onErrorMode - The error mode to be used. May be either ON_ERROR_MODE.THROW_EXCEPTION, or ON_ERROR_MODE.NO_ACTION.

    • getTimeout

      public int getTimeout()
      Get the request timeout.

      The default value is 30 seconds.

      Gibt zurück:
      The request timeout in seconds.

    • setTimeout

      public void setTimeout(int p_iTimeout)
      Set the request timeout.

      The default value is 30 seconds.

      Parameter:
      p_iTimeout - The request timeout in seconds.

    • isLogVerbose

      public boolean isLogVerbose()
      Beschreibung aus Schnittstelle kopiert: ILogLevelAware
      This flag determines if verbose logging is turned on or off.
      Angegeben von:
      isLogVerbose in Schnittstelle ILogLevelAware
      Gibt zurück:
      true if logging is verbose, or false otherwise.

    • setLogVerbose

      public void setLogVerbose(boolean p_bLogVerbose)
      Beschreibung aus Schnittstelle kopiert: ILogLevelAware
      This flag determines if verbose logging is turned on or off.
      Angegeben von:
      setLogVerbose in Schnittstelle ILogLevelAware
      Parameter:
      p_bLogVerbose - true if logging should be verbose, or false otherwise.