ICallInfo (Java Custom Interceptor and Condition Interfaces)

```
public interface ICallInfo
```
The accessors and mutators of the different properties that appear in the context HashMap. Read-only properties only have an accessor. The mutators are used to set values in the context. In most cases, it is possible to modify the property value directly that is retrieved from the context without creating another copy. However, in some cases a copy must be created to avoid processing problems.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessPointEndpoint()` Accessor for the URL where the SOAP client sent the request to.
`java.lang.String`	`getAccessPointID()` Accessor for the unique ID of the Access Point that was invoked.
`java.lang.String`	`getAccessPointName()` Accessor for the name of the Access Point being invoked.
`java.util.Map<? extends java.lang.Object,? extends java.lang.Object>`	`getAuthenticationAttributes()` Accessor to the Map containing all the authentication attributes of the user making the request.
`java.lang.Object`	`getAuthenticationToken()` Accessor to the com.actional.security.plugin.IAuthenticationToken.
`java.util.Map<java.lang.Object,java.lang.Object>`	`getAuthorizationAttributes()` Accessor to the Map containing all the authorization attributes of the user making the request.
`java.util.List<java.lang.String>`	`getAuthorizedRolesName()` Accessor for the name of the Roles of the principal.
`java.lang.String`	`getFailureMessage()` Accessor.
`java.lang.String`	`getFullSecurityID()` Accessor for the full security ID of the user making the request.
`byte[]`	`getMessageContent()` Accessor for the actual XML message that is being processed.
`org.w3c.dom.Document`	`getMessageContentAsDocument(boolean writable)` Accessor for a read-only the actual XML message that is being processed as `Document` object NOTE - (do not pass `true`) for 'writable' parameter.
`org.w3c.dom.Element`	`getMessageHeaders(DOMType domType)` Accessor for an element that contains of all the headers in the XML document.
`MessageType`	`getMessageType()` Accessor for the type of message being processed.
`IMitigationMgr`	`getMitigationMgr()` Accessor for the implementation of `IMitigationMgr`
`IMsgFields`	`getMsgFields()` Accessor for the implementation of `IMsgFields`
`boolean`	`getOperationIsOneWay()` Accessor.
`java.lang.String`	`getOperationName()` Accessor for the name of the operation being invoked.
`java.lang.String`	`getOriginAddress()` Accessor for the address of the machine sending the request.
`java.util.Map<java.lang.String,java.util.List<java.lang.Object>>`	`getParameters()` Returns the parameters map.
`java.util.List<?>`	`getRequestCredentials()` Accessor to the collected on the request.
`java.lang.Long`	`getRequestID()` Accessor for the ID of the request being processed.
`java.lang.String`	`getRoleName()` Accessor for the name of the Role of the principal.
`java.util.Map<java.lang.Object,java.lang.Object>`	`getRoundTripScratchPad()` Accessor for a "round trip" scratch pad where interceptors can put information for future use.
`java.util.Map<java.lang.Object,java.lang.Object>`	`getScratchPad()` Accessor for a scratch pad where interceptors can put information for future use.
`java.lang.String`	`getSecurityID()` Accessor for the security ID of the user making the request.
`java.lang.String`	`getSvcGroupID()` Accessor for the ID of the service group being called.
`java.lang.String`	`getSvcGroupName()` Accessor for the name of the service group being invoked.
`java.lang.String`	`getTargetAddress()` Accessor for the address of the machine receiving the request.
`java.util.Map<java.lang.String,java.lang.Object>`	`getTransportProperties()` Accessor for the Map containing all the properties read from the transport.
`int`	`getTransportStatusCode()` Returns the transport status code.
`IXmlDocument`	`getXmlDocument(DOMType domType)` Accessor which allows having read-only access to the XML document.
`IXmlDocument`	`getXmlDocument(DOMType domType, boolean onRequest)` Accessor which allows having read-only access to the XML document.
`void`	`setMessageContent(byte[] val, boolean onRequest)` Mutator for the actual XML message that is being processed.
`void`	`setMessageContent(org.w3c.dom.Document val, boolean onRequest)` Mutator for the actual XML message that is being processed as `Document` object.
`void`	`setMessageType(java.lang.String contentType, boolean onRequest)` Sets the message type.
`void`	`setParameters(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> parameters)` Sets the parameters map.
`void`	`setTransportProperties(java.util.Map<java.lang.String,java.lang.Object> val, boolean onRequest)` Mutator for the Map containing all the properties read from the transport.
`void`	`setTransportStatusCode(int statusCode)` Sets the transport status code.
`void`	`setXmlDocument(IXmlDocument val, boolean onRequest)` Mutator which allows saving the modified XML document.

- Method Detail
  - getScratchPad
```
java.util.Map<java.lang.Object,java.lang.Object> getScratchPad()
```
    Accessor for a scratch pad where interceptors can put information for future use. For example, a header processor that executes at the Access Point and Managed service may add information to the scratch pad at the Access Point and consume it at the Managed Service. String keys in the Map starting with "SST" are reserved for use in SOAPstation.
    The type of the value in this field is: Map
    The contents of the Map itself can be modified in place.
    NOTE - this information disappears when request processing completes. It is NOT available for request end (reply) processing.
    
    Returns:
    
    Map - the scratch pad
  - getRoundTripScratchPad
```
java.util.Map<java.lang.Object,java.lang.Object> getRoundTripScratchPad()
```
    Accessor for a "round trip" scratch pad where interceptors can put information for future use.
    For example, a header processor that executes at the Access Point on request may add information to the scratch pad that it will consume at request process end (reply) processing.
    NOTE - this information DOES NOT disappear when request processing completes. It IS available for request end (reply) processing.
    String keys in the Map starting with "SST" are reserved for use in SOAPstation.
    
    Returns:
    
    Map - the scratch pad
  - getSvcGroupName
```
java.lang.String getSvcGroupName()
```
    Accessor for the name of the service group being invoked.
    
    Returns:
    
    String - the service group name
  - getAccessPointID
```
java.lang.String getAccessPointID()
```
    Accessor for the unique ID of the Access Point that was invoked.
    
    Returns:
    
    String - the access point ID
  - getOperationName
```
java.lang.String getOperationName()
```
    Accessor for the name of the operation being invoked.
    
    Returns:
    
    String - the operation name
  - getRequestID
```
java.lang.Long getRequestID()
```
    Accessor for the ID of the request being processed.
    
    Returns:
    
    Long - request ID
  - getMessageType
```
MessageType getMessageType()
```
    Accessor for the type of message being processed.
    
    Returns:
    
    MessageType
  - getMessageContent
```
byte[] getMessageContent()
```
    Accessor for the actual XML message that is being processed.
    NOTE - One must not modify the returned value. If modifications will be made, a copy must be made of this value. Any changes to the returned value can lead to unpredictable results. Use setMessageContent(byte[], boolean) to save the modified copy.
    
    Returns:
    
    byte[] - the message bytes or null if the number of bytes exceeds the memory limit.
  - getMessageContentAsDocument
```
org.w3c.dom.Document getMessageContentAsDocument(boolean writable)
                                          throws java.lang.Exception
