com.ibm.broker.config.appdev.nodes

Class RESTRequestNode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable


    public class RESTRequestNode
    extends Node

    RESTRequestNode instance

    Use the RESTRequest node to interact with REST APIs hosted on external HTTP servers

     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2010-08-10  dstorey         creation
     
    See Also:
    Serialized Form
    • Constructor Detail

      • RESTRequestNode

        public RESTRequestNode()
    • Method Detail

      • getParametersTable

        public RESTRequestNode.ParametersTable getParametersTable()
        Retrieve the Parameters table for the node RESTRequestNode
        Returns:
        ParametersTable instance which contains parameterRow rows
      • getParserXmlnscOpaqueElementsTable

        public RESTRequestNode.ParserXmlnscOpaqueElementsTable getParserXmlnscOpaqueElementsTable()
        Retrieve the Opaque elements table for the node RESTRequestNode
        Returns:
        ParserXmlnscOpaqueElementsTable instance which contains OpaqueElementsRow rows
      • getInputTerminals

        public InputTerminal[] getInputTerminals()
        Description copied from class: Node
        Gets the full list of available InputTerminals for this Node
        Specified by:
        getInputTerminals in class Node
        Returns:
        InputTerminal[]
      • getOutputTerminals

        public OutputTerminal[] getOutputTerminals()
        Description copied from class: Node
        Gets the full list of available OutputTerminals for this Node
        Specified by:
        getOutputTerminals in class Node
        Returns:
        OutputTerminal[]
      • getTypeName

        public java.lang.String getTypeName()
        Description copied from class: Node
        Gets the node type of this node
        Specified by:
        getTypeName in class Node
        Returns:
        String; the node type
      • setDefinitionType

        public RESTRequestNode setDefinitionType(java.lang.String value)
        Set the RESTRequestNode "Definitions language" property
        Parameters:
        value - String ; the value to set the property "Definitions language"
      • getDefinitionType

        public java.lang.String getDefinitionType()
        Get the RESTRequestNode "Definitions language" property
        Returns:
        String; the value of the property "Definitions language"
      • setDefinitionFile

        public RESTRequestNode setDefinitionFile(java.lang.String value)
        Set the RESTRequestNode "Definitions file" property
        Parameters:
        value - String ; the value to set the property "Definitions file"
      • getDefinitionFile

        public java.lang.String getDefinitionFile()
        Get the RESTRequestNode "Definitions file" property
        Returns:
        String; the value of the property "Definitions file"
      • setOperationName

        public RESTRequestNode setOperationName(java.lang.String value)
        Set the RESTRequestNode "Operation" property
        Parameters:
        value - String ; the value to set the property "Operation"
      • getOperationName

        public java.lang.String getOperationName()
        Get the RESTRequestNode "Operation" property
        Returns:
        String; the value of the property "Operation"
      • setSecurityIdentity

        public RESTRequestNode setSecurityIdentity(java.lang.String value)
        Set the RESTRequestNode "Security identity" property
        Parameters:
        value - String ; the value to set the property "Security identity"
      • getSecurityIdentity

        public java.lang.String getSecurityIdentity()
        Get the RESTRequestNode "Security identity" property
        Returns:
        String; the value of the property "Security identity"
      • setTimeoutForServer

        public RESTRequestNode setTimeoutForServer(int value)
        Set the RESTRequestNode "Request timeout (sec)" property
        Parameters:
        value - int ; the value to set the property "Request timeout (sec)"
      • getTimeoutForServer

        public int getTimeoutForServer()
        Get the RESTRequestNode Request timeout (sec) property
        Returns:
        int; the value of the property "Request timeout (sec)"
      • setBaseURL

        public RESTRequestNode setBaseURL(java.lang.String value)
        Set the RESTRequestNode "Base URL override" property
        Parameters:
        value - String ; the value to set the property "Base URL override"
      • getBaseURL

        public java.lang.String getBaseURL()
        Get the RESTRequestNode "Base URL override" property
        Returns:
        String; the value of the property "Base URL override"
      • setHttpProxyLocation

        public RESTRequestNode setHttpProxyLocation(java.lang.String value)
        Set the RESTRequestNode "HTTP(S) proxy location" property
        Parameters:
        value - String ; the value to set the property "HTTP(S) proxy location"
      • getHttpProxyLocation

        public java.lang.String getHttpProxyLocation()
        Get the RESTRequestNode "HTTP(S) proxy location" property
        Returns:
        String; the value of the property "HTTP(S) proxy location"
      • setFollowRedirection

        public RESTRequestNode setFollowRedirection(boolean value)
        Set the RESTRequestNode "Follow HTTP(S) redirection" property
        Parameters:
        value - boolean ; the value to set the property "Follow HTTP(S) redirection"
      • getFollowRedirection

        public boolean getFollowRedirection()
        Get the RESTRequestNode "Follow HTTP(S) redirection" property
        Returns:
        boolean; the value of the property "Follow HTTP(S) redirection"
      • setEnableKeepAlive

        public RESTRequestNode setEnableKeepAlive(boolean value)
        Set the RESTRequestNode "Enable HTTP/1.1 keep-alive" property
        Parameters:
        value - boolean ; the value to set the property "Enable HTTP/1.1 keep-alive"
      • getEnableKeepAlive

        public boolean getEnableKeepAlive()
        Get the RESTRequestNode "Enable HTTP/1.1 keep-alive" property
        Returns:
        boolean; the value of the property "Enable HTTP/1.1 keep-alive"
      • setAllowedCiphers

        public RESTRequestNode setAllowedCiphers(java.lang.String value)
        Set the RESTRequestNode "Allowed SSL ciphers" property
        Parameters:
        value - String ; the value to set the property "Allowed SSL ciphers"
      • getAllowedCiphers

        public java.lang.String getAllowedCiphers()
        Get the RESTRequestNode "Allowed SSL ciphers" property
        Returns:
        String; the value of the property "Allowed SSL ciphers"
      • setHostnameChecking

        public RESTRequestNode setHostnameChecking(boolean value)
        Set the RESTRequestNode "Enable SSL certificate hostname checking" property
        Parameters:
        value - boolean ; the value to set the property "Enable SSL certificate hostname checking"
      • getHostnameChecking

        public boolean getHostnameChecking()
        Get the RESTRequestNode "Enable SSL certificate hostname checking" property
        Returns:
        boolean; the value of the property "Enable SSL certificate hostname checking"
      • setKeyAlias

        public RESTRequestNode setKeyAlias(java.lang.String value)
        Set the RESTRequestNode "SSL client authentication key alias" property
        Parameters:
        value - String ; the value to set the property "SSL client authentication key alias"
      • getKeyAlias

        public java.lang.String getKeyAlias()
        Get the RESTRequestNode "SSL client authentication key alias" property
        Returns:
        String; the value of the property "SSL client authentication key alias"
      • setEnableCRLCheck

        public RESTRequestNode setEnableCRLCheck(boolean value)
        Set the RESTRequestNode "Enable certificate revocation list checking" property
        Parameters:
        value - boolean ; the value to set the property "Enable certificate revocation list checking"
      • getEnableCRLCheck

        public boolean getEnableCRLCheck()
        Get the RESTRequestNode "Enable certificate revocation list checking" property
        Returns:
        boolean; the value of the property "Enable certificate revocation list checking"
      • setContentType

        public RESTRequestNode setContentType(java.lang.String value)
        Set the RESTRequestNode "Content-Type" property
        Parameters:
        value - String ; the value to set the property "Content-Type"
      • getContentType

        public java.lang.String getContentType()
        Get the RESTRequestNode "Content-Type" property
        Returns:
        String; the value of the property "Content-Type"
      • setDataLocation

        public RESTRequestNode setDataLocation(java.lang.String value)
        Set the RESTRequestNode "Input body location" property
        Parameters:
        value - String ; the value to set the property "Input body location"
      • getDataLocation

        public java.lang.String getDataLocation()
        Get the RESTRequestNode "Input body location" property
        Returns:
        String; the value of the property "Input body location"
      • setAccept

        public RESTRequestNode setAccept(java.lang.String value)
        Set the RESTRequestNode "Accept" property
        Parameters:
        value - String ; the value to set the property "Accept"
      • getAccept

        public java.lang.String getAccept()
        Get the RESTRequestNode "Accept" property
        Returns:
        String; the value of the property "Accept"
      • setResultDataLocation

        public RESTRequestNode setResultDataLocation(java.lang.String value)
        Set the RESTRequestNode "Response body location" property
        Parameters:
        value - String ; the value to set the property "Response body location"
      • getResultDataLocation

        public java.lang.String getResultDataLocation()
        Get the RESTRequestNode "Response body location" property
        Returns:
        String; the value of the property "Response body location"
      • setOutputDataLocation

        public RESTRequestNode setOutputDataLocation(java.lang.String value)
        Set the RESTRequestNode "Output body location" property
        Parameters:
        value - String ; the value to set the property "Output body location"
      • getOutputDataLocation

        public java.lang.String getOutputDataLocation()
        Get the RESTRequestNode "Output body location" property
        Returns:
        String; the value of the property "Output body location"
      • setErrorDataLocation

        public RESTRequestNode setErrorDataLocation(java.lang.String value)
        Set the RESTRequestNode "Error body location" property
        Parameters:
        value - String ; the value to set the property "Error body location"
      • getErrorDataLocation

        public java.lang.String getErrorDataLocation()
        Get the RESTRequestNode "Error body location" property
        Returns:
        String; the value of the property "Error body location"
      • setCopyLocalEnvironment

        public RESTRequestNode setCopyLocalEnvironment(boolean value)
        Set the RESTRequestNode "Copy local environment" property
        Parameters:
        value - boolean ; the value to set the property "Copy local environment"
      • getCopyLocalEnvironment

        public boolean getCopyLocalEnvironment()
        Get the RESTRequestNode "Copy local environment" property
        Returns:
        boolean; the value of the property "Copy local environment"
      • setAcceptCompressedResponses

        public RESTRequestNode setAcceptCompressedResponses(boolean value)
        Set the RESTRequestNode "Accept compressed responses by default" property
        Parameters:
        value - boolean ; the value to set the property "Accept compressed responses by default"
      • getAcceptCompressedResponses

        public boolean getAcceptCompressedResponses()
        Get the RESTRequestNode "Accept compressed responses by default" property
        Returns:
        boolean; the value of the property "Accept compressed responses by default"
      • setContentTypeHandling

        public RESTRequestNode setContentTypeHandling(boolean value)
        Set the RESTRequestNode "Automatic Content-Type handling" property
        Parameters:
        value - boolean ; the value to set the property "Automatic Content-Type handling"
      • getContentTypeHandling

        public boolean getContentTypeHandling()
        Get the RESTRequestNode "Automatic Content-Type handling" property
        Returns:
        boolean; the value of the property "Automatic Content-Type handling"
      • setMessageDomainProperty

        public RESTRequestNode setMessageDomainProperty(java.lang.String value)
        Set the RESTRequestNode "Message domain" property
        Parameters:
        value - String ; the value to set the property "Message domain"
      • getMessageDomainProperty

        public java.lang.String getMessageDomainProperty()
        Get the RESTRequestNode "Message domain" property
        Returns:
        String; the value of the property "Message domain"
      • setMessageSetProperty

        public RESTRequestNode setMessageSetProperty(java.lang.String value)
        Set the RESTRequestNode "Message model" property
        Parameters:
        value - String ; the value to set the property "Message model"
      • getMessageSetProperty

        public java.lang.String getMessageSetProperty()
        Get the RESTRequestNode "Message model" property
        Returns:
        String; the value of the property "Message model"
      • setMessageTypeProperty

        public RESTRequestNode setMessageTypeProperty(java.lang.String value)
        Set the RESTRequestNode "Message" property
        Parameters:
        value - String ; the value to set the property "Message"
      • getMessageTypeProperty

        public java.lang.String getMessageTypeProperty()
        Get the RESTRequestNode "Message" property
        Returns:
        String; the value of the property "Message"
      • setMessageFormatProperty

        public RESTRequestNode setMessageFormatProperty(java.lang.String value)
        Set the RESTRequestNode "Physical format" property
        Parameters:
        value - String ; the value to set the property "Physical format"
      • getMessageFormatProperty

        public java.lang.String getMessageFormatProperty()
        Get the RESTRequestNode "Physical format" property
        Returns:
        String; the value of the property "Physical format"
      • setParserXmlnscBuildTreeUsingXMLSchema

        public RESTRequestNode setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
        Set the RESTRequestNode "Build tree using XML schema data types" property
        Parameters:
        value - boolean ; the value to set the property "Build tree using XML schema data types"
      • getParserXmlnscBuildTreeUsingXMLSchema

        public boolean getParserXmlnscBuildTreeUsingXMLSchema()
        Get the RESTRequestNode "Build tree using XML schema data types" property
        Returns:
        boolean; the value of the property "Build tree using XML schema data types"
      • setParserXmlnscUseForXmlnsDomain

        public RESTRequestNode setParserXmlnscUseForXmlnsDomain(boolean value)
        Set the RESTRequestNode "Use XMLNSC compact parser for XMLNS domain" property
        Parameters:
        value - boolean ; the value to set the property "Use XMLNSC compact parser for XMLNS domain"
      • getParserXmlnscUseForXmlnsDomain

        public boolean getParserXmlnscUseForXmlnsDomain()
        Get the RESTRequestNode "Use XMLNSC compact parser for XMLNS domain" property
        Returns:
        boolean; the value of the property "Use XMLNSC compact parser for XMLNS domain"
      • setSecurityProfileName

        public RESTRequestNode setSecurityProfileName(java.lang.String value)
        Set the RESTRequestNode "Security profile" property
        Parameters:
        value - String ; the value to set the property "Security profile"
      • getSecurityProfileName

        public java.lang.String getSecurityProfileName()
        Get the RESTRequestNode "Security profile" property
        Returns:
        String; the value of the property "Security profile"
      • getNodeName

        public java.lang.String getNodeName()
        Description copied from class: Node
        Gets the label name of this node
          MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow");
          Node inputMQNode = mf1.getNodeByName("My Input Node");
          inputMQNode.setNodeName("Renamed Input Node");
         
        Overrides:
        getNodeName in class Node
        Returns:
        String; the node name