NodeConfiguration.Builder (Babbler 0.7.0)

java.lang.Object
- rocks.xmpp.extensions.data.model.DataForm.Builder<NodeConfiguration.Builder>
- - rocks.xmpp.extensions.pubsub.model.NodeConfiguration.Builder

Enclosing class:: NodeConfiguration

public static final class NodeConfiguration.Builder
extends DataForm.Builder<NodeConfiguration.Builder>

A builder to build node configurations.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeConfiguration.Builder`	`accessModel(AccessModel accessModel)` Who may subscribe and retrieve items.
`NodeConfiguration.Builder`	`allowSubscriptions(boolean allowSubscriptions)` Whether to allow subscriptions.
`NodeConfiguration.Builder`	`bodyXslt(URL bodyXslt)` The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
`NodeConfiguration`	`build()` Builds the node configuration.
`NodeConfiguration.Builder`	`children(Collection<String> children)` The child nodes (leaf or collection) associated with a collection.
`NodeConfiguration.Builder`	`childrenAssociationPolicy(ChildrenAssociationPolicy childrenAssociationPolicy)` Who may associate leaf nodes with a collection.
`NodeConfiguration.Builder`	`childrenAssociationWhitelist(Collection<Jid> childrenAssociationWhitelist)` The list of JIDs that may associate leaf nodes with a collection.
`NodeConfiguration.Builder`	`childrenMax(int childrenMax)` The maximum number of child nodes that can be associated with a collection.
`NodeConfiguration.Builder`	`collection(Collection<String> collection)` The collection(s) with which a node is affiliated.
`NodeConfiguration.Builder`	`contacts(Collection<Jid> contacts)` The JIDs of those to contact with questions
`NodeConfiguration.Builder`	`dataformXslt(URL dataformXslt)` 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
`NodeConfiguration.Builder`	`deliverNotifications(boolean deliverNotifications)` Whether to deliver event notifications.
`NodeConfiguration.Builder`	`deliverPayloads(boolean deliverPayloads)` Whether to deliver payloads with event notifications; applies only to leaf nodes.
`NodeConfiguration.Builder`	`description(String description)` A description of the node.
`NodeConfiguration.Builder`	`itemExpire(int itemExpire)` Number of seconds after which to automatically purge items.
`NodeConfiguration.Builder`	`itemReply(ItemReply itemReply)` Whether owners or publisher should receive replies to items.
`NodeConfiguration.Builder`	`language(Locale language)` The default language of the node.
`NodeConfiguration.Builder`	`maxItems(int maxItems)` The maximum number of items to persist.
`NodeConfiguration.Builder`	`maxPayloadSize(int maxPayloadSize)` The maximum payload size in bytes.
`NodeConfiguration.Builder`	`nodeTitle(String title)` A friendly name for the node.
`NodeConfiguration.Builder`	`nodeType(NodeType nodeType)` Whether the node is a leaf (default) or a collection.
`NodeConfiguration.Builder`	`notificationType(Message.Type notificationType)` Specify the delivery style for notifications.
`NodeConfiguration.Builder`	`notifyConfig(boolean notifyConfig)` Whether to notify subscribers when the node configuration changes.
`NodeConfiguration.Builder`	`notifyDelete(boolean notifyDelete)` Whether to notify subscribers when the node is deleted.
`NodeConfiguration.Builder`	`notifyRetract(boolean notifyRetract)` Whether to notify subscribers when items are removed from the node.
`NodeConfiguration.Builder`	`notifySub(boolean notifySub)` Whether to notify owners about new subscribers and unsubscribes.
`NodeConfiguration.Builder`	`persistItems(boolean persistItems)` Whether to persist items to storage.
`NodeConfiguration.Builder`	`presenceBasedDelivery(boolean presenceBasedDelivery)` Whether to deliver notifications to available users only.
`NodeConfiguration.Builder`	`publisherModel(PublisherModel publisherModel)` The publisher model.
`NodeConfiguration.Builder`	`purgeOffline(boolean purgeOffline)` Whether to purge all items when the relevant publisher goes offline.
`NodeConfiguration.Builder`	`rosterGroupsAllowed(Collection<String> rosterGroupsAllowed)` The roster group(s) allowed to subscribe and retrieve items.
`NodeConfiguration.Builder`	`sendLastPublishedItem(SendLastPublishedItem sendLastPublishedItem)` When to send the last published item.
`NodeConfiguration.Builder`	`temporarySubscriptions(boolean temporarySubscriptions)` Whether to make all subscriptions temporary, based on subscriber presence.
`NodeConfiguration.Builder`	`type(String type)` The type of node data, usually specified by the namespace of the payload (if any).

Methods inherited from class rocks.xmpp.extensions.data.model.DataForm.Builder
fields, formType, instructions, items, pages, reportedFields, title, type

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

- Method Detail
  - accessModel
```
public final NodeConfiguration.Builder accessModel(AccessModel accessModel)
```
    Who may subscribe and retrieve items.
    
    Parameters:
    
    accessModel - Who may subscribe and retrieve items.
    
    Returns:
    
    The builder.
  - bodyXslt
```
public final NodeConfiguration.Builder bodyXslt(URL bodyXslt)
```
    The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
    
    Parameters:
    
    bodyXslt - The URL.
    
    Returns:
    
    The builder.
  - childrenAssociationPolicy
```
public final NodeConfiguration.Builder childrenAssociationPolicy(ChildrenAssociationPolicy childrenAssociationPolicy)
```
    Who may associate leaf nodes with a collection.
    
    Parameters:
    
    childrenAssociationPolicy - Who may associate leaf nodes with a collection.
    
    Returns:
    
    The builder.
  - childrenAssociationWhitelist
```
public final NodeConfiguration.Builder childrenAssociationWhitelist(Collection<Jid> childrenAssociationWhitelist)
```
    The list of JIDs that may associate leaf nodes with a collection.
    
    Parameters:
    
    childrenAssociationWhitelist - The list of JIDs that may associate leaf nodes with a collection.
    
    Returns:
    
    The builder.
  - children
```
public final NodeConfiguration.Builder children(Collection<String> children)
```
    The child nodes (leaf or collection) associated with a collection.
    
    Parameters:
    
    children - The child nodes (leaf or collection) associated with a collection.
    
    Returns:
    
    The builder.
  - childrenMax
```
public final NodeConfiguration.Builder childrenMax(int childrenMax)
```
    The maximum number of child nodes that can be associated with a collection.
    
    Parameters:
    
    childrenMax - The maximum number of child nodes that can be associated with a collection.
    
    Returns:
    
    The builder.
  - collection
```
public final NodeConfiguration.Builder collection(Collection<String> collection)
```
    The collection(s) with which a node is affiliated.
    
    Parameters:
    
    collection - The collection(s) with which a node is affiliated.
    
    Returns:
    
    The builder.
  - contacts
```
public final NodeConfiguration.Builder contacts(Collection<Jid> contacts)
```
    The JIDs of those to contact with questions
    
    Parameters:
    
    contacts - The JIDs of those to contact with questions.
    
    Returns:
    
    The builder.
  - dataformXslt
```
public final NodeConfiguration.Builder dataformXslt(URL dataformXslt)
```
    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
    
    Parameters:
    
    dataformXslt - The URL.
    
    Returns:
    
    The builder.
  - deliverNotifications
```
public final NodeConfiguration.Builder deliverNotifications(boolean deliverNotifications)
```
    Whether to deliver event notifications.
    
    Parameters:
    
    deliverNotifications - Whether to deliver event notifications.
    
    Returns:
    
    The builder.
  - deliverPayloads
```
public final NodeConfiguration.Builder deliverPayloads(boolean deliverPayloads)
```
    Whether to deliver payloads with event notifications; applies only to leaf nodes.
    
    Parameters:
    
    deliverPayloads - Whether to deliver payloads with event notifications; applies only to leaf nodes.
    
    Returns:
    
    The builder.
  - description
```
public final NodeConfiguration.Builder description(String description)
```
    A description of the node.
    
    Parameters:
    
    description - A description of the node.
    
    Returns:
    
    The builder.
  - itemExpire
```
public final NodeConfiguration.Builder itemExpire(int itemExpire)
```
    Number of seconds after which to automatically purge items.
    
    Parameters:
    
    itemExpire - Number of seconds after which to automatically purge items.
    
    Returns:
    
    The builder.
  - itemReply
```
public final NodeConfiguration.Builder itemReply(ItemReply itemReply)
```
    Whether owners or publisher should receive replies to items.
    
    Parameters:
    
    itemReply - Whether owners or publisher should receive replies to items.
    
    Returns:
    
    The builder.
  - language
```
public final NodeConfiguration.Builder language(Locale language)
```
    The default language of the node.
    
    Parameters:
    
    language - The default language of the node.
    
    Returns:
    
    The builder.
  - maxItems
```
public final NodeConfiguration.Builder maxItems(int maxItems)
```
    The maximum number of items to persist.
    
    Parameters:
    
    maxItems - The maximum number of items to persist.
    
    Returns:
    
    The builder.
  - maxPayloadSize
```
public final NodeConfiguration.Builder maxPayloadSize(int maxPayloadSize)
```
    The maximum payload size in bytes.
    
    Parameters:
    
    maxPayloadSize - The maximum payload size in bytes.
    
    Returns:
    
    The builder.
  - nodeType
```
public final NodeConfiguration.Builder nodeType(NodeType nodeType)
```
    Whether the node is a leaf (default) or a collection.
    
    Parameters:
    
    nodeType - Whether the node is a leaf (default) or a collection.
    
    Returns:
    
    The builder.
  - notificationType
```
public final NodeConfiguration.Builder notificationType(Message.Type notificationType)
```
    Specify the delivery style for notifications.
    
    Parameters:
    
    notificationType - The notification type.
    
    Returns:
    
    The builder.
  - notifyConfig
```
public final NodeConfiguration.Builder notifyConfig(boolean notifyConfig)
```
    Whether to notify subscribers when the node configuration changes.
    
    Parameters:
    
    notifyConfig - Whether to notify subscribers when the node configuration changes.
    
    Returns:
    
    The builder.
  - notifyDelete
```
public final NodeConfiguration.Builder notifyDelete(boolean notifyDelete)
```
    Whether to notify subscribers when the node is deleted.
    
    Parameters:
    
    notifyDelete - Whether to notify subscribers when the node is deleted.
    
    Returns:
    
    The builder.
  - notifyRetract
```
public final NodeConfiguration.Builder notifyRetract(boolean notifyRetract)
```
    Whether to notify subscribers when items are removed from the node.
    
    Parameters:
    
    notifyRetract - Whether to notify subscribers when items are removed from the node.
    
    Returns:
    
    The builder.
  - notifySub
```
public final NodeConfiguration.Builder notifySub(boolean notifySub)
```
    Whether to notify owners about new subscribers and unsubscribes.
    
    Parameters:
    
    notifySub - Whether to notify owners about new subscribers and unsubscribes.
    
    Returns:
    
    The builder.
  - persistItems
```
public final NodeConfiguration.Builder persistItems(boolean persistItems)
```
    Whether to persist items to storage.
    
    Parameters:
    
    persistItems - Whether to persist items to storage.
    
    Returns:
    
    The builder.
  - presenceBasedDelivery
```
public final NodeConfiguration.Builder presenceBasedDelivery(boolean presenceBasedDelivery)
```
    Whether to deliver notifications to available users only.
    
    Parameters:
    
    presenceBasedDelivery - Whether to deliver notifications to available users only.
    
    Returns:
    
    The builder.
  - publisherModel
```
public final NodeConfiguration.Builder publisherModel(PublisherModel publisherModel)
```
    The publisher model.
    
    Parameters:
    
    publisherModel - The publisher model.
    
    Returns:
    
    The builder.
  - purgeOffline
```
public final NodeConfiguration.Builder purgeOffline(boolean purgeOffline)
```
    Whether to purge all items when the relevant publisher goes offline.
    
    Parameters:
    
    purgeOffline - Whether to purge all items when the relevant publisher goes offline.
    
    Returns:
    
    The builder.
  - rosterGroupsAllowed
```
public final NodeConfiguration.Builder rosterGroupsAllowed(Collection<String> rosterGroupsAllowed)
```
    The roster group(s) allowed to subscribe and retrieve items.
    
    Parameters:
    
    rosterGroupsAllowed - The roster group(s) allowed to subscribe and retrieve items.
    
    Returns:
    
    The builder.
  - sendLastPublishedItem
```
public final NodeConfiguration.Builder sendLastPublishedItem(SendLastPublishedItem sendLastPublishedItem)
```
    When to send the last published item.
    
    Parameters:
    
    sendLastPublishedItem - When to send the last published item.
    
    Returns:
    
    The builder.
  - temporarySubscriptions
```
public final NodeConfiguration.Builder temporarySubscriptions(boolean temporarySubscriptions)
```
    Whether to make all subscriptions temporary, based on subscriber presence.
    
    Parameters:
    
    temporarySubscriptions - Whether to make all subscriptions temporary, based on subscriber presence.
    
    Returns:
    
    The builder.
    
    See Also:
    
    12.4 Temporary Subscriptions
  - allowSubscriptions
```
public final NodeConfiguration.Builder allowSubscriptions(boolean allowSubscriptions)
```
    Whether to allow subscriptions.
    
    Parameters:
    
    allowSubscriptions - Whether to allow subscriptions.
    
    Returns:
    
    The builder.
  - nodeTitle
```
public final NodeConfiguration.Builder nodeTitle(String title)
```
    A friendly name for the node.
    
    Parameters:
    
    title - The title.
    
    Returns:
    
    The name.
  - type
```
public final NodeConfiguration.Builder type(String type)
```
    The type of node data, usually specified by the namespace of the payload (if any).
    
    Parameters:
    
    type - The type.
    
    Returns:
    
    The builder.
  - build
```
public final NodeConfiguration build()
```
    Builds the node configuration.
    
    Returns:
    
    The data form.

Class NodeConfiguration.Builder

Method Summary

Methods inherited from class rocks.xmpp.extensions.data.model.DataForm.Builder

Methods inherited from class java.lang.Object

Method Detail

accessModel

bodyXslt

childrenAssociationPolicy

childrenAssociationWhitelist

children

childrenMax

collection

contacts

dataformXslt

deliverNotifications

deliverPayloads

description

itemExpire

itemReply

language

maxItems

maxPayloadSize

nodeType

notificationType

notifyConfig

notifyDelete

notifyRetract

notifySub

persistItems

presenceBasedDelivery

publisherModel

purgeOffline

rosterGroupsAllowed

sendLastPublishedItem

temporarySubscriptions

allowSubscriptions

nodeTitle

type

build