com.ibm.wsgw.beans
Interface MessageWarehouse

All Known Subinterfaces:
MessageWarehouseRemote

public interface MessageWarehouse

The MessageWarehouse interface encapsulates a service which stores messages for archival.

This interface is used by the Channels to log incoming requests for the purposes of non-repudiation.

Version:
1.12
Author:
 
See Also:

Field Summary
static java.lang.String copyright
          Copyright string.
static java.lang.String JNDI_NAME
           
 
Method Summary
 void logException(java.lang.String channelName, java.lang.String originator, java.lang.String gatewayServiceName, java.lang.String operationName, java.sql.Timestamp exceptionTime, org.apache.wsif.WSIFRequest request, java.lang.Throwable exception, java.io.Serializable[] details)
          Stores a request in the event of an exception occurring within the Gateway, with the exception information along with the channel and the originator of the request.
 void logRequest(java.lang.String channelName, java.lang.String originator, java.lang.String gatewayServiceName, java.lang.String operationName, java.sql.Timestamp receiptTime, org.apache.wsif.WSIFRequest request, java.io.Serializable[] details)
          Stores a request, along with information about the channel and originator of the message.
 void logResponse(java.lang.String channelName, java.lang.String destination, java.sql.Timestamp sendTime, org.apache.wsif.WSIFResponse response, java.io.Serializable[] details)
          Stores a response, along with information about the channel and the destination for the response.
 

Field Detail

copyright

public static final java.lang.String copyright
Copyright string. Any code placed between the comments will be over written

JNDI_NAME

public static final java.lang.String JNDI_NAME
Method Detail

logRequest

public void logRequest(java.lang.String channelName,
                       java.lang.String originator,
                       java.lang.String gatewayServiceName,
                       java.lang.String operationName,
                       java.sql.Timestamp receiptTime,
                       org.apache.wsif.WSIFRequest request,
                       java.io.Serializable[] details)
                throws WSGWException,
                       java.rmi.RemoteException
Stores a request, along with information about the channel and originator of the message.

It is called by a channel when a request is received, after the user has been authenticated and the message decrypted. The channel may provide information to identify the originator of the request, and to identify the Channel itself.

The message itself is logged as an array of bytes, as for non-repudiation it must be logged before the Channel or Gateway have done any processing on it.

The details parameter may be used to record any other information pertinent to the receipt of the request. The parameter should contain Serializable objects.

Parameters:
channelName - The name of the receiving channel.
originator - The originator of the request.
gatewayServiceName - The name of the service being invoked (if available).
operationName - The name of the operation being invoked (if available).
receiptTime - The receipt time.
message - The request bitstream.
details - A list of objects with further details of the request.
Returns:
 
Throws:
WSGWException - An error occurred writing the message.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

logResponse

public void logResponse(java.lang.String channelName,
                        java.lang.String destination,
                        java.sql.Timestamp sendTime,
                        org.apache.wsif.WSIFResponse response,
                        java.io.Serializable[] details)
                 throws WSGWException,
                        java.rmi.RemoteException
Stores a response, along with information about the channel and the destination for the response.

It is called by a channel when a response is about to be sent. The channel may provide information to identify the destination for the response, and to identify the Channel itself.

The message itself is logged as an array of bytes, as for non-repudiation it must be logged after the Channel or Gateway have done any processing on it.

The details parameter may be used to record any other information pertinent to the sending of the response. The parameter should contain Serializable objects.

Parameters:
channelName - The name of the responding channel.
destination - The destination for the response.
sendTime - The send time.
message - The response bitstream.
details - A list of objects with further details of the response.
Returns:
 
Throws:
WSGWException - An error occurred writing the message.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

logException

public void logException(java.lang.String channelName,
                         java.lang.String originator,
                         java.lang.String gatewayServiceName,
                         java.lang.String operationName,
                         java.sql.Timestamp exceptionTime,
                         org.apache.wsif.WSIFRequest request,
                         java.lang.Throwable exception,
                         java.io.Serializable[] details)
                  throws WSGWException,
                         java.rmi.RemoteException
Stores a request in the event of an exception occurring within the Gateway, with the exception information along with the channel and the originator of the request.

It is called by a channel when an exception is caught as a result of processing a request.

Parameters:
channelName - The name of the responding channel.
originator - The originator of the request.
gatewayServiceName - The name of the service being invoked (if available).
operationName - The name of the operation being invoked (if available).
exceptionTime - The time at which the exception occurred.
request - The request bitstream.
exception - The exception.
details - A list of objects with further details of the request.
Returns:
 
Throws:
WSGWException - An error occurred writing the message.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:


Copyright © 2002 IBM. All Rights Reserved.