org.apache.wsif
Interface WSIFCorrelationService

All Known Implementing Classes:

WSIFDefaultCorrelationService

public interface WSIFCorrelationService

A WSIFCorrelationService is used for asynchronous requests to correlate a response with the instance of the handler that issued the request.

Author:

Ant Elder

Method Summary

java.io.Serializable	get(WSIFCorrelationId id) Retrieves an entry from the correlation service.
void	put(WSIFCorrelationId correlator, java.io.Serializable state, long timeout) Adds an entry to the correlation service.
void	remove(WSIFCorrelationId id) Removes an entry form the correlation service.

Method Detail

put

public void put(WSIFCorrelationId correlator,
                java.io.Serializable state,
                long timeout)
         throws WSIFException

Adds an entry to the correlation service.

Parameters:

correlator - the key to associate with the state.

state - the state to be stored.

timeout - a timeout period after which the key and associated state will be deleted from the correlation service.

Throws:

WSIFException

get

public java.io.Serializable get(WSIFCorrelationId id)
                         throws WSIFException

Retrieves an entry from the correlation service.

Parameters:

id - the key of the state to retrieved

Returns:

the state associated with the id

Throws:

WSIFException

remove

public void remove(WSIFCorrelationId id)
            throws WSIFException

Removes an entry form the correlation service.

Parameters:

id - the key of entry to be removed

Throws:

WSIFException