Package org.jivesoftware.smackx.pubsub
Enum ConfigureNodeFields
- java.lang.Object
-
- java.lang.Enum<ConfigureNodeFields>
-
- org.jivesoftware.smackx.pubsub.ConfigureNodeFields
-
- All Implemented Interfaces:
Serializable
,Comparable<ConfigureNodeFields>
public enum ConfigureNodeFields extends Enum<ConfigureNodeFields>
This enumeration represents all the fields of a node configuration form. This enumeration is not required when using theConfigureForm
to configure nodes, but may be helpful for generic UI's using only aFilledForm
for configuration.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description access_model
Determines who may subscribe and retrieve items.body_xslt
The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.children
The child nodes (leaf or collection) associated with a collection.children_association_policy
Who may associate leaf nodes with a collection.children_association_whitelist
The list of JIDs that may associate leaf nodes with a collection.children_max
The maximum number of child nodes that can be associated with a collection.collection
The collection with which a node is affiliated.dataform_xslt
The URL of an XSL transformation which can be applied to payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine body element.deliver_payloads
Whether to deliver payloads with event notifications.itemreply
Whether owners or publisher should receive replies to items.max_items
The maximum number of items to persist.max_payload_size
The maximum payload size in bytes.node_type
Whether the node is a leaf (default) or collection.notification_type
The type of notification that the nodes sends.notify_config
Whether to notify subscribers when the node configuration changes.notify_delete
Whether to notify subscribers when the node is deleted.notify_retract
Whether to notify subscribers when items are removed from the node.persist_items
Whether to persist items to storage.presence_based_delivery
Whether to deliver notifications to available users only.publish_model
Defines who can publish to the node.roster_groups_allowed
The roster group(s) allowed to subscribe and retrieve items.subscribe
Whether to allow subscriptions.title
A friendly name for the node.type
The type of node data, usually specified by the namespace of the payload(if any);MAY be a list-single rather than a text single.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFieldName()
static ConfigureNodeFields
valueOf(String name)
Returns the enum constant of this type with the specified name.static ConfigureNodeFields[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
access_model
public static final ConfigureNodeFields access_model
Determines who may subscribe and retrieve items.Value:
AccessModel
-
body_xslt
public static final ConfigureNodeFields body_xslt
The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.Value:
URL
-
collection
public static final ConfigureNodeFields collection
The collection with which a node is affiliated.Value: String
-
dataform_xslt
public static final ConfigureNodeFields dataform_xslt
The URL of an XSL transformation which can be applied to payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine body element.Value:
URL
-
deliver_payloads
public static final ConfigureNodeFields deliver_payloads
Whether to deliver payloads with event notifications.Value: boolean
-
itemreply
public static final ConfigureNodeFields itemreply
Whether owners or publisher should receive replies to items.Value:
ItemReply
-
children_association_policy
public static final ConfigureNodeFields children_association_policy
Who may associate leaf nodes with a collection.Value:
ChildrenAssociationPolicy
-
children_association_whitelist
public static final ConfigureNodeFields children_association_whitelist
The list of JIDs that may associate leaf nodes with a collection.Value: List of JIDs as Strings
-
children
public static final ConfigureNodeFields children
The child nodes (leaf or collection) associated with a collection.Value: List of Strings
-
children_max
public static final ConfigureNodeFields children_max
The maximum number of child nodes that can be associated with a collection.Value: int
-
max_items
public static final ConfigureNodeFields max_items
The maximum number of items to persist.Value: int
-
max_payload_size
public static final ConfigureNodeFields max_payload_size
The maximum payload size in bytes.Value: int
-
node_type
public static final ConfigureNodeFields node_type
Whether the node is a leaf (default) or collection.Value:
NodeType
-
notify_config
public static final ConfigureNodeFields notify_config
Whether to notify subscribers when the node configuration changes.Value: boolean
-
notify_delete
public static final ConfigureNodeFields notify_delete
Whether to notify subscribers when the node is deleted.Value: boolean
-
notify_retract
public static final ConfigureNodeFields notify_retract
Whether to notify subscribers when items are removed from the node.Value: boolean
-
notification_type
public static final ConfigureNodeFields notification_type
The type of notification that the nodes sends.Value:
NotificationType
-
persist_items
public static final ConfigureNodeFields persist_items
Whether to persist items to storage. This is required to have. multiple items in the node.Value: boolean
-
presence_based_delivery
public static final ConfigureNodeFields presence_based_delivery
Whether to deliver notifications to available users only.Value: boolean
-
publish_model
public static final ConfigureNodeFields publish_model
Defines who can publish to the node.Value:
PublishModel
-
roster_groups_allowed
public static final ConfigureNodeFields roster_groups_allowed
The roster group(s) allowed to subscribe and retrieve items.Value: List of strings
-
subscribe
public static final ConfigureNodeFields subscribe
Whether to allow subscriptions.Value: boolean
-
title
public static final ConfigureNodeFields title
A friendly name for the node.Value: String
-
type
public static final ConfigureNodeFields type
The type of node data, usually specified by the namespace of the payload(if any);MAY be a list-single rather than a text single.Value: String
-
-
Method Detail
-
values
public static ConfigureNodeFields[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ConfigureNodeFields c : ConfigureNodeFields.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ConfigureNodeFields valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getFieldName
public String getFieldName()
-
-