tigase.jaxmpp.core.client

Class AbstractSessionObject

java.lang.Object

tigase.jaxmpp.core.client.AbstractSessionObject

All Implemented Interfaces:

SessionObject, UserProperties

public abstract class AbstractSessionObject
extends Object
implements SessionObject

Default representation of SessionObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSessionObject.ClearedEvent
protected class	AbstractSessionObject.Entry

Nested classes/interfaces inherited from interface tigase.jaxmpp.core.client.SessionObject

SessionObject.Scope

Field Summary

Fields

Modifier and Type	Field and Description
static EventType	Cleared
protected Logger	log
protected PresenceStore	presence
protected Map<String,AbstractSessionObject.Entry>	properties
protected ResponseManager	responseManager
protected RosterStore	roster

Fields inherited from interface tigase.jaxmpp.core.client.SessionObject

DOMAIN_NAME, NICKNAME, PASSWORD, RESOURCE, SERVER_NAME, USER_BARE_JID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSessionObject()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(EventType eventType, Listener<? extends BaseEvent> listener)
void	addListener(Listener<? extends BaseEvent> listener)
void	checkHandlersTimeout() Method for process stanzas without response.
void	clear() Reset state.
void	clear(SessionObject.Scope... scopes) Reset state.
void	clear(Set<SessionObject.Scope> scopes)
void	fireEvent(BaseEvent event)
void	fireEvent(EventType eventType, BaseEvent event)
void	fireEvent(EventType eventType, SessionObject sessionObject)
JID	getBindedJid() Returns users JID binded on server.
PresenceStore	getPresence() Returns Store of known presences.
<T> T	getProperty(SessionObject.Scope scope, String key)
<T> T	getProperty(String key) Returns property
Runnable	getResponseHandler(Element element, PacketWriter writer)
RosterStore	getRoster() Returns roster store
Element	getStreamFeatures() Returns XMPP Stream features
BareJID	getUserBareJid() Returns users JID
<T> T	getUserProperty(String key) Get user property.
String	registerResponseHandler(Element stanza, Long timeout, AsyncCallback callback)
void	removeAllListeners()
void	removeListener(EventType eventType, Listener<? extends BaseEvent> listener)
void	removeListener(Listener<? extends BaseEvent> listener)
SessionObject	setProperty(SessionObject.Scope scope, String key, Object value) Set property in given scope.
SessionObject	setProperty(String key, Object value) Set property in session scope.
void	setStreamFeatures(Element element) Set XMPP Stream features
UserProperties	setUserProperty(String key, Object value) Set user property.

Methods inherited from class java.lang.Object

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

Field Detail

Cleared

public static final EventType Cleared

log

protected final Logger log

presence

protected PresenceStore presence

properties

protected Map<String,AbstractSessionObject.Entry> properties

responseManager

protected ResponseManager responseManager

roster

protected RosterStore roster

Constructor Detail

AbstractSessionObject

protected AbstractSessionObject()

Method Detail

addListener

public void addListener(EventType eventType,
               Listener<? extends BaseEvent> listener)

addListener

public void addListener(Listener<? extends BaseEvent> listener)

checkHandlersTimeout

public void checkHandlersTimeout()
                          throws JaxmppException

Method for process stanzas without response.

Specified by:

checkHandlersTimeout in interface SessionObject

Throws:

JaxmppException

clear

public void clear()
           throws JaxmppException

Reset state. Clears all properties stored by modules, roster and presence store. Users properties are keeped.

Specified by:

clear in interface SessionObject

Throws:

JaxmppException

clear

public void clear(SessionObject.Scope... scopes)
           throws JaxmppException

Reset state. Clears given properties stored by modules. Roster and presence store will be cleared if SessionObject.Scope.session is in parameters.

Specified by:

clear in interface SessionObject

Throws:

JaxmppException

clear

public void clear(Set<SessionObject.Scope> scopes)
           throws JaxmppException

Throws:

JaxmppException

fireEvent

public void fireEvent(BaseEvent event)
               throws JaxmppException

Throws:

JaxmppException

fireEvent

public void fireEvent(EventType eventType,
             BaseEvent event)
               throws JaxmppException

Throws:

JaxmppException

fireEvent

public void fireEvent(EventType eventType,
             SessionObject sessionObject)
               throws JaxmppException

Throws:

JaxmppException

getBindedJid

public JID getBindedJid()

Returns users JID binded on server.

Specified by:

getBindedJid in interface SessionObject

Returns:

Jabber ID

getPresence

public PresenceStore getPresence()

Returns Store of known presences.

Specified by:

getPresence in interface SessionObject

Returns:

presence store

getProperty

public <T> T getProperty(SessionObject.Scope scope,
                String key)

getProperty

public <T> T getProperty(String key)

Returns property

Specified by:

getProperty in interface SessionObject

Parameters:

key - property name

Returns:

property

getResponseHandler

public Runnable getResponseHandler(Element element,
                          PacketWriter writer)
                            throws JaxmppException

Throws:

JaxmppException

getRoster

public RosterStore getRoster()

Returns roster store

Specified by:

getRoster in interface SessionObject

Returns:

roster

getStreamFeatures

public Element getStreamFeatures()

Returns XMPP Stream features

Specified by:

getStreamFeatures in interface SessionObject

Returns:

element with features

getUserBareJid

public BareJID getUserBareJid()

Returns users JID

Specified by:

getUserBareJid in interface SessionObject

Returns:

getUserProperty

public <T> T getUserProperty(String key)

Get user property.

Specified by:

getUserProperty in interface UserProperties

Parameters:

key - property name

Returns:

property or null if property isn't set.

registerResponseHandler

public String registerResponseHandler(Element stanza,
                             Long timeout,
                             AsyncCallback callback)
                               throws XMLException

Throws:

XMLException

removeAllListeners

public void removeAllListeners()

removeListener

public void removeListener(EventType eventType,
                  Listener<? extends BaseEvent> listener)

removeListener

public void removeListener(Listener<? extends BaseEvent> listener)

setProperty

public SessionObject setProperty(SessionObject.Scope scope,
                        String key,
                        Object value)

Description copied from interface: SessionObject

Set property in given scope.

Specified by:

setProperty in interface SessionObject

Parameters:

scope - scope of property

key - property name

value - property value. null to unset property.

Returns:

instance of this SessionObject

setProperty

public SessionObject setProperty(String key,
                        Object value)

Set property in session scope.

Specified by:

setProperty in interface SessionObject

Parameters:

key - property name

value - property value. null to unset property.

Returns:

instance of this SessionObject

setStreamFeatures

public void setStreamFeatures(Element element)

Set XMPP Stream features

Specified by:

setStreamFeatures in interface SessionObject

Parameters:

element - element contains features

setUserProperty

public UserProperties setUserProperty(String key,
                             Object value)

Set user property.

Specified by:

setUserProperty in interface UserProperties

Parameters:

key - property name

value - property value. null to unset property

Returns:

instance of this UserProperties