NodeConfiguration (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.pubsub.model.NodeConfiguration

public final class NodeConfiguration
extends Object

Represents a standardized DataForm with form type http://jabber.org/protocol/pubsub#node_config, which can be used to configure a pubsub node.

Usage

To wrap an existing DataForm to retrieve standard data from it, use:

 NodeConfiguration nodeConfiguration = new NodeConfiguration(dataForm);

To build a form:

 NodeConfiguration nodeConfiguration = NodeConfiguration.builder()
     .accessModel(AccessModel.AUTHORIZE)
     .bodyXslt(new URL("http://xmpp.org"))
     .childrenAssociationPolicy(ChildrenAssociationPolicy.OWNERS)
     .childrenAssociationWhitelist(Arrays.asList(Jid.valueOf("domain")))
     .children(Arrays.asList("collection1"))
     .childrenMax(23)
     .collection(Arrays.asList("collections"))
     .contacts(Arrays.asList(Jid.valueOf("contact")))
     .dataformXslt(new URL("http://www.xmpp.org"))
     .deliverNotifications(true)
     .deliverPayloads(false)
     .description("description")
     .itemExpire(2)
     .itemReply(ItemReply.OWNER)
     .language("de")
     .maxItems(4)
     .maxPayloadSize(54)
     .nodeType(NodeType.LEAF)
     .notificationType(AbstractMessage.Type.NORMAL)
     .notifyConfig(true)
     .notifyDelete(true)
     .notifyRetract(true)
     .notifySub(true)
     .persistItems(true)
     .presenceBasedDelivery(true)
     .publisherModel(PublisherModel.OPEN)
     .purgeOffline(false)
     .rosterGroupsAllowed(Arrays.asList("group1", "group2"))
     .sendLastPublishedItem(SendLastPublishedItem.ON_SUB_AND_PRESENCE)
     .temporarySubscriptions(true)
     .allowSubscriptions(true)
     .title("Title")
     .type("Type")
     .build();

See Also:: 16.4.4 pubsub#node_config FORM_TYPE

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NodeConfiguration.Builder
A builder to build node configurations.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NodeConfiguration.Builder` A builder to build node configurations.

Constructor Summary

Constructors
Constructor and Description

NodeConfiguration(DataForm dataForm)

Constructors
Constructor and Description
`NodeConfiguration(DataForm dataForm)`

Method Summary

Methods
Modifier and Type	Method and Description
`static NodeConfiguration.Builder`	`builder()` Gets the builder to build a node configuration.
`AccessModel`	`getAccessModel()` Who may subscribe and retrieve items.
`URL`	`getBodyXslt()` The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
`List<String>`	`getChildren()` The child nodes (leaf or collection) associated with a collection.
`ChildrenAssociationPolicy`	`getChildrenAssociationPolicy()` Who may associate leaf nodes with a collection.
`List<Jid>`	`getChildrenAssociationWhitelist()` The list of JIDs that may associate leaf nodes with a collection.
`Integer`	`getChildrenMax()` The maximum number of child nodes that can be associated with a collection.
`List<String>`	`getCollection()` The collection(s) with which a node is affiliated.
`List<Jid>`	`getContacts()` The JIDs of those to contact with questions.
`DataForm`	`getDataForm()` Gets the underlying data form.
`URL`	`getDataformXslt()` The URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.
`String`	`getDescription()` A description of the node.
`Integer`	`getItemExpire()` Number of seconds after which to automatically purge items.
`ItemReply`	`getItemReply()` Whether owners or publisher should receive replies to items.
`String`	`getLanguage()` The default language of the node.
`Integer`	`getMaxItems()` The maximum number of items to persist.
`Integer`	`getMaxPayloadSize()` The maximum payload size in bytes
`String`	`getNodeTitle()` A friendly name for the node.
`NodeType`	`getNodeType()` Whether the node is a leaf (default) or a collection.
`AbstractMessage.Type`	`getNotificationType()` Specifies the delivery style for notifications.
`String`	`getPayloadType()` The type of node data, usually specified by the namespace of the payload (if any).
`PublisherModel`	`getPublisherModel()` The publisher model.
`List<String>`	`getRosterGroupsAllowed()` Gets the allowed roster groups.
`SendLastPublishedItem`	`getSendLastPublishedItem()` Gets the value which specifies when to send the last published item.
`Boolean`	`isAllowSubscriptions()` Whether to allow subscriptions.
`Boolean`	`isDeliverNotifications()` Whether to deliver event notifications.
`Boolean`	`isDeliverPayloads()` Whether to deliver payloads with event notifications; applies only to leaf nodes.
`Boolean`	`isNotifyConfig()` Whether to notify subscribers when the node configuration changes.
`Boolean`	`isNotifyDelete()` Whether to notify subscribers when the node is deleted.
`Boolean`	`isNotifyRetract()` Whether to notify subscribers when items are removed from the node.
`Boolean`	`isNotifySub()` Whether to notify owners about new subscribers and unsubscribes.
`Boolean`	`isPersistItems()` Whether to persist items to storage.
`Boolean`	`isPresenceBasedDelivery()` Whether to deliver notifications to available users only.
`Boolean`	`isPurgeOffline()` Whether to purge all items when the relevant publisher goes offline.
`Boolean`	`isTemporarySubscriptions()` Whether to make all subscriptions temporary, based on subscriber presence.

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

- Constructor Detail
  - NodeConfiguration
```
public NodeConfiguration(DataForm dataForm)
```
- Method Detail
  - builder
```
public static NodeConfiguration.Builder builder()
```
    Gets the builder to build a node configuration.
    
    Returns:
    The builder.
  - getDataForm
```
public DataForm getDataForm()
```
    Gets the underlying data form.
    
    Returns:
    The underlying data form.
  - getAccessModel
```
public AccessModel getAccessModel()
```
    Who may subscribe and retrieve items.
    
    Returns:
    The access model.
  - getBodyXslt
```
public URL getBodyXslt()
```
    The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
    
    Returns:
    The URL.
  - getChildrenAssociationPolicy
```
public ChildrenAssociationPolicy getChildrenAssociationPolicy()
```
    Who may associate leaf nodes with a collection.
    
    Returns:
    The children association policy.
  - getChildrenAssociationWhitelist
```
public List<Jid> getChildrenAssociationWhitelist()
```
    The list of JIDs that may associate leaf nodes with a collection.
    
    Returns:
    The whitelist.
  - getChildren
```
public List<String> getChildren()
```
    The child nodes (leaf or collection) associated with a collection.
    
    Returns:
    The child nodes.
  - getChildrenMax
```
public Integer getChildrenMax()
```
    The maximum number of child nodes that can be associated with a collection.
    
    Returns:
    The max child nodes.
  - getCollection
```
public List<String> getCollection()
```
    The collection(s) with which a node is affiliated.
    
    Returns:
    The collection(s).
  - getContacts
```
public List<Jid> getContacts()
```
    The JIDs of those to contact with questions.
    
    Returns:
    The contacts.
  - getDataformXslt
```
public URL getDataformXslt()
```
    The URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.
    
    Returns:
    The URL.
  - isDeliverNotifications
```
public Boolean isDeliverNotifications()
```
    Whether to deliver event notifications.
    
    Returns:
    True, if whether event notifications are delivered.
  - isDeliverPayloads
```
public Boolean isDeliverPayloads()
```
    Whether to deliver payloads with event notifications; applies only to leaf nodes.
    
    Returns:
    True, if payloads are delivered.
  - getDescription
```
public String getDescription()
```
    A description of the node.
    
    Returns:
    The description.
  - getItemExpire
```
public Integer getItemExpire()
```
    Number of seconds after which to automatically purge items.
    
    Returns:
    The seconds.
  - getItemReply
```
public ItemReply getItemReply()
```
    Whether owners or publisher should receive replies to items.
    
    Returns:
    The item reply.
  - getLanguage
```
public String getLanguage()
```
    The default language of the node.
    
    Returns:
    The language.
  - getMaxItems
```
public Integer getMaxItems()
```
    The maximum number of items to persist.
    
    Returns:
    The max items.
  - getMaxPayloadSize
```
public Integer getMaxPayloadSize()
```
    The maximum payload size in bytes
    
    Returns:
    The max payload size.
  - getNodeType
```
public NodeType getNodeType()
```
    Whether the node is a leaf (default) or a collection.
    
    Returns:
    The node type.
  - getNotificationType
```
public AbstractMessage.Type getNotificationType()
```
    Specifies the delivery style for notifications.
    
    Returns:
    The notification type.
  - isNotifyConfig
```
public Boolean isNotifyConfig()
```
    Whether to notify subscribers when the node configuration changes.
    
    Returns:
    True, if subscribers are notified when the node configuration changes.
  - isNotifyDelete
```
public Boolean isNotifyDelete()
```
    Whether to notify subscribers when the node is deleted.
    
    Returns:
    True, if subscribers are notified when the node is deleted.
  - isNotifyRetract
```
public Boolean isNotifyRetract()
```
    Whether to notify subscribers when items are removed from the node.
    
    Returns:
    True, if subscribers are notified when items are removed from the node.
  - isNotifySub
```
public Boolean isNotifySub()
```
    Whether to notify owners about new subscribers and unsubscribes.
    
    Returns:
    True, if owners are notified about new subscribers and unsubscribes.
  - isPersistItems
```
public Boolean isPersistItems()
```
    Whether to persist items to storage.
    
    Returns:
    True if items are persisted to storage.
  - isPresenceBasedDelivery
```
public Boolean isPresenceBasedDelivery()
```
    Whether to deliver notifications to available users only.
    
    Returns:
    True, if notifications are only delivered to available users.
  - getPublisherModel
```
public PublisherModel getPublisherModel()
```
    The publisher model.
    
    Returns:
    The publisher model.
  - isPurgeOffline
```
public Boolean isPurgeOffline()
```
    Whether to purge all items when the relevant publisher goes offline.
    
    Returns:
    True, if all items are purged, when the relevant publisher goes offline.
  - getRosterGroupsAllowed
```
public List<String> getRosterGroupsAllowed()
```
    Gets the allowed roster groups.
    
    Returns:
    The allowed roster groups.
  - getSendLastPublishedItem
```
public SendLastPublishedItem getSendLastPublishedItem()
```
    Gets the value which specifies when to send the last published item.
    
    Returns:
    When to send the last published item.
  - isTemporarySubscriptions
```
public Boolean isTemporarySubscriptions()
```
    Whether to make all subscriptions temporary, based on subscriber presence.
    
    Returns:
    True, if subscriptions are temporary.
  - isAllowSubscriptions
```
public Boolean isAllowSubscriptions()
```
    Whether to allow subscriptions.
    
    Returns:
    True, if subscriptions are allowed.
  - getNodeTitle
```
public String getNodeTitle()
```
    A friendly name for the node.
    
    Returns:
    The title.
  - getPayloadType
```
public String getPayloadType()
```
    The type of node data, usually specified by the namespace of the payload (if any).
    
    Returns:
    The payload type.

Class NodeConfiguration

Usage

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NodeConfiguration

Method Detail

builder

getDataForm

getAccessModel

getBodyXslt

getChildrenAssociationPolicy

getChildrenAssociationWhitelist

getChildren

getChildrenMax

getCollection

getContacts

getDataformXslt

isDeliverNotifications

isDeliverPayloads

getDescription

getItemExpire

getItemReply

getLanguage

getMaxItems

getMaxPayloadSize

getNodeType

getNotificationType

isNotifyConfig

isNotifyDelete

isNotifyRetract

isNotifySub

isPersistItems

isPresenceBasedDelivery

getPublisherModel

isPurgeOffline

getRosterGroupsAllowed

getSendLastPublishedItem

isTemporarySubscriptions

isAllowSubscriptions

getNodeTitle

getPayloadType