```
    Accessor for a read-only the actual XML message that is being processed as Document object
    NOTE - (do not pass true) for 'writable' parameter.
    NOTE - One must not modify the returned value. If modifications will be made, a copy must be made of this value. Any changes to the returned document can lead to unpredictable results. Use setMessageContent(org.w3c.dom.Document, boolean) to save the modified copy.
    
    Parameters:
    
    writable - Must always be false
    
    Returns:
    
    The Document object or null if the number of bytes exceeds the memory limit.
    
    Throws:
    
    java.lang.Exception
  - setMessageContent
```
void setMessageContent(byte[] val,
                       boolean onRequest)
```
    Mutator for the actual XML message that is being processed.
    NOTE - One must not modify the value returned by getMessageContent(). If modifications will be made, a copy must be made of this value.
    NOTE - The value for the boolean "onRequest" must be true ONLY if both of the following conditions are true: A request was intercepted, and it is desired for request processing to continue when the interceptor is finished (i.e. the ReturnStatusType will be ReturnStatusType.CONTINUE or null (which is accepted as equivalent to ReturnStatusType.CONTINUE ).
    
    Parameters:
    
    val - byte[] with the message content.
    
    onRequest - must be true only if a request was intercepted and request processing will continue.
  - setMessageContent
```
void setMessageContent(org.w3c.dom.Document val,
                       boolean onRequest)
