AbstractContributor (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractExtension<MessagingTarget>
- - xdi2.messaging.target.contributor.AbstractContributor

All Implemented Interfaces:

Contributor, Extension<MessagingTarget>

Direct Known Subclasses:

GenerateDigestSecretTokenContributor, GenerateKeyContributor, MessageResultContributor
```
public abstract class AbstractContributor
extends AbstractExtension<MessagingTarget>
implements Contributor
```

Nested Class Summary
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Extension
  Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Field Summary
- Fields inherited from class xdi2.messaging.target.impl.AbstractExtension
  DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors
Constructor and Description

AbstractContributor()

AbstractContributor(int initPriority, int shutdownPriority)

Constructors
Constructor and Description
`AbstractContributor()`
`AbstractContributor(int initPriority, int shutdownPriority)`

Method Summary

Methods
Modifier and Type	Method and Description
`ContributorResult`	`executeDelOnAddress(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIAddress relativeTargetAddress, DelOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDelOnContextNodeStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DelOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDelOnLiteralStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DelOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDelOnRelationStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DelOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDelOnStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DelOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDoOnAddress(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIAddress relativeTargetAddress, DoOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDoOnContextNodeStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DoOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDoOnLiteralStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DoOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDoOnRelationStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DoOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeDoOnStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, DoOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeGetOnAddress(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIAddress relativeTargetAddress, GetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeGetOnContextNodeStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, GetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeGetOnLiteralStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, GetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeGetOnRelationStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, GetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeGetOnStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, GetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeOnAddress(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIAddress relativeTargetAddress, Operation operation, MessageResult messageResult, ExecutionContext executionContext)` Executes an XDI operation on an address.
`ContributorResult`	`executeOnStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, Operation operation, MessageResult messageResult, ExecutionContext executionContext)` Executes an XDI operation on a statement.
`ContributorResult`	`executeSetOnAddress(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIAddress relativeTargetAddress, SetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeSetOnContextNodeStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, SetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeSetOnLiteralStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, SetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeSetOnRelationStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, SetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorResult`	`executeSetOnStatement(XDIAddress[] contributorAddresses, XDIAddress contributorsAddress, XDIStatement relativeTargetStatement, SetOperation operation, MessageResult messageResult, ExecutionContext executionContext)`
`ContributorMount`	`getContributorMount()`
`ContributorMap`	`getContributors()`
`void`	`setContributors(ContributorMap contributors)`

Methods inherited from class xdi2.messaging.target.impl.AbstractExtension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdi2.messaging.target.Extension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Constructor Detail

AbstractContributor

public AbstractContributor(int initPriority,
                   int shutdownPriority)

AbstractContributor
```
public AbstractContributor()
```

Method Detail

executeOnAddress

public ContributorResult executeOnAddress(XDIAddress[] contributorAddresses,
                                 XDIAddress contributorsAddress,
                                 XDIAddress relativeTargetAddress,
                                 Operation operation,
                                 MessageResult messageResult,
                                 ExecutionContext executionContext)
                                   throws Xdi2MessagingException

Description copied from interface: Contributor

Executes an XDI operation on an address.

Specified by:: executeOnAddress in interface Contributor; relativeTargetAddress - The relative target address.; operation - The operation that is being executed.; messageResult - 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

executeGetOnAddress

public ContributorResult executeGetOnAddress(XDIAddress[] contributorAddresses,
                                    XDIAddress contributorsAddress,
                                    XDIAddress relativeTargetAddress,
                                    GetOperation operation,
                                    MessageResult messageResult,
                                    ExecutionContext executionContext)
                                      throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeSetOnAddress

public ContributorResult executeSetOnAddress(XDIAddress[] contributorAddresses,
                                    XDIAddress contributorsAddress,
                                    XDIAddress relativeTargetAddress,
                                    SetOperation operation,
                                    MessageResult messageResult,
                                    ExecutionContext executionContext)
                                      throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDelOnAddress

public ContributorResult executeDelOnAddress(XDIAddress[] contributorAddresses,
                                    XDIAddress contributorsAddress,
                                    XDIAddress relativeTargetAddress,
                                    DelOperation operation,
                                    MessageResult messageResult,
                                    ExecutionContext executionContext)
                                      throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDoOnAddress

public ContributorResult executeDoOnAddress(XDIAddress[] contributorAddresses,
                                   XDIAddress contributorsAddress,
                                   XDIAddress relativeTargetAddress,
                                   DoOperation operation,
                                   MessageResult messageResult,
                                   ExecutionContext executionContext)
                                     throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeOnStatement

public ContributorResult executeOnStatement(XDIAddress[] contributorAddresses,
                                   XDIAddress contributorsAddress,
                                   XDIStatement relativeTargetStatement,
                                   Operation operation,
                                   MessageResult messageResult,
                                   ExecutionContext executionContext)
                                     throws Xdi2MessagingException

Description copied from interface: Contributor

Executes an XDI operation on a statement.

Specified by:: executeOnStatement in interface Contributor
Parameters:: contributorAddresses - The individual XRIs in the contributor chain.; contributorsAddress - The complete XRI of the contributor chain.; relativeTargetStatement - The relative target statement.; operation - The operation that is being executed.; messageResult - 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

executeGetOnStatement

public ContributorResult executeGetOnStatement(XDIAddress[] contributorAddresses,
                                      XDIAddress contributorsAddress,
                                      XDIStatement relativeTargetStatement,
                                      GetOperation operation,
                                      MessageResult messageResult,
                                      ExecutionContext executionContext)
                                        throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeSetOnStatement

public ContributorResult executeSetOnStatement(XDIAddress[] contributorAddresses,
                                      XDIAddress contributorsAddress,
                                      XDIStatement relativeTargetStatement,
                                      SetOperation operation,
                                      MessageResult messageResult,
                                      ExecutionContext executionContext)
                                        throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDelOnStatement

public ContributorResult executeDelOnStatement(XDIAddress[] contributorAddresses,
                                      XDIAddress contributorsAddress,
                                      XDIStatement relativeTargetStatement,
                                      DelOperation operation,
                                      MessageResult messageResult,
                                      ExecutionContext executionContext)
                                        throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDoOnStatement

public ContributorResult executeDoOnStatement(XDIAddress[] contributorAddresses,
                                     XDIAddress contributorsAddress,
                                     XDIStatement relativeTargetStatement,
                                     DoOperation operation,
                                     MessageResult messageResult,
                                     ExecutionContext executionContext)
                                       throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeGetOnContextNodeStatement

public ContributorResult executeGetOnContextNodeStatement(XDIAddress[] contributorAddresses,
                                                 XDIAddress contributorsAddress,
                                                 XDIStatement relativeTargetStatement,
                                                 GetOperation operation,
                                                 MessageResult messageResult,
                                                 ExecutionContext executionContext)
                                                   throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeSetOnContextNodeStatement

public ContributorResult executeSetOnContextNodeStatement(XDIAddress[] contributorAddresses,
                                                 XDIAddress contributorsAddress,
                                                 XDIStatement relativeTargetStatement,
                                                 SetOperation operation,
                                                 MessageResult messageResult,
                                                 ExecutionContext executionContext)
                                                   throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDelOnContextNodeStatement

public ContributorResult executeDelOnContextNodeStatement(XDIAddress[] contributorAddresses,
                                                 XDIAddress contributorsAddress,
                                                 XDIStatement relativeTargetStatement,
                                                 DelOperation operation,
                                                 MessageResult messageResult,
                                                 ExecutionContext executionContext)
                                                   throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDoOnContextNodeStatement

public ContributorResult executeDoOnContextNodeStatement(XDIAddress[] contributorAddresses,
                                                XDIAddress contributorsAddress,
                                                XDIStatement relativeTargetStatement,
                                                DoOperation operation,
                                                MessageResult messageResult,
                                                ExecutionContext executionContext)
                                                  throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeGetOnRelationStatement

public ContributorResult executeGetOnRelationStatement(XDIAddress[] contributorAddresses,
                                              XDIAddress contributorsAddress,
                                              XDIStatement relativeTargetStatement,
                                              GetOperation operation,
                                              MessageResult messageResult,
                                              ExecutionContext executionContext)
                                                throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeSetOnRelationStatement

public ContributorResult executeSetOnRelationStatement(XDIAddress[] contributorAddresses,
                                              XDIAddress contributorsAddress,
                                              XDIStatement relativeTargetStatement,
                                              SetOperation operation,
                                              MessageResult messageResult,
                                              ExecutionContext executionContext)
                                                throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDelOnRelationStatement

public ContributorResult executeDelOnRelationStatement(XDIAddress[] contributorAddresses,
                                              XDIAddress contributorsAddress,
                                              XDIStatement relativeTargetStatement,
                                              DelOperation operation,
                                              MessageResult messageResult,
                                              ExecutionContext executionContext)
                                                throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDoOnRelationStatement

public ContributorResult executeDoOnRelationStatement(XDIAddress[] contributorAddresses,
                                             XDIAddress contributorsAddress,
                                             XDIStatement relativeTargetStatement,
                                             DoOperation operation,
                                             MessageResult messageResult,
                                             ExecutionContext executionContext)
                                               throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeGetOnLiteralStatement

public ContributorResult executeGetOnLiteralStatement(XDIAddress[] contributorAddresses,
                                             XDIAddress contributorsAddress,
                                             XDIStatement relativeTargetStatement,
                                             GetOperation operation,
                                             MessageResult messageResult,
                                             ExecutionContext executionContext)
                                               throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeSetOnLiteralStatement

public ContributorResult executeSetOnLiteralStatement(XDIAddress[] contributorAddresses,
                                             XDIAddress contributorsAddress,
                                             XDIStatement relativeTargetStatement,
                                             SetOperation operation,
                                             MessageResult messageResult,
                                             ExecutionContext executionContext)
                                               throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDelOnLiteralStatement

public ContributorResult executeDelOnLiteralStatement(XDIAddress[] contributorAddresses,
                                             XDIAddress contributorsAddress,
                                             XDIStatement relativeTargetStatement,
                                             DelOperation operation,
                                             MessageResult messageResult,
                                             ExecutionContext executionContext)
                                               throws Xdi2MessagingException

Throws:: Xdi2MessagingException

executeDoOnLiteralStatement

public ContributorResult executeDoOnLiteralStatement(XDIAddress[] contributorAddresses,
                                            XDIAddress contributorsAddress,
                                            XDIStatement relativeTargetStatement,
                                            DoOperation operation,
                                            MessageResult messageResult,
                                            ExecutionContext executionContext)
                                              throws Xdi2MessagingException

Throws:: Xdi2MessagingException

getContributorMount
```
public ContributorMount getContributorMount()
```
Specified by:

getContributorMount in interface Contributor

getContributors
```
public ContributorMap getContributors()
```
Specified by:

getContributors in interface Contributor

setContributors
```
public void setContributors(ContributorMap contributors)
```
Specified by:

setContributors in interface Contributor

Class AbstractContributor

Nested Class Summary

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

Field Summary

Fields inherited from class xdi2.messaging.target.impl.AbstractExtension

Constructor Summary

Method Summary

Methods inherited from class xdi2.messaging.target.impl.AbstractExtension

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.messaging.target.Extension

Constructor Detail

AbstractContributor

AbstractContributor

Method Detail

executeOnAddress

executeGetOnAddress

executeSetOnAddress

executeDelOnAddress

executeDoOnAddress

executeOnStatement

executeGetOnStatement

executeSetOnStatement

executeDelOnStatement

executeDoOnStatement

executeGetOnContextNodeStatement

executeSetOnContextNodeStatement

executeDelOnContextNodeStatement

executeDoOnContextNodeStatement

executeGetOnRelationStatement

executeSetOnRelationStatement

executeDelOnRelationStatement

executeDoOnRelationStatement

executeGetOnLiteralStatement

executeSetOnLiteralStatement

executeDelOnLiteralStatement

executeDoOnLiteralStatement

getContributorMount

getContributors

setContributors