AbstractMessagingTargetFactory (xdi2-transport-http 0.7.2 API)

java.lang.Object
- xdi2.transport.impl.http.factory.AbstractMessagingTargetFactory

All Implemented Interfaces:: MessagingTargetFactory

Direct Known Subclasses:: PrototypingMessagingTargetFactory

public abstract class AbstractMessagingTargetFactory
extends Object
implements MessagingTargetFactory

Constructor Summary

Constructors
Constructor and Description

AbstractMessagingTargetFactory()

Constructors
Constructor and Description
`AbstractMessagingTargetFactory()`

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.
`void`	`shutdown()` This method gets called when the MessagingTargetFactory is no longer needed.
`xdi2.messaging.target.MessagingTarget`	`updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, xdi2.messaging.target.MessagingTarget messagingTarget)` Updates a MessagingTarget.

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

Methods inherited from interface xdi2.transport.impl.http.factory.MessagingTargetFactory
mountMessagingTarget, updateMessagingTarget

Constructor Detail
- AbstractMessagingTargetFactory
```
public AbstractMessagingTargetFactory()
```

Method Detail

init
```
public void init()
          throws Exception
```
Description copied from interface: MessagingTargetFactory

This method gets called when the MessagingTargetFactory is initialized.

Specified by:

init in interface MessagingTargetFactory

Throws:

Exception

shutdown
```
public void shutdown()
              throws Exception
```
Description copied from interface: MessagingTargetFactory

This method gets called when the MessagingTargetFactory is no longer needed.

Specified by:

shutdown in interface MessagingTargetFactory

Throws:

Exception

mountMessagingTarget

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

Description copied from interface: MessagingTargetFactory

Mount a new MessagingTarget.

Specified by:: mountMessagingTarget in interface MessagingTargetFactory
Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

updateMessagingTarget

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

Description copied from interface: MessagingTargetFactory

Updates a MessagingTarget.

Specified by:: updateMessagingTarget in interface MessagingTargetFactory
Throws:: Xdi2TransportException; xdi2.messaging.exceptions.Xdi2MessagingException

getOwnerPeerRootXDIArcs
```
public Iterator<xdi2.core.syntax.XDIArc> getOwnerPeerRootXDIArcs()
```
Description copied from interface: MessagingTargetFactory

Returns a list of all owner peer root XRIs of the MessagingTargets this MessagingTargetFactory can create. Not all MessagingTargetFactorys may support this.

Specified by:

getOwnerPeerRootXDIArcs in interface MessagingTargetFactory

getRequestPath
```
public String getRequestPath(String messagingTargetFactoryPath,
                    xdi2.core.syntax.XDIArc ownerPeerRootXDIArc)
```
Description copied from interface: MessagingTargetFactory

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.

Specified by:

getRequestPath in interface MessagingTargetFactory

Class AbstractMessagingTargetFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.transport.impl.http.factory.MessagingTargetFactory

Constructor Detail

AbstractMessagingTargetFactory

Method Detail

init

shutdown

mountMessagingTarget

updateMessagingTarget

getOwnerPeerRootXDIArcs

getRequestPath