Package rocks.xmpp.extensions.pubsub.model

Enum AccessModel

java.lang.Object

java.lang.Enum<AccessModel>

rocks.xmpp.extensions.pubsub.model.AccessModel

All Implemented Interfaces:

Serializable, Comparable<AccessModel>

public enum AccessModel
extends Enum<AccessModel>

Defines who may subscribe to a node.

See Also:

NodeConfiguration.getAccessModel(), 4.5 Node Access Models

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHORIZE	The node owner must approve all subscription requests, and only subscribers may retrieve items from the node.
OPEN	Any entity may subscribe to the node (i.e., without the necessity for subscription approval) and any entity may retrieve items from the node (i.e., without being subscribed); this SHOULD be the default access model for generic pubsub services.
PRESENCE	Any entity in the specified roster group(s) may subscribe to the node and retrieve items from the node; this access model applies mainly to instant messaging systems.
ROSTER	Any entity in the specified roster group(s) may subscribe to the node and retrieve items from the node; this access model applies mainly to instant messaging systems.
WHITELIST	An entity may subscribe or retrieve items only if on a whitelist managed by the node owner.

Method Summary

Modifier and Type	Method	Description
static AccessModel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AccessModel[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHORIZE

public static final AccessModel AUTHORIZE

The node owner must approve all subscription requests, and only subscribers may retrieve items from the node.

OPEN

public static final AccessModel OPEN

Any entity may subscribe to the node (i.e., without the necessity for subscription approval) and any entity may retrieve items from the node (i.e., without being subscribed); this SHOULD be the default access model for generic pubsub services.

PRESENCE

public static final AccessModel PRESENCE

Any entity in the specified roster group(s) may subscribe to the node and retrieve items from the node; this access model applies mainly to instant messaging systems.

ROSTER

public static final AccessModel ROSTER

Any entity in the specified roster group(s) may subscribe to the node and retrieve items from the node; this access model applies mainly to instant messaging systems.

WHITELIST

public static final AccessModel WHITELIST

An entity may subscribe or retrieve items only if on a whitelist managed by the node owner. The node owner MUST automatically be on the whitelist. In order to add entities to the whitelist, the node owner SHOULD use the protocol specified in the Manage Affiliated Entities section of this document, specifically by setting the affiliation to "member".

Method Detail

values

public static AccessModel[] 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 (AccessModel c : AccessModel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AccessModel 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 name

NullPointerException - if the argument is null