MessagingTargetFactory (xdi2-transport-http 0.7.2 API)

All Known Implementing Classes:

AbstractMessagingTargetFactory, AnyGraphMessagingTargetFactory, PrototypingMessagingTargetFactory, RegistryGraphMessagingTargetFactory
```
public interface MessagingTargetFactory
```
A MessagingTargetFactory can dynamically create MessagingTargets to process incoming XDI messages..

Author:

Markus

Method Summary

Methods
Modifier and Type	Method and Description
`Iterator<xdi2.core.syntax.XDIArc>`	`getOwnerPeerRootXDIArcs()` Returns a list of all owner peer root XRIs of the MessagingTargets this MessagingTargetFactory can create.
`String`	`getRequestPath(String messagingTargetFactoryPath, xdi2.core.syntax.XDIArc ownerPeerRootXDIArc)` Returns the request path at which this MessagingTargetFactory is able to mount a MessagingTarget with a given owner peer root XRI.
`void`	`init()` This method gets called when the MessagingTargetFactory is initialized.
`xdi2.messaging.target.MessagingTarget`	`mountMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath)` Mount a new MessagingTarget.
`xdi2.messaging.target.MessagingTarget`	`mountMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, boolean checkDisabled, boolean checkExpired)`
`void`	`shutdown()` This method gets called when the MessagingTargetFactory is no longer needed.
`xdi2.messaging.target.MessagingTarget`	`updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, boolean checkDisabled, boolean checkExpired, xdi2.messaging.target.MessagingTarget messagingTarget)`
`xdi2.messaging.target.MessagingTarget`	`updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, xdi2.messaging.target.MessagingTarget messagingTarget)` Updates a MessagingTarget.

Method Detail

init
```
void init()
          throws Exception
```
This method gets called when the MessagingTargetFactory is initialized.

Throws:

Exception

shutdown
```
void shutdown()
              throws Exception
```
This method gets called when the MessagingTargetFactory is no longer needed.

Throws:

Exception

mountMessagingTarget

xdi2.messaging.target.MessagingTarget mountMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry,
                                                         String messagingTargetFactoryPath,
                                                         String requestPath)
                                                           throws Xdi2TransportException,
                                                                  xdi2.messaging.exceptions.Xdi2MessagingException

Mount a new MessagingTarget.

Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

mountMessagingTarget

xdi2.messaging.target.MessagingTarget mountMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry,
                                                         String messagingTargetFactoryPath,
                                                         String requestPath,
                                                         boolean checkDisabled,
                                                         boolean checkExpired)
                                                           throws Xdi2TransportException,
                                                                  xdi2.messaging.exceptions.Xdi2MessagingException

Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

updateMessagingTarget

xdi2.messaging.target.MessagingTarget updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry,
                                                          String messagingTargetFactoryPath,
                                                          String requestPath,
                                                          xdi2.messaging.target.MessagingTarget messagingTarget)
                                                            throws Xdi2TransportException,
                                                                   xdi2.messaging.exceptions.Xdi2MessagingException

Updates a MessagingTarget.

Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

updateMessagingTarget

xdi2.messaging.target.MessagingTarget updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry,
                                                          String messagingTargetFactoryPath,
                                                          String requestPath,
                                                          boolean checkDisabled,
                                                          boolean checkExpired,
                                                          xdi2.messaging.target.MessagingTarget messagingTarget)
                                                            throws Xdi2TransportException,
                                                                   xdi2.messaging.exceptions.Xdi2MessagingException

Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

getOwnerPeerRootXDIArcs
```
Iterator<xdi2.core.syntax.XDIArc> getOwnerPeerRootXDIArcs()
```
Returns a list of all owner peer root XRIs of the MessagingTargets this MessagingTargetFactory can create. Not all MessagingTargetFactorys may support this.

getRequestPath
```
String getRequestPath(String messagingTargetFactoryPath,
                    xdi2.core.syntax.XDIArc ownerPeerRootXDIArc)
```
Returns the request path at which this MessagingTargetFactory is able to mount a MessagingTarget with a given owner peer root XRI. Not all MessagingTargetFactorys may support this.

Interface MessagingTargetFactory

Method Summary

Method Detail

init

shutdown

mountMessagingTarget

mountMessagingTarget

updateMessagingTarget

updateMessagingTarget

getOwnerPeerRootXDIArcs

getRequestPath