```
    Mutator for the actual XML message that is being processed as Document object.
    NOTE - One must not modify the value returned by getMessageContentAsDocument(boolean). If modifications will be made, a copy must be made of the returned document.
    NOTE - The value for the boolean "onRequest" must be true ONLY if both of the following conditions are true: A request was intercepted, and it is desired for request processing to continue when the interceptor is finished (i.e. the ReturnStatusType will be ReturnStatusType.CONTINUE or null (which is accepted as equivalent to ReturnStatusType.CONTINUE ).
    
    Parameters:
    
    val - Document object of the message content.
    
    onRequest - must be true only if a request was intercepted and request processing will continue.
  - getTransportProperties
```
java.util.Map<java.lang.String,java.lang.Object> getTransportProperties()
```
    Accessor for the Map containing all the properties read from the transport. The value associated with multi-values properties is a Collection Use setTransportProperties(java.util.Map<java.lang.String, java.lang.Object>, boolean) to save the result.
    
    Returns:
    
    Map - the transport properties
  - setTransportProperties
```
void setTransportProperties(java.util.Map<java.lang.String,java.lang.Object> val,
                            boolean onRequest)
```
    Mutator for the Map containing all the properties read from the transport.
    This field can be modified directly in place (if non null) or a copy made and set with {link #setTransportProperties}.
    NOTE - The value for the boolean "onRequest" must be true ONLY if both of the following conditions are true: A request was intercepted, and it is desired for request processing to continue when the interceptor is finished (i.e. the ReturnStatusType will be ReturnStatusType.CONTINUE or null (which is accepted as equivalent to ReturnStatusType.CONTINUE ).
    
    Parameters:
    
    val - Map - the transport properties
    
    onRequest - must be true only if a request was intercepted and request processing will continue.
  - getParameters
```
java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getParameters()
                                                                        throws java.lang.Exception
```
    Returns the parameters map. Might be null if there is no parameters map for the current message.
    
    Returns:
    
    the read-only parameters map or null if there is no parameters map for the current message.
    
    Throws:
    
    java.lang.Exception
  - setParameters
```
void setParameters(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> parameters)
            throws java.lang.Exception
```
    Sets the parameters map. It is only valid to invoke this method on requests, i.e when getMessageType() == MessageType.REQUEST.
    
    Parameters:
    
    parameters - the parameters map. Cannot be null. Note that it is critical to keep the original order of the parameters. As such, it is highly recommended to use a LinkedHashMap or functionally equivalent class to set the parameters.
    
    Throws:
    
    java.lang.Exception
    
    java.lang.IllegalStateException
  - setMessageType
```
void setMessageType(java.lang.String contentType,
                    boolean onRequest)
