RegistryGraphMessagingTargetFactory (xdi2-transport-http 0.7.2 API)

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

All Implemented Interfaces:

MessagingTargetFactory
```
public class RegistryGraphMessagingTargetFactory
extends PrototypingMessagingTargetFactory
```
This messaging target factory uses a "registry graph" as a basis to decide what messaging targets to create.

Author:

markus

Field Summary

Fields
Modifier and Type Field and Description

static xdi2.core.syntax.XDIAddress XDI_ADD_ENABLED

Fields
Modifier and Type	Field and Description
`static xdi2.core.syntax.XDIAddress`	`XDI_ADD_ENABLED`

Constructor Summary

Constructors
Constructor and Description
`RegistryGraphMessagingTargetFactory()`
`RegistryGraphMessagingTargetFactory(xdi2.core.Graph registryGraph, boolean defaultDisabled, String disabledError, String expiredError)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDisabledError()`
`String`	`getExpiredError()`
`Iterator<xdi2.core.syntax.XDIArc>`	`getOwnerPeerRootXDIArcs()` Returns a list of all owner peer root XRIs of the MessagingTargets this MessagingTargetFactory can create.
`xdi2.core.Graph`	`getRegistryGraph()`
`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.
`boolean`	`isDefaultDisabled()`
`xdi2.messaging.target.MessagingTarget`	`mountMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, boolean checkDisabled, boolean checkExpired)`
`void`	`setDefaultDisabled(boolean defaultDisabled)`
`void`	`setDisabledError(String disabledError)`
`void`	`setExpiredError(String expiredError)`
`void`	`setRegistryGraph(xdi2.core.Graph registryGraph)`
`xdi2.messaging.target.MessagingTarget`	`updateMessagingTarget(HttpMessagingTargetRegistry httpMessagingTargetRegistry, String messagingTargetFactoryPath, String requestPath, boolean checkDisabled, boolean checkExpired, xdi2.messaging.target.MessagingTarget messagingTarget)`

Methods inherited from class xdi2.transport.impl.http.factory.impl.PrototypingMessagingTargetFactory
getPrototypeMessagingTarget, mountMessagingTarget, setPrototypeMessagingTarget

Methods inherited from class xdi2.transport.impl.http.factory.AbstractMessagingTargetFactory
init, mountMessagingTarget, shutdown, updateMessagingTarget

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

Field Detail

XDI_ADD_ENABLED

public static final xdi2.core.syntax.XDIAddress XDI_ADD_ENABLED

Constructor Detail

RegistryGraphMessagingTargetFactory

public RegistryGraphMessagingTargetFactory(xdi2.core.Graph registryGraph,
                                   boolean defaultDisabled,
                                   String disabledError,
                                   String expiredError)

RegistryGraphMessagingTargetFactory

public RegistryGraphMessagingTargetFactory()

Method Detail

mountMessagingTarget

public 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

public 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
```
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

Overrides:

getOwnerPeerRootXDIArcs in class AbstractMessagingTargetFactory

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

Overrides:

getRequestPath in class AbstractMessagingTargetFactory

getRegistryGraph

public xdi2.core.Graph getRegistryGraph()

setRegistryGraph

public void setRegistryGraph(xdi2.core.Graph registryGraph)

isDefaultDisabled
```
public boolean isDefaultDisabled()
```

setDefaultDisabled

public void setDefaultDisabled(boolean defaultDisabled)

getDisabledError
```
public String getDisabledError()
```

setDisabledError

public void setDisabledError(String disabledError)

getExpiredError
```
public String getExpiredError()
```

setExpiredError

public void setExpiredError(String expiredError)

Class RegistryGraphMessagingTargetFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xdi2.transport.impl.http.factory.impl.PrototypingMessagingTargetFactory

Methods inherited from class xdi2.transport.impl.http.factory.AbstractMessagingTargetFactory

Methods inherited from class java.lang.Object

Field Detail

XDI_ADD_ENABLED

Constructor Detail

RegistryGraphMessagingTargetFactory

RegistryGraphMessagingTargetFactory

Method Detail

mountMessagingTarget

updateMessagingTarget

getOwnerPeerRootXDIArcs

getRequestPath

getRegistryGraph

setRegistryGraph

isDefaultDisabled

setDefaultDisabled

getDisabledError

setDisabledError

getExpiredError

setExpiredError