BodyBlock (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.soap.BodyBlock

All Implemented Interfaces:

MustUnderstandFault
```
public class BodyBlock
extends java.lang.Object
implements MustUnderstandFault
```
A BodyBlock is a wrapper object around one method in a SOAP Envelope. A method is a tag in the Body of the Envelope. The SOAP Processor creates a SOAPTransaction for each Envelope that it receives. Internally, the SOAP transaction will create a BodyBlock for each method in the Body of the Envelope. This is called the request BodyBlock. In addition, the SOAPTransaction will create another BodyBlock that will be put in the Body of the response Envelope. This is called the response BodyBlock. The response BodyBlock uses the tagname of the request BodyBlock to create it's own tagname. It appends 'Response' to the tag. So, if the request BodyBlock is <GetOrders xmlns="orders">, then the response will be <GetOrdersResponse xmlns="orders">. This node can be retrieved from the BodyBlock through the BodyBlock.getXMLNode() method. BodyBlocks always exist in pairs. Each request BodyBlock creates it's own response BodyBlock.
For each SOAPTransaction, the ApplicationConnectors have to create an ApplicationTransaction. During the handling of each BodyBlock, the SOAPTransaction will ask each of the ApplicationTransactions if it can process the BodyBlock, and if so, it will call the process() method. So each BodyBlock will be processed within the context of an ApplicationTransaction.
If the ApplicationTransaction decides that the data in the BodyBlock causes the transaction to be aborted, it can return false from the process() method. Such an action usually is represented in the response SOAP Envelope by means of a SOAP Fault tag. This tag can be created through the BodyBlock.createSOAPFault(); method.
The processing of a BodyBlock by the SOAP Processor happens in a synchronous manner. This means, that each BodyBlock is handled in the order in which it appears in the SOAP Processor. However, in some cases, handling of a BodyBlock may be very expensive, and the ApplicationTransaction that is processing the BodyBlock may decide to do this in an asynchronous manner, so that the SOAP Processor can continue handling the remaining BodyBlocks (and even subsequent SOAP Envelopes). In order to do so, the ApplicationTransaction can call the BodyBlock.setAsync(true); method. In order to tell the SOAP Processor that it can continue with the SOAPTransaction after the ApplicationTransaction has completed handling of the BodyBlock, the ApplicationTransaction can call the BodyBlock.continueTransaction(); method (or, in case of error, BodyBlock.abortTransaction();).

Constructor Summary

Constructors
Constructor and Description
`BodyBlock(int node, SOAPTransaction soapTransaction, MethodDefinition definition)`
`BodyBlock(int methodNode, SOAPTransaction soapTransaction, MethodDefinition definition, int requestEnvelopeNode, int responseEnvelopeNode)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortTransaction()` Indicates to the SOAP Processor that it can abort the transaction in which this body block is being handled, and can continue processing it by sending the response back to the client.
`void`	`continueTransaction()` Indicates to the SOAP Processor that it can continue processing the transaction in which this body block is being handled.
`Fault`	`createSOAPFault(javax.xml.namespace.QName faultCode, IStringResource faultString, java.lang.Object... arguments)` Creates the SOAP Fault and returns the soap fault object.
`Fault`	`createSOAPFault(javax.xml.namespace.QName faultCode, java.lang.String faultActor, IStringResource faultString, java.lang.Object... arguments)` Creates the SOAP Fault and returns the soap fault object.
`int`	`createSOAPFault(java.lang.String faultCode, java.lang.String faultString)` Deprecated. use createSOAPFault(QName faultCode, IStringResource faultString, Object... arguments)
`MethodDefinition`	`getDefinition()` Deprecated. since BCP 4.2
`org.w3c.dom.Element`	`getDOMElement()`
`MethodDefinition`	`getMethodDefinition()` Returns MethodDefinition object from Cache
`Request`	`getRequest()` Deprecated. Use getSOAPTransaction instead
`BodyBlock`	`getRequestBodyBlock()` Returns the request body block.
`BodyBlock`	`getResponseBodyBlock()` Returns the response body block.
`int`	`getRootSOAPBodyNode()`
`int`	`getSOAPEnvelopeNode()`
`Fault`	`getSoapFault()` Returns the SOAP fault, if any.
`java.lang.String`	`getSoapPrefix()` Deprecated. This method is not applicable any more, use XML NOM API to retreive the prefix of the SOAP Body node.
`SOAPTransaction`	`getSOAPTransaction()` Returns the SOAP Transaction in which this body block forms a part.
`int`	`getXMLNode()` Returns the xml node for this body block
`boolean`	`isAsync()` Returns whether or not the soap processor should handle this body block asynchronous.
`boolean`	`isPending()` Indicates that the ApplicationTransaction handling this body block has completed it's work, either by having called the continueTransaction() or the abortTransaction() method.
`boolean`	`mustUnderstand()` Deprecated.
`Fault`	`raiseMustUnderstandFault(IStringResource faultString, java.lang.Object... faultStringArgument)` Sets the fault to the user specified Fault.
`void`	`setAsync(boolean async)` Indicates that completion of handling of this body block will be indicated by the application connector.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BodyBlock
```
public BodyBlock(int methodNode,
                 SOAPTransaction soapTransaction,
                 MethodDefinition definition,
                 int requestEnvelopeNode,
                 int responseEnvelopeNode)
```
  - BodyBlock
```
public BodyBlock(int node,
                 SOAPTransaction soapTransaction,
                 MethodDefinition definition)
```
- Method Detail
  - setAsync
```
public void setAsync(boolean async)
```
    Indicates that completion of handling of this body block will be indicated by the application connector. This means that the SOAP Processor will only send the response to the client after the application connector has made a call to the continueTransaction or abortTransaction method. Notice, if multiple body blocks are in one SOAP message, then the SOAP Processor will immediately continue processing these other body blocks as well. This means, that body blocks can be handled all in async order.
  - isAsync
```
public boolean isAsync()
```
    Returns whether or not the soap processor should handle this body block asynchronous.
    
    Returns:
    
    whether or not the soap processor should handle this body block asynchronous.
  - continueTransaction
```
public void continueTransaction()
```
    Indicates to the SOAP Processor that it can continue processing the transaction in which this body block is being handled.
  - abortTransaction
```
public void abortTransaction()
```
    Indicates to the SOAP Processor that it can abort the transaction in which this body block is being handled, and can continue processing it by sending the response back to the client.
  - isPending
```
public boolean isPending()
```
    Indicates that the ApplicationTransaction handling this body block has completed it's work, either by having called the continueTransaction() or the abortTransaction() method.
    
    Returns:
    
    true if the BodyBlock has been handled. False otherwise
  - getDefinition
```
public MethodDefinition getDefinition()
```
    Deprecated. since BCP 4.2
    
    Returns:
    
    returns a new MethodDefinition object Recommended to use getMethodDefinition method
    
    See Also:
    
    getMethodDefinition
  - getMethodDefinition
```
public MethodDefinition getMethodDefinition()
```
    Returns MethodDefinition object from Cache
    
    Returns:
    
    the definition of the method in the LDAP Server.
  - getRequestBodyBlock
```
public BodyBlock getRequestBodyBlock()
```
    Returns the request body block. If this is already the request body block, then the this will be returned.
  - getResponseBodyBlock
```
public BodyBlock getResponseBodyBlock()
```
    Returns the response body block. If this is already the response body block, then the this will be returned.
  - getRequest
```
public Request getRequest()
```
    Deprecated. Use getSOAPTransaction instead
    
    Returns:
    
    A deprecated Request object
  - getSOAPTransaction
```
public SOAPTransaction getSOAPTransaction()
```
    Returns the SOAP Transaction in which this body block forms a part.
    
    Returns:
    
    the SOAP Transaction in which this body block forms a part.
  - createSOAPFault
```
public int createSOAPFault(java.lang.String faultCode,
                           java.lang.String faultString)
```
    Deprecated. use createSOAPFault(QName faultCode, IStringResource faultString, Object... arguments)
    
    Changes this body block into a soap fault, i.e., the tag name will be changed from whatever it was into %lt;SOAP:Fault>, and a %lt;SOAP:faultcode> and %lt;SOAP:faultstring> will be attached to it with the specified values. In addition, a %lt;detail> element will be created an returned for further processing (e.g., attaching a stacktrace of an exception).
    
    Parameters:
    
    faultCode - The text to be put in the %lt;SOAP:faultcode>
    
    faultString - The text to be put in the %lt;SOAP:faultstring>
    
    Returns:
    
    An xml node pointing to the %lt;detail> element
  - getXMLNode
```
public int getXMLNode()
```
    Returns the xml node for this body block
    
    Returns:
    
    the xml node for this body block
  - getDOMElement
```
public org.w3c.dom.Element getDOMElement()
```
  - mustUnderstand
```
public boolean mustUnderstand()
```
    Deprecated.
    
    Returns true if the mustUnderstand attribute on the request body block is set to true (i.e., if it has the value 1).
    
    Returns:
    
    true if the body block has attribute mustUnderstand with value is 1, false otherwise.
  - createSOAPFault
```
public Fault createSOAPFault(javax.xml.namespace.QName faultCode,
                             IStringResource faultString,
                             java.lang.Object... arguments)
```
    Creates the SOAP Fault and returns the soap fault object. Fault code and fault string cannot be null.
    
    Parameters:
    
    faultCode - The fault code
    
    faultString - The fault string
    
    arguments - The dynamic insertion arguments to be passed to the fault string
    
    Returns:
    
    the Fault object if the soap fault is created successfully otherwise returns null
  - createSOAPFault
```
public Fault createSOAPFault(javax.xml.namespace.QName faultCode,
                             java.lang.String faultActor,
                             IStringResource faultString,
                             java.lang.Object... arguments)
```
    Creates the SOAP Fault and returns the soap fault object. Fault code and fault string cannot be null.
    
    Parameters:
    
    faultCode - The fault code
    
    faultActor - The fault actor
    
    faultString - The fault string
    
    arguments - The dynamic insertion arguments to be passed to the fault string
    
    Returns:
    
    the Fault object if the soap fault is created successfully otherwise returns null
  - raiseMustUnderstandFault
```
public Fault raiseMustUnderstandFault(IStringResource faultString,
                                      java.lang.Object... faultStringArgument)
```
    Description copied from interface: MustUnderstandFault
    
    Sets the fault to the user specified Fault. The faultcode must be SOAP's 'Must Understand' faultcode.
    
    Specified by:
    
    raiseMustUnderstandFault in interface MustUnderstandFault
    
    Returns:
    
    the Fault object.
  - getSoapPrefix
```
public java.lang.String getSoapPrefix()
```
    Deprecated. This method is not applicable any more, use XML NOM API to retreive the prefix of the SOAP Body node.
    
    Returns:
    
    the soap prefix from the request body node
  - getSoapFault
```
public Fault getSoapFault()
```
    Returns the SOAP fault, if any. Null otherwise.
    
    Returns:
    
    the SOAP fault, if any. Null otherwise.
  - getSOAPEnvelopeNode
```
public int getSOAPEnvelopeNode()
```
    Returns:
    
    the corresponding SOAP Envelope node for the Cordys Method.
  - getRootSOAPBodyNode
```
public int getRootSOAPBodyNode()
```

Class BodyBlock

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BodyBlock

BodyBlock

Method Detail

setAsync

isAsync

continueTransaction

abortTransaction

isPending

getDefinition

getMethodDefinition

getRequestBodyBlock

getResponseBodyBlock

getRequest

getSOAPTransaction

createSOAPFault

getXMLNode

getDOMElement

mustUnderstand

createSOAPFault

createSOAPFault

raiseMustUnderstandFault

getSoapPrefix

getSoapFault

getSOAPEnvelopeNode

getRootSOAPBodyNode