```
    Sets the message type. This method does more than setting the message content type. It might also change the class that abstracts the representation of the message.
    
    Parameters:
    
    contentType - the content type of the message.
    
    onRequest - true to set the content type of the request, false to set the content type of the reply.
  - setTransportStatusCode
```
void setTransportStatusCode(int statusCode)
```
    Sets the transport status code.
    NOTE - On requests, the transport status code should only be set when the interceptor sets a return status of ReturnStatusType.REPLY or ReturnStatusType.ERROR. On replies, the transport status code should only be set when the interceptor sets a return status of ReturnStatusType.CONTINUE, ReturnStatusType.REPLY or ReturnStatusType.ERROR.
    See IInterceptor.IInvokeContext.setReturnStatus(ReturnStatusType).
    NOTE - Invoking this method in interceptors executed by Actional Agent will throw an IllegalStateException.
    
    Parameters:
    
    statusCode - the reply status code. Currently ignored for JMS.
  - getTransportStatusCode
```
int getTransportStatusCode()
```
    Returns the transport status code. Depending on the implementation, this method might return an invalid value if the transport status code has not yet been set. It will typically be the case when invoked on requests or when the interceptor is executed by Actional Agent.
    
    Returns:
    
    the current transport status code.
  - getOperationIsOneWay
```
boolean getOperationIsOneWay()
```
    Accessor. True if this operation is one way.
    
    Returns:
    
    boolean true if operation is one-way.
  - getAccessPointEndpoint
```
java.lang.String getAccessPointEndpoint()
```
    Accessor for the URL where the SOAP client sent the request to.
    
    Returns:
    
    String access point endpoint.
  - getOriginAddress
```
java.lang.String getOriginAddress()
```
    Accessor for the address of the machine sending the request.
    
    Returns:
    
    String the machine address.
  - getTargetAddress
```
java.lang.String getTargetAddress()
```
    Accessor for the address of the machine receiving the request.
    
    Returns:
    
    String the machine address.
  - getSvcGroupID
```
java.lang.String getSvcGroupID()
```
    Accessor for the ID of the service group being called.
    
    Returns:
    
    String the service group ID.
  - getAccessPointName
```
java.lang.String getAccessPointName()
```
    Accessor for the name of the Access Point being invoked.
    
    Returns:
    
    String the access point name.
  - getFailureMessage
```
java.lang.String getFailureMessage()
```
    Accessor. If the MessageType is set to MessageType.FAULT_INTERNAL or MessageType.FAULT_EXTERNAL, this returns the reason for the failure.
    
    Returns:
    
    String the reason for failure.
  - getRoleName
```
java.lang.String getRoleName()
```
    Accessor for the name of the Role of the principal. This only applies when using Role based authorization in the Intermediary.
    
    Returns:
    
    the role name of the principal.
  - getAuthorizedRolesName
```
java.util.List<java.lang.String> getAuthorizedRolesName()
```
    Accessor for the name of the Roles of the principal. This only applies when are using Role based authorization in the Intermediary.
    
    Returns:
    
    the roles name of the principal
  - getSecurityID
```
java.lang.String getSecurityID()
```
    Accessor for the security ID of the user making the request.
    
    Returns:
    
    String the security ID.
  - getFullSecurityID
```
java.lang.String getFullSecurityID()
```
    Accessor for the full security ID of the user making the request.
    
    Returns:
    
    String the full security ID.
  - getAuthenticationAttributes
```
java.util.Map<? extends java.lang.Object,? extends java.lang.Object> getAuthenticationAttributes()
```
    Accessor to the Map containing all the authentication attributes of the user making the request.
    
    Returns:
    
    Map - the authentication attributes
  - getAuthorizationAttributes
```
java.util.Map<java.lang.Object,java.lang.Object> getAuthorizationAttributes()
```
    Accessor to the Map containing all the authorization attributes of the user making the request.
    
    Returns:
    
    Map - the authorization attributes
  - getAuthenticationToken
```
java.lang.Object getAuthenticationToken()
```
    Accessor to the com.actional.security.plugin.IAuthenticationToken. Will be null if the Access Point was not configured to authenticate the caller.
  - getRequestCredentials
```
java.util.List<?> getRequestCredentials()
```
    Accessor to the collected on the request.
  - getMitigationMgr
```
IMitigationMgr getMitigationMgr()
```
    Accessor for the implementation of IMitigationMgr
    
    Returns:
    
    IMitigationMgr
  - getMsgFields
```
IMsgFields getMsgFields()
```
    Accessor for the implementation of IMsgFields
    
    Returns:
    
    IMsgFields
  - getXmlDocument
```
IXmlDocument getXmlDocument(DOMType domType)
```
    Accessor which allows having read-only access to the XML document.
    The only methods that should be called on this IXmlDocument are:
    - IXmlDocument.getBytesInMemory()
    - IXmlDocument.getBytesIfAllInMemory(boolean)
    - getDOM(false) (do not pass true)
    - IXmlDocument.execute(IXPathEvaluator, boolean) (do not pass true in the second argument)
    - IXmlDocument.hasBytes()
    - IXmlDocument.hasDOM()
    - IXmlDocument.hasDTM()
    - IXmlDocument.getScratchPad()
    - IXmlDocument.getMonitor()
    Modifying the DOM returned by IXmlDocument.getDOM(boolean) or the byte array returned by IXmlDocument.getBytesInMemory() or IXmlDocument.getBytesIfAllInMemory(boolean) can lead to unpredictable results.
    You are allowed to add/remove/change entries in the Map returned by IXmlDocument.getScratchPad().
    When you know that you do not need to make modifications to the XML document, requesting a read-only document helps improving performance as the platform knows that it can share the same data structures between various sub-systems of the platform.
    Parameters:
    
    domType - Either DOMType.XML_DOCUMENT_READ_WRITE to obtain a document which one can modify or DOMType.XML_DOCUMENT_READ_ONLY
    
    Returns:
    
    IXmlDocument The XML document
  - getXmlDocument
```
IXmlDocument getXmlDocument(DOMType domType,
                            boolean onRequest)
```
    Accessor which allows having read-only access to the XML document.
    The only methods that should be called on this IXmlDocument are:
    - IXmlDocument.getBytesInMemory()
    - IXmlDocument.getBytesIfAllInMemory(boolean)
    - getDOM(false) (do not pass true)
    - IXmlDocument.execute(IXPathEvaluator, boolean) (do not pass true in the second argument)
    - IXmlDocument.hasBytes()
    - IXmlDocument.hasDOM()
    - IXmlDocument.hasDTM()
    - IXmlDocument.getScratchPad()
    - IXmlDocument.getMonitor()
    Modifying the DOM returned by IXmlDocument.getDOM(boolean) or the byte array returned by IXmlDocument.getBytesInMemory() or IXmlDocument.getBytesIfAllInMemory(boolean) can lead to unpredictable results.
    You are allowed to add/remove/change entries in the Map returned by IXmlDocument.getScratchPad().
    When you know that you do not need to make modifications to the XML document, requesting a read-only document helps improving performance as the platform knows that it can share the same data structures between various sub-systems of the platform.
    Parameters:
    
    domType - Either DOMType.XML_DOCUMENT_READ_WRITE to obtain a document which one can modify or DOMType.XML_DOCUMENT_READ_ONLY
    
    onRequest - true to get the request IXmlDocument, false to get the response IXmlDocument.
    
    Returns:
    
    IXmlDocument The XML document
  - setXmlDocument
```
void setXmlDocument(IXmlDocument val,
                    boolean onRequest)
```
    Mutator which allows saving the modified XML document. One must have retrieved the document by using DOMType.XML_DOCUMENT_READ_WRITE.
    NOTE - The value for the boolean "onRequest" must be true ONLY if both of the following conditions are true: A request was intercepted, and it is desired for request processing to continue when the interceptor is finished (i.e. the ReturnStatusType will be ReturnStatusType.CONTINUE or null (which is accepted as equivalent to ReturnStatusType.CONTINUE ).
    
    Parameters:
    
    val - The modified XML document.
    
    onRequest - must be true only if a request was intercepted and request processing will continue.
  - getMessageHeaders
```
org.w3c.dom.Element getMessageHeaders(DOMType domType)
```
    Accessor for an element that contains of all the headers in the XML document. If one needs write access, pass the value "true" for writable. The value of this field may be null if such an element does not exist in the document. If the value "true" is passed for createIfAbsent, an Element will be created if the element does not exist in the document. Also, in this case, the value writable will be ignored.
    The returned value must only be modified, i.e. operations like Node.appendChild(org.w3c.dom.Node) which modify the structure of the DOM document must only be called, if the message headers were retrieved using DOMType.MESSAGE_HEADERS_CREATE or DOMType.MESSAGE_HEADERS_READ_WRITE. Otherwise, an exception might be thrown.
    CAUTION - if this value is modified by an interceptor, it is being modified IN PLACE.
    
    Parameters:
    
    domType - One of DOMType.MESSAGE_HEADERS_READ_ONLY, DOMType.MESSAGE_HEADERS_READ_WRITE, or DOMType.MESSAGE_HEADERS_CREATE if one wants an empty Element returned if the element does not exist.
    
    Returns:
    
    Element the element with the message headers or null.

Interface ICallInfo

Method Summary

Method Detail

getScratchPad

getRoundTripScratchPad

getSvcGroupName

getAccessPointID

getOperationName

getRequestID

getMessageType

getMessageContent

getMessageContentAsDocument

setMessageContent

setMessageContent

getTransportProperties

setTransportProperties

getParameters

setParameters

setMessageType

setTransportStatusCode

getTransportStatusCode

getOperationIsOneWay

getAccessPointEndpoint

getOriginAddress

getTargetAddress

getSvcGroupID

getAccessPointName

getFailureMessage

getRoleName

getAuthorizedRolesName

getSecurityID

getFullSecurityID

getAuthenticationAttributes

getAuthorizationAttributes

getAuthenticationToken

getRequestCredentials

getMitigationMgr

getMsgFields

getXmlDocument

getXmlDocument

setXmlDocument

getMessageHeaders