rocks.xmpp.extensions.privacy.model

Class PrivacyRule

java.lang.Object

rocks.xmpp.extensions.privacy.model.PrivacyRule

All Implemented Interfaces:

Comparable<PrivacyRule>

public final class PrivacyRule
extends Object
implements Comparable<PrivacyRule>

A privacy rule for privacy lists, which is applied by the server.

2.2 Business Rules

• The order in which privacy list items are processed by the server is important. List items MUST be processed in ascending order determined by the integer values of the 'order' attribute for each <item/>.
• As soon as a stanza is matched against a privacy list rule, the server MUST appropriately handle the stanza in accordance with the rule and cease processing.
• If no fall-through item is provided in a list, the fall-through action is assumed to be "allow".

Author:

Christian Schudt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrivacyRule.Action Defines the action to perform with the privacy item: either allow or deny communication.
static class	PrivacyRule.Type Defines the type of communication which should be allowed of denied.

Constructor Summary

Constructors

Constructor and Description
PrivacyRule(PrivacyRule.Action action, long order) Creates a privacy list item, which allows or blocks everything.
PrivacyRule(PrivacyRule.Action action, long order, Contact.Subscription subscription) Creates a privacy rule of type 'subscription'.
PrivacyRule(PrivacyRule.Action action, long order, Jid jid) Creates a privacy rule of type 'jid'.
PrivacyRule(PrivacyRule.Action action, long order, String group) Creates a privacy rule of type 'group'.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PrivacyRule o) Compares this rule with another rule by comparing their order.
PrivacyRule.Action	getAction() Sets the action to perform (either allow or deny).
long	getOrder() Gets the order in which privacy items are processed by the server.
PrivacyRule.Type	getType() Gets the type.
String	getValue() Gets the value.
boolean	isFilterIQ() Indicates, whether incoming IQ stanzas are filtered.
boolean	isFilterMessage() Indicates, whether incoming message stanzas are filtered.
boolean	isFilterPresenceIn() Indicates, whether incoming presence notifications are filtered.
boolean	isFilterPresenceOut() Indicates, whether outgoing presence notifications are filtered.
void	setAction(PrivacyRule.Action action) Sets the action to perform (either allow or deny).
void	setFilterIQ(boolean filterIQ) Indicates, whether incoming IQ stanzas are filtered.
void	setFilterMessage(boolean filterMessages) Indicates, whether incoming message stanzas are filtered.
void	setFilterPresenceIn(boolean filterPresenceIn) Indicates, whether incoming presence notifications are filtered.
void	setFilterPresenceOut(boolean filterPresenceOut) Indicates, whether outgoing presence notifications are filtered.
void	setOrder(int order) Gets the order in which privacy items are processed by the server.
void	setType(PrivacyRule.Type type) Sets the type.
void	setValue(String value) Sets the value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrivacyRule

public PrivacyRule(PrivacyRule.Action action,
                   long order)

Creates a privacy list item, which allows or blocks everything.

Parameters:

action - The action to perform, i.e. either allow or deny.

order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.

PrivacyRule

public PrivacyRule(PrivacyRule.Action action,
                   long order,
                   Contact.Subscription subscription)

Creates a privacy rule of type 'subscription'.

Parameters:

action - The action to perform, i.e. either allow or deny.

order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.

subscription - The subscription.

PrivacyRule

public PrivacyRule(PrivacyRule.Action action,
                   long order,
                   Jid jid)

Creates a privacy rule of type 'jid'.

Parameters:

action - The action to perform, i.e. either allow or deny.

order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.

jid - The JID.

PrivacyRule

public PrivacyRule(PrivacyRule.Action action,
                   long order,
                   String group)

Creates a privacy rule of type 'group'.

Parameters:

action - The action to perform, i.e. either allow or deny.

order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.

group - The contact group.

Method Detail

getType

public PrivacyRule.Type getType()

Gets the type.

Returns:

The type.

See Also:

setType(PrivacyRule.Type)

setType

public void setType(PrivacyRule.Type type)

Sets the type.

Parameters:

type - The type.

See Also:

getType()

getAction

public PrivacyRule.Action getAction()

Sets the action to perform (either allow or deny).

Returns:

The action.

See Also:

setAction(PrivacyRule.Action)

setAction

public void setAction(PrivacyRule.Action action)

Sets the action to perform (either allow or deny).

Parameters:

action - The action.

See Also:

getAction()

getValue

public String getValue()

Gets the value.

Returns:

The value.

See Also:

setValue(String)

setValue

public void setValue(String value)

Sets the value.

• If the type is PrivacyRule.Type.JID, then the value must be a valid JID.
• If the type is PrivacyRule.Type.GROUP, then the value should be the name of a group in the user's roster.
• If the type is PrivacyRule.Type.SUBSCRIPTION, then the value must be one of "both", "to", "from", or "none".

Parameters:

value - The value.

See Also:

getValue()

getOrder

public long getOrder()

Gets the order in which privacy items are processed by the server.

Returns:

The order.

See Also:

setOrder(int)

setOrder

public void setOrder(int order)

Gets the order in which privacy items are processed by the server.

Parameters:

order - The order.

See Also:

getOrder()

isFilterMessage

public boolean isFilterMessage()

Indicates, whether incoming message stanzas are filtered.

Returns:

True, if incoming message stanzas are filtered.

See Also:

setFilterMessage(boolean)

setFilterMessage

public void setFilterMessage(boolean filterMessages)

Indicates, whether incoming message stanzas are filtered.

Parameters:

filterMessages - True, if incoming message stanzas are filtered.

See Also:

isFilterMessage()

isFilterIQ

public boolean isFilterIQ()

Indicates, whether incoming IQ stanzas are filtered.

Returns:

True, if incoming IQ stanzas are filtered.

See Also:

setFilterIQ(boolean)

setFilterIQ

public void setFilterIQ(boolean filterIQ)

Indicates, whether incoming IQ stanzas are filtered.

Parameters:

filterIQ - True, if incoming IQ stanzas are filtered.

See Also:

isFilterIQ()

isFilterPresenceIn

public boolean isFilterPresenceIn()

Indicates, whether incoming presence notifications are filtered.

Returns:

True, if incoming presence notifications are filtered.

See Also:

setFilterPresenceIn(boolean)

setFilterPresenceIn

public void setFilterPresenceIn(boolean filterPresenceIn)

Indicates, whether incoming presence notifications are filtered.

Parameters:

filterPresenceIn - True, if incoming presence notifications are filtered.

See Also:

isFilterPresenceIn()

isFilterPresenceOut

public boolean isFilterPresenceOut()

Indicates, whether outgoing presence notifications are filtered.

Returns:

True, if outgoing presence notifications are filtered.

See Also:

setFilterPresenceOut(boolean)

setFilterPresenceOut

public void setFilterPresenceOut(boolean filterPresenceOut)

Indicates, whether outgoing presence notifications are filtered.

Parameters:

filterPresenceOut - True, if outgoing presence notifications are filtered.

See Also:

isFilterPresenceOut()

compareTo

public int compareTo(PrivacyRule o)

Compares this rule with another rule by comparing their order.

Specified by:

compareTo in interface Comparable<PrivacyRule>

Parameters:

o - The other rule.

Returns:

The comparison result.

toString

public String toString()

Overrides:

toString in class Object