Package org.jivesoftware.smackx.iot.provisioning

Class IoTProvisioningManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.iot.provisioning.IoTProvisioningManager

public final class IoTProvisioningManager
extends org.jivesoftware.smack.Manager

A manager for XEP-0324: Internet of Things - Provisioning.

See Also:

XEP-0324: Internet of Things - Provisioning

Method Summary

Modifier and Type	Method	Description
boolean	addBecameFriendListener(BecameFriendListener becameFriendListener)
boolean	addWasUnfriendedListener(WasUnfriendedListener wasUnfriendedListener)
org.jxmpp.jid.DomainBareJid	findProvisioningServerComponent()	Try to find a provisioning server component.
org.jxmpp.jid.Jid	getConfiguredProvisioningServer()
static IoTProvisioningManager	getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)	Get the manger instance responsible for the given connection.
boolean	iAmFriendOf(org.jxmpp.jid.BareJid otherJid)
boolean	isFriend(org.jxmpp.jid.Jid provisioningServer, org.jxmpp.jid.BareJid friendInQuestion)	As the given provisioning server is the given JID is a friend.
boolean	isMyFriend(org.jxmpp.jid.Jid friendInQuestion)
boolean	removeBecameFriendListener(BecameFriendListener becameFriendListener)
boolean	removeWasUnfriendedListener(WasUnfriendedListener wasUnfriendedListener)
void	sendFriendshipRequest(org.jxmpp.jid.BareJid bareJid)
void	sendFriendshipRequestIfRequired(org.jxmpp.jid.BareJid jid)
void	setConfiguredProvisioningServer(org.jxmpp.jid.Jid provisioningServer)	Set the configured provisioning server.
void	unfriend(org.jxmpp.jid.Jid friend)

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static IoTProvisioningManager getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)

Get the manger instance responsible for the given connection.

Parameters:

connection - the XMPP connection.

Returns:

a manager instance.

setConfiguredProvisioningServer

public void setConfiguredProvisioningServer(org.jxmpp.jid.Jid provisioningServer)

Set the configured provisioning server. Use null as provisioningServer to use automatic discovery of the provisioning server (the default behavior).

Parameters:

provisioningServer - TODO javadoc me please

getConfiguredProvisioningServer

public org.jxmpp.jid.Jid getConfiguredProvisioningServer()
                                                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                         org.jivesoftware.smack.SmackException.NotConnectedException,
                                                         java.lang.InterruptedException

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

findProvisioningServerComponent

public org.jxmpp.jid.DomainBareJid findProvisioningServerComponent()
                                                            throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                                   org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                                   org.jivesoftware.smack.SmackException.NotConnectedException,
                                                                   java.lang.InterruptedException

Try to find a provisioning server component.

Returns:

the XMPP address of the provisioning server component if one was found.

Throws:

org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.

org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.

org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

See Also:

XEP-0324 § 3.1.2 Provisioning Server as a server component

isFriend

public boolean isFriend(org.jxmpp.jid.Jid provisioningServer,
                        org.jxmpp.jid.BareJid friendInQuestion)
                 throws org.jivesoftware.smack.SmackException.NoResponseException,
                        org.jivesoftware.smack.XMPPException.XMPPErrorException,
                        org.jivesoftware.smack.SmackException.NotConnectedException,
                        java.lang.InterruptedException

As the given provisioning server is the given JID is a friend.

Parameters:

provisioningServer - the provisioning server to ask.

friendInQuestion - the JID to ask about.

Returns:

true if the JID is a friend, false otherwise.

Throws:

org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.

org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.

org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

iAmFriendOf

public boolean iAmFriendOf(org.jxmpp.jid.BareJid otherJid)

sendFriendshipRequest

public void sendFriendshipRequest(org.jxmpp.jid.BareJid bareJid)
                           throws org.jivesoftware.smack.SmackException.NotConnectedException,
                                  java.lang.InterruptedException

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

sendFriendshipRequestIfRequired

public void sendFriendshipRequestIfRequired(org.jxmpp.jid.BareJid jid)
                                     throws org.jivesoftware.smack.SmackException.NotConnectedException,
                                            java.lang.InterruptedException

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

isMyFriend

public boolean isMyFriend(org.jxmpp.jid.Jid friendInQuestion)

unfriend

public void unfriend(org.jxmpp.jid.Jid friend)
              throws org.jivesoftware.smack.SmackException.NotConnectedException,
                     java.lang.InterruptedException

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

addBecameFriendListener

public boolean addBecameFriendListener(BecameFriendListener becameFriendListener)

removeBecameFriendListener

public boolean removeBecameFriendListener(BecameFriendListener becameFriendListener)

addWasUnfriendedListener

public boolean addWasUnfriendedListener(WasUnfriendedListener wasUnfriendedListener)

removeWasUnfriendedListener

public boolean removeWasUnfriendedListener(WasUnfriendedListener wasUnfriendedListener)