idman.neg
Interface NegotiationHandler

All Known Implementing Classes:

NegotiationHandlerImpl

public interface NegotiationHandler

Interface for all NegotiationHandler-objects. There is the possibility to create different negotiation-strategies in different NegotiationHandler-objects.

Since:

11. 07. 02

Version:

$Id: NegotiationHandler.java,v 1.11 2004/01/29 09:40:30 tk4 Exp $

Author:

Sven Doering, Thomas Kriegelstein

Method Summary

void	addListener(idman.neg.NegotiationListener listener)
java.util.Map	getReceivedData() Returns the received data.
java.lang.String[]	getReceivedPurpose(java.lang.String key, java.lang.String retention) Returns the received purposes for given data and corresponding retention.
java.lang.String[]	getReceivedRecipient(java.lang.String key, java.lang.String retention) Returns the received recipients for given data and corresponding retention.
java.lang.String[]	getReceivedRetention(java.lang.String key) Returns the storage durations for given data.
java.util.Map	getSentData() Returns the sent data.
java.lang.String[]	getSentPurpose(java.lang.String key, java.lang.String retention) Returns the sent purposes for given data and corresponding retention.
java.lang.String[]	getSentRecipient(java.lang.String key, java.lang.String retention) Returns the sent recipients for given data and corresponding retention.
java.lang.String[]	getSentRetention(java.lang.String key) Returns the storage durations for given data.
void	init(idman.neg.PersonalData data, org.w3c.dom.Document ruleset) Sets the data (PersonalData) and data-handling (ruleset).
idman.neg.NegotiationResult	negotiate(org.w3c.dom.Document request) Executes the Negotiation-process.
void	removeListener(idman.neg.NegotiationListener listener)
void	setInitialRequiredData(org.w3c.dom.Document request) Sets the initial required data by the start of negotiation.

Method Detail

init

public void init(idman.neg.PersonalData data,
                 org.w3c.dom.Document ruleset)
          throws java.lang.Exception

Sets the data (PersonalData) and data-handling (ruleset).

Parameters:

data - Data to disclose

ruleset - Rules for disclosure

java.lang.Exception

negotiate

public idman.neg.NegotiationResult negotiate(org.w3c.dom.Document request)

Executes the Negotiation-process.

Parameters:

request - Document to respond to

Returns:

NegotiationResult response

setInitialRequiredData

public void setInitialRequiredData(org.w3c.dom.Document request)
                            throws java.lang.Exception

Sets the initial required data by the start of negotiation.

Parameters:

request - Data requested in 1st request

java.lang.Exception

getReceivedData

public java.util.Map getReceivedData()

Returns the received data.

Returns:

Map received data

getSentData

public java.util.Map getSentData()

Returns the sent data.

Returns:

Map sent data

getReceivedPurpose

public java.lang.String[] getReceivedPurpose(java.lang.String key,
                                             java.lang.String retention)

Returns the received purposes for given data and corresponding retention.

Parameters:

key - name of data

retention - storage duration

Returns:

array with purposes

getReceivedRecipient

public java.lang.String[] getReceivedRecipient(java.lang.String key,
                                               java.lang.String retention)

Returns the received recipients for given data and corresponding retention.

Parameters:

key - name of data

retention - storage duration

Returns:

array with recipients

getReceivedRetention

public java.lang.String[] getReceivedRetention(java.lang.String key)

Returns the storage durations for given data.

Parameters:

key - name of data

Returns:

array with storage durations

getSentPurpose

public java.lang.String[] getSentPurpose(java.lang.String key,
                                         java.lang.String retention)

Returns the sent purposes for given data and corresponding retention.

Parameters:

key - name of data

retention - storage duration

Returns:

array with purposes

getSentRecipient

public java.lang.String[] getSentRecipient(java.lang.String key,
                                           java.lang.String retention)

Returns the sent recipients for given data and corresponding retention.

Parameters:

key - name of data

retention - storage duration

Returns:

array with recipients

getSentRetention

public java.lang.String[] getSentRetention(java.lang.String key)

Returns the storage durations for given data.

Parameters:

key - name of data

Returns:

array with storage durations

addListener

public void addListener(idman.neg.NegotiationListener listener)

removeListener

public void removeListener(idman.neg.NegotiationListener listener)