Package tigase.xmpp.impl

Class PresenceSubscription.PresenceSubscriptionVHostItemExtension

java.lang.Object

tigase.vhosts.VHostItemExtension<T>

tigase.vhosts.AbstractVHostItemExtension<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

tigase.xmpp.impl.PresenceSubscription.PresenceSubscriptionVHostItemExtension

All Implemented Interfaces:

VHostItemExtensionBackwardCompatible<PresenceSubscription.PresenceSubscriptionVHostItemExtension>, VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Enclosing class:

PresenceSubscription

public static class PresenceSubscription.PresenceSubscriptionVHostItemExtension
extends AbstractVHostItemExtension<PresenceSubscription.PresenceSubscriptionVHostItemExtension>
implements VHostItemExtensionBackwardCompatible<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ID

Constructor Summary

Constructors

Constructor	Description
PresenceSubscriptionVHostItemExtension()

Method Summary

Modifier and Type	Method	Description
void	addCommandFields(java.lang.String prefix, Packet packet, boolean forDefault)	Method adds custom extension fields to the ad-hoc form which will be sent to the user for filling with data required to create or update the VHost details.
tigase.xmpp.impl.PresenceSubscription.AUTO_AUTHORIZE_MODE	getAutoAuthorizeMode()
java.lang.String	getId()	Unique identifier of the extension.
void	initFromCommand(java.lang.String prefix, Packet packet)	Method initializes instance of a class with values provided by the user using ad-hoc command.
void	initFromData(java.util.Map<java.lang.String,java.lang.Object> data)
void	initFromElement(Element item)	Method initializes instances of a class with values from the element which contains configuration loaded from the database.
PresenceSubscription.PresenceSubscriptionVHostItemExtension	mergeWithDefaults(PresenceSubscription.PresenceSubscriptionVHostItemExtension defaults)	Abstract method required to be implemented for merging values stored in this instance with default settings stored in the default virtual host item (global or default settings of the installation).
java.lang.String	toDebugString()	Returns a string containing all information about the instance of the extension useful for debugging.
Element	toElement()	Method serializes data stored by this instance to element which will be then stored in the database.

Methods inherited from class tigase.vhosts.AbstractVHostItemExtension

addBooleanFieldWithDefaultToCommand

Methods inherited from class tigase.vhosts.VHostItemExtension

toString

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

PresenceSubscriptionVHostItemExtension

public PresenceSubscriptionVHostItemExtension()

Method Detail

getAutoAuthorizeMode

public tigase.xmpp.impl.PresenceSubscription.AUTO_AUTHORIZE_MODE getAutoAuthorizeMode()

getId

public java.lang.String getId()

Description copied from interface: VHostItemExtensionIfc

Unique identifier of the extension. It has to be a valid XML element name!

Specified by:

getId in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

initFromElement

public void initFromElement(Element item)

Description copied from interface: VHostItemExtensionIfc

Method initializes instances of a class with values from the element which contains configuration loaded from the database. see VHostItemExtensionIfc::toElement()

Specified by:

initFromElement in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Parameters:

item - - provided element with data

initFromCommand

public void initFromCommand(java.lang.String prefix,
                            Packet packet)
                     throws java.lang.IllegalArgumentException

Description copied from interface: VHostItemExtensionIfc

Method initializes instance of a class with values provided by the user using ad-hoc command.

Specified by:

initFromCommand in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Parameters:

prefix - - prefix for data for fields added by this extension

packet - - stanza with submitted ad-hoc command form

Throws:

java.lang.IllegalArgumentException

toDebugString

public java.lang.String toDebugString()

Description copied from interface: VHostItemExtensionIfc

Returns a string containing all information about the instance of the extension useful for debugging.

Specified by:

toDebugString in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

toElement

public Element toElement()

Description copied from interface: VHostItemExtensionIfc

Method serializes data stored by this instance to element which will be then stored in the database. Element name should be equal to the extension id.

Specified by:

toElement in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

addCommandFields

public void addCommandFields(java.lang.String prefix,
                             Packet packet,
                             boolean forDefault)

Description copied from interface: VHostItemExtensionIfc

Method adds custom extension fields to the ad-hoc form which will be sent to the user for filling with data required to create or update the VHost details.

Specified by:

addCommandFields in interface VHostItemExtensionIfc<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Parameters:

prefix - - prefix which should be used by each added field

packet - - packet which will be sent to the user

forDefault - - if true, we are preparing form for "default" configuration used by default by all vhosts.

mergeWithDefaults

public PresenceSubscription.PresenceSubscriptionVHostItemExtension mergeWithDefaults(PresenceSubscription.PresenceSubscriptionVHostItemExtension defaults)

Description copied from class: VHostItemExtension

Abstract method required to be implemented for merging values stored in this instance with default settings stored in the default virtual host item (global or default settings of the installation).

Specified by:

mergeWithDefaults in class VHostItemExtension<PresenceSubscription.PresenceSubscriptionVHostItemExtension>

Parameters:

defaults - - instance of the extension with default values

Returns:

instance of the extension containing merged values

initFromData

public void initFromData(java.util.Map<java.lang.String,java.lang.Object> data)

Specified by:

initFromData in interface VHostItemExtensionBackwardCompatible<PresenceSubscription.PresenceSubscriptionVHostItemExtension>