org.jivesoftware.smackx.pubsub.ConfigureNodeFields Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smack Show documentation
Smack is an Open Source XMPP (Jabber) client library for instant messaging and presence. This library provides the client side functionality as specified in the core XMPP specifications as related to the client side of said specifications.
The newest version!
/**
 * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jivesoftware.smackx.pubsub;

import java.net.URL;

import org.jivesoftware.smackx.Form;

/**
 * This enumeration represents all the fields of a node configuration form.  This enumeration
 * is not required when using the {@link ConfigureForm} to configure nodes, but may be helpful
 * for generic UI's using only a {@link Form} for configuration.
 * 
 * @author Robin Collier
 */
public enum ConfigureNodeFields
{
	/**
	 * Determines who may subscribe and retrieve items
	 * 
	 * Value: {@link AccessModel}
	 */
	access_model,

	/**
	 * The URL of an XSL transformation which can be applied to 
	 * payloads in order to generate an appropriate message
	 * body element
	 * 
	 * Value: {@link URL}
	 */
	body_xslt,
	
	/**
	 * The collection with which a node is affiliated
	 * 
	 * Value: String
	 */
	collection,

	/**
	 * 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: {@link URL}
	 */
	dataform_xslt,

	/**
	 * Whether to deliver payloads with event notifications
	 *
	 * Value: boolean
	 */
	deliver_payloads,
	
	/**
	 * Whether owners or publisher should receive replies to items
	 *
	 * Value: {@link ItemReply}
	 */
	itemreply,
	
	/**
	 * Who may associate leaf nodes with a collection
	 * 
	 * Value: {@link ChildrenAssociationPolicy}
	 */
	children_association_policy,
	
	/**
	 * The list of JIDs that may associate leaf nodes with a 
	 * collection
	 * 
	 * Value: List of JIDs as Strings
	 */
	children_association_whitelist,
	
	/**
	 * The child nodes (leaf or collection) associated with a collection
	 * 
	 * Value: List of Strings
	 */
	children,
	
	/**
	 * The maximum number of child nodes that can be associated with a 
	 * collection
	 * 
	 * Value: int
	 */
	children_max,
	
	/**
	 * The maximum number of items to persist
	 * 
	 * Value: int
	 */
	max_items,
	
	/**
	 * The maximum payload size in bytes
	 * 
	 * Value: int
	 */
	max_payload_size,
	
	/**
	 * Whether the node is a leaf (default) or collection
	 * 
	 * Value: {@link NodeType}
	 */
	node_type,
	
	/**
	 * Whether to notify subscribers when the node configuration changes
	 * 
	 * Value: boolean
	 */
	notify_config,
	
	/**
	 * Whether to notify subscribers when the node is deleted
	 * 
	 * Value: boolean
	 */
	notify_delete,

	/**
	 * Whether to notify subscribers when items are removed from the node
	 * 
	 * Value: boolean
	 */
	notify_retract,
	
	/**
	 * Whether to persist items to storage.  This is required to have multiple 
	 * items in the node. 
	 * 
	 * Value: boolean
	 */
	persist_items,
	
	/**
	 * Whether to deliver notifications to available users only
	 * 
	 * Value: boolean
	 */
	presence_based_delivery,

	/**
	 * Defines who can publish to the node
	 * 
	 * Value: {@link PublishModel}
	 */
	publish_model,
	
	/**
	 * The specific multi-user chat rooms to specify for replyroom
	 * 
	 * Value: List of JIDs as Strings
	 */
	replyroom,
	
	/**
	 * The specific JID(s) to specify for replyto
	 * 
	 * Value: List of JIDs as Strings
	 */
	replyto,
	
	/**
	 * The roster group(s) allowed to subscribe and retrieve items
	 * 
	 * Value: List of strings
	 */
	roster_groups_allowed,
	
	/**
	 * Whether to allow subscriptions
	 * 
	 * Value: boolean
	 */
	subscribe,
	
	/**
	 * A friendly name for the node
	 * 
	 * Value: String
	 */
	title,
	
	/**
	 * The type of node data, ussually specified by the namespace 
	 * of the payload(if any);MAY be a list-single rather than a 
	 * text single
	 * 
	 * Value: String
	 */
	type;
	
	public String getFieldName()
	{
		return "pubsub#" + toString();
	}
}