xdi2.messaging.container.contributor

Interface Contributor

All Superinterfaces:

Extension<MessagingContainer>

All Known Implementing Classes:

AbstractContributor, GenerateDigestSecretTokenContributor, GenerateKeyContributor

public interface Contributor
extends Extension<MessagingContainer>

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.container.Extension

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Method Summary

Modifier and Type	Method and Description
ContributorResult	executeOnAddress(XDIAddress[] contributorXDIAddresses, XDIAddress contributorsXDIAddress, XDIAddress relativeTargetXDIAddress, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Executes an XDI operation on an address.
ContributorResult	executeOnStatement(XDIAddress[] contributorChainXDIAddresses, XDIAddress contributorChainXDIAddress, XDIStatement relativeTargetXDIStatement, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Executes an XDI operation on a statement.
ContributorMount	getContributorMount()
ContributorMap	getContributors()
void	setContributors(ContributorMap contributors)

Methods inherited from interface xdi2.messaging.container.Extension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Method Detail

getContributorMount

ContributorMount getContributorMount()

getContributors

ContributorMap getContributors()

setContributors

void setContributors(ContributorMap contributors)

executeOnAddress

ContributorResult executeOnAddress(XDIAddress[] contributorXDIAddresses,
                                   XDIAddress contributorsXDIAddress,
                                   XDIAddress relativeTargetXDIAddress,
                                   Operation operation,
                                   Graph operationResultGraph,
                                   ExecutionContext executionContext)
                            throws Xdi2MessagingException

Executes an XDI operation on an address.

Parameters:

contributorChainXDIAddresses - The individual addresses in the contributor chain.

contributorChainXDIAddress - The complete address of the contributor chain.

relativeTargetXDIAddress - The relative target address.

operation - The operation that is being executed.

operationResultGraph - The operation's message result.

executionContext - An "execution context" object for the entire XDI message envelope.

Returns:

True, if the operation has been fully handled and the server should stop processing it.

Throws:

Xdi2MessagingException

executeOnStatement

ContributorResult executeOnStatement(XDIAddress[] contributorChainXDIAddresses,
                                     XDIAddress contributorChainXDIAddress,
                                     XDIStatement relativeTargetXDIStatement,
                                     Operation operation,
                                     Graph operationResultGraph,
                                     ExecutionContext executionContext)
                              throws Xdi2MessagingException

Executes an XDI operation on a statement.

Parameters:

contributorChainXDIAddresses - The individual addresses in the contributor chain.

contributorChainXDIAddress - The complete address of the contributor chain.

relativeTargetXDIStatement - The relative target statement.

operation - The operation that is being executed.

operationResultGraph - The operation's message result.

executionContext - An "execution context" object for the entire XDI message envelope.

Returns:

True, if the operation has been fully handled and the server should stop processing it.

Throws:

Xdi2MessagingException