mirror of
https://github.com/vanitasvitae/Smack.git
synced 2025-12-12 22:11:07 +01:00
Prefix subprojects with 'smack-'
instead of using the old baseName=smack appendix=project.name approach, we are now going convention over configuration and renaming the subprojects directories to the proper name. Having a prefix is actually very helpful, because the resulting libraries will be named like the subproject. And a core-4.0.0-rc1.jar is not as explicit about what it actually *is* as a smack-core-4.0.0-rc1.jar. SMACK-265
This commit is contained in:
Florian Schmaus
parent
b6fb1f3743
commit
91fd15ad86
758 changed files with 42 additions and 42 deletions
|
|
@ -0,0 +1,27 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2012 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.ping;
|
||||
|
||||
/**
|
||||
* Defines the callback used whenever the server ping fails.
|
||||
*/
|
||||
public interface PingFailedListener {
|
||||
/**
|
||||
* Called when the server ping fails.
|
||||
*/
|
||||
void pingFailed();
|
||||
}
|
||||
|
|
@ -0,0 +1,388 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2012-2014 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.ping;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.HashSet;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.WeakHashMap;
|
||||
import java.util.concurrent.ScheduledFuture;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.jivesoftware.smack.AbstractConnectionListener;
|
||||
import org.jivesoftware.smack.SmackException;
|
||||
import org.jivesoftware.smack.SmackException.NoResponseException;
|
||||
import org.jivesoftware.smack.SmackException.NotConnectedException;
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smack.ConnectionCreationListener;
|
||||
import org.jivesoftware.smack.Manager;
|
||||
import org.jivesoftware.smack.PacketListener;
|
||||
import org.jivesoftware.smack.XMPPException;
|
||||
import org.jivesoftware.smack.XMPPException.XMPPErrorException;
|
||||
import org.jivesoftware.smack.filter.AndFilter;
|
||||
import org.jivesoftware.smack.filter.IQTypeFilter;
|
||||
import org.jivesoftware.smack.filter.PacketFilter;
|
||||
import org.jivesoftware.smack.filter.PacketTypeFilter;
|
||||
import org.jivesoftware.smack.packet.Packet;
|
||||
import org.jivesoftware.smack.packet.IQ.Type;
|
||||
import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
|
||||
import org.jivesoftware.smackx.ping.packet.Ping;
|
||||
import org.jivesoftware.smackx.ping.packet.Pong;
|
||||
|
||||
/**
|
||||
* Implements the XMPP Ping as defined by XEP-0199. The XMPP Ping protocol allows one entity to
|
||||
* ping any other entity by simply sending a ping to the appropriate JID. PingManger also
|
||||
* periodically sends XMPP pings to the server every 30 minutes to avoid NAT timeouts and to test
|
||||
* the connection status.
|
||||
*
|
||||
* @author Florian Schmaus
|
||||
* @see <a href="http://www.xmpp.org/extensions/xep-0199.html">XEP-0199:XMPP Ping</a>
|
||||
*/
|
||||
public class PingManager extends Manager {
|
||||
public static final String NAMESPACE = "urn:xmpp:ping";
|
||||
|
||||
private static final Logger LOGGER = Logger.getLogger(PingManager.class.getName());
|
||||
|
||||
private static final Map<XMPPConnection, PingManager> INSTANCES = Collections
|
||||
.synchronizedMap(new WeakHashMap<XMPPConnection, PingManager>());
|
||||
|
||||
private static final PacketFilter PING_PACKET_FILTER = new AndFilter(
|
||||
new PacketTypeFilter(Ping.class), new IQTypeFilter(Type.GET));
|
||||
private static final PacketFilter PONG_PACKET_FILTER = new AndFilter(new PacketTypeFilter(
|
||||
Pong.class), new IQTypeFilter(Type.RESULT));
|
||||
|
||||
static {
|
||||
XMPPConnection.addConnectionCreationListener(new ConnectionCreationListener() {
|
||||
public void connectionCreated(XMPPConnection connection) {
|
||||
getInstanceFor(connection);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a {@link PingManager} for the specified {@link XMPPConnection}, creating one if it doesn't already
|
||||
* exist.
|
||||
*
|
||||
* @param connection
|
||||
* The connection the manager is attached to.
|
||||
* @return The new or existing manager.
|
||||
*/
|
||||
public synchronized static PingManager getInstanceFor(XMPPConnection connection) {
|
||||
PingManager pingManager = INSTANCES.get(connection);
|
||||
if (pingManager == null) {
|
||||
pingManager = new PingManager(connection);
|
||||
}
|
||||
return pingManager;
|
||||
}
|
||||
|
||||
private static int defaultPingInterval = 60 * 30;
|
||||
|
||||
/**
|
||||
* Set the default ping interval which will be used for new connections.
|
||||
*
|
||||
* @param interval the interval in seconds
|
||||
*/
|
||||
public static void setDefaultPingInterval(int interval) {
|
||||
defaultPingInterval = interval;
|
||||
}
|
||||
|
||||
private final Set<PingFailedListener> pingFailedListeners = Collections
|
||||
.synchronizedSet(new HashSet<PingFailedListener>());
|
||||
|
||||
/**
|
||||
* The interval in seconds between pings are send to the users server.
|
||||
*/
|
||||
private int pingInterval = defaultPingInterval;
|
||||
|
||||
private ScheduledFuture<?> nextAutomaticPing;
|
||||
|
||||
/**
|
||||
* The time in milliseconds the last pong was received.
|
||||
*/
|
||||
private long lastPongReceived = -1;
|
||||
|
||||
private PingManager(XMPPConnection connection) {
|
||||
super(connection);
|
||||
ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection);
|
||||
sdm.addFeature(PingManager.NAMESPACE);
|
||||
INSTANCES.put(connection, this);
|
||||
|
||||
connection.addPacketListener(new PacketListener() {
|
||||
// Send a Pong for every Ping
|
||||
@Override
|
||||
public void processPacket(Packet packet) throws NotConnectedException {
|
||||
Pong pong = new Pong(packet);
|
||||
connection().sendPacket(pong);
|
||||
}
|
||||
}, PING_PACKET_FILTER);
|
||||
connection.addPacketListener(new PacketListener() {
|
||||
@Override
|
||||
public void processPacket(Packet packet) throws NotConnectedException {
|
||||
lastPongReceived = System.currentTimeMillis();
|
||||
}
|
||||
}, PONG_PACKET_FILTER);
|
||||
connection.addConnectionListener(new AbstractConnectionListener() {
|
||||
@Override
|
||||
public void authenticated(XMPPConnection connection) {
|
||||
maybeSchedulePingServerTask();
|
||||
}
|
||||
@Override
|
||||
public void connectionClosed() {
|
||||
maybeStopPingServerTask();
|
||||
}
|
||||
@Override
|
||||
public void connectionClosedOnError(Exception arg0) {
|
||||
maybeStopPingServerTask();
|
||||
}
|
||||
});
|
||||
maybeSchedulePingServerTask();
|
||||
}
|
||||
|
||||
/**
|
||||
* Pings the given jid. This method will return false if an error occurs. The exception
|
||||
* to this, is a server ping, which will always return true if the server is reachable,
|
||||
* event if there is an error on the ping itself (i.e. ping not supported).
|
||||
* <p>
|
||||
* Use {@link #isPingSupported(String)} to determine if XMPP Ping is supported
|
||||
* by the entity.
|
||||
*
|
||||
* @param jid The id of the entity the ping is being sent to
|
||||
* @param pingTimeout The time to wait for a reply
|
||||
* @return true if a reply was received from the entity, false otherwise.
|
||||
* @throws NoResponseException if there was no response from the jid.
|
||||
* @throws NotConnectedException
|
||||
*/
|
||||
public boolean ping(String jid, long pingTimeout) throws NotConnectedException, NoResponseException {
|
||||
Ping ping = new Ping(jid);
|
||||
try {
|
||||
connection().createPacketCollectorAndSend(ping).nextResultOrThrow();
|
||||
}
|
||||
catch (XMPPException exc) {
|
||||
return jid.equals(connection().getServiceName());
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Same as calling {@link #ping(String, long)} with the defaultpacket reply
|
||||
* timeout.
|
||||
*
|
||||
* @param jid The id of the entity the ping is being sent to
|
||||
* @return true if a reply was received from the entity, false otherwise.
|
||||
* @throws NotConnectedException
|
||||
* @throws NoResponseException if there was no response from the jid.
|
||||
*/
|
||||
public boolean ping(String jid) throws NotConnectedException, NoResponseException {
|
||||
return ping(jid, connection().getPacketReplyTimeout());
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the specified entity to see if it supports the Ping protocol (XEP-0199)
|
||||
*
|
||||
* @param jid The id of the entity the query is being sent to
|
||||
* @return true if it supports ping, false otherwise.
|
||||
* @throws XMPPErrorException An XMPP related error occurred during the request
|
||||
* @throws NoResponseException if there was no response from the jid.
|
||||
* @throws NotConnectedException
|
||||
*/
|
||||
public boolean isPingSupported(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException {
|
||||
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, PingManager.NAMESPACE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Pings the server. This method will return true if the server is reachable. It
|
||||
* is the equivalent of calling <code>ping</code> with the XMPP domain.
|
||||
* <p>
|
||||
* Unlike the {@link #ping(String)} case, this method will return true even if
|
||||
* {@link #isPingSupported(String)} is false.
|
||||
*
|
||||
* @return true if a reply was received from the server, false otherwise.
|
||||
* @throws NotConnectedException
|
||||
*/
|
||||
public boolean pingMyServer() throws NotConnectedException {
|
||||
return pingMyServer(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Pings the server. This method will return true if the server is reachable. It
|
||||
* is the equivalent of calling <code>ping</code> with the XMPP domain.
|
||||
* <p>
|
||||
* Unlike the {@link #ping(String)} case, this method will return true even if
|
||||
* {@link #isPingSupported(String)} is false.
|
||||
*
|
||||
* @param notifyListeners Notify the PingFailedListener in case of error if true
|
||||
* @return true if the user's server could be pinged.
|
||||
* @throws NotConnectedException
|
||||
*/
|
||||
public boolean pingMyServer(boolean notifyListeners) throws NotConnectedException {
|
||||
boolean res;
|
||||
try {
|
||||
res = ping(connection().getServiceName());
|
||||
}
|
||||
catch (NoResponseException e) {
|
||||
res = false;
|
||||
}
|
||||
if (!res && notifyListeners) {
|
||||
for (PingFailedListener l : pingFailedListeners)
|
||||
l.pingFailed();
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the interval between the server is automatic pinged. A negative value disables automatic server pings.
|
||||
*
|
||||
* @param pingInterval the interval between the ping
|
||||
*/
|
||||
public void setPingInterval(int pingInterval) {
|
||||
this.pingInterval = pingInterval;
|
||||
maybeSchedulePingServerTask();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current ping interval.
|
||||
*
|
||||
* @return the interval between pings in seconds
|
||||
*/
|
||||
public int getPingInterval() {
|
||||
return pingInterval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a new PingFailedListener
|
||||
*
|
||||
* @param listener the listener to invoke
|
||||
*/
|
||||
public void registerPingFailedListener(PingFailedListener listener) {
|
||||
pingFailedListeners.add(listener);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister a PingFailedListener
|
||||
*
|
||||
* @param listener the listener to remove
|
||||
*/
|
||||
public void unregisterPingFailedListener(PingFailedListener listener) {
|
||||
pingFailedListeners.remove(listener);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the timestamp when the last XMPP Pong was received.
|
||||
*
|
||||
* @return the timestamp of the last XMPP Pong
|
||||
*/
|
||||
public long getLastReceivedPong() {
|
||||
return lastPongReceived;
|
||||
}
|
||||
|
||||
private void maybeSchedulePingServerTask() {
|
||||
maybeSchedulePingServerTask(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels any existing periodic ping task if there is one and schedules a new ping task if
|
||||
* pingInterval is greater then zero.
|
||||
*
|
||||
* @param delta the delta to the last received ping in seconds
|
||||
*/
|
||||
private synchronized void maybeSchedulePingServerTask(int delta) {
|
||||
maybeStopPingServerTask();
|
||||
if (pingInterval > 0) {
|
||||
int nextPingIn = pingInterval - delta;
|
||||
LOGGER.fine("Scheduling ServerPingTask in " + nextPingIn + " seconds (pingInterval="
|
||||
+ pingInterval + ", delta=" + delta + ")");
|
||||
nextAutomaticPing = connection().schedule(pingServerRunnable, pingInterval, TimeUnit.SECONDS);
|
||||
}
|
||||
}
|
||||
|
||||
private void maybeStopPingServerTask() {
|
||||
if (nextAutomaticPing != null) {
|
||||
nextAutomaticPing.cancel(true);
|
||||
nextAutomaticPing = null;
|
||||
}
|
||||
}
|
||||
|
||||
private final Runnable pingServerRunnable = new Runnable() {
|
||||
private static final int DELTA = 1000; // 1 seconds
|
||||
private static final int TRIES = 3; // 3 tries
|
||||
|
||||
public void run() {
|
||||
LOGGER.fine("ServerPingTask run()");
|
||||
XMPPConnection connection = connection();
|
||||
if (connection == null) {
|
||||
// connection has been collected by GC
|
||||
// which means we can stop the thread by breaking the loop
|
||||
return;
|
||||
}
|
||||
if (pingInterval <= 0) {
|
||||
// Ping has been disabled
|
||||
return;
|
||||
}
|
||||
long lastReceivedPong = getLastReceivedPong();
|
||||
if (lastReceivedPong > 0) {
|
||||
long now = System.currentTimeMillis();
|
||||
// Calculate the delta from now to the next ping time. If delta is positive, the
|
||||
// last successful ping was not to long ago, so we can defer the current ping.
|
||||
int delta = (int) (((pingInterval * 1000) - (now - lastReceivedPong)) / 1000);
|
||||
if (delta > 0) {
|
||||
maybeSchedulePingServerTask(delta);
|
||||
return;
|
||||
}
|
||||
}
|
||||
if (connection.isAuthenticated()) {
|
||||
boolean res = false;
|
||||
|
||||
for (int i = 0; i < TRIES; i++) {
|
||||
if (i != 0) {
|
||||
try {
|
||||
Thread.sleep(DELTA);
|
||||
} catch (InterruptedException e) {
|
||||
// We received an interrupt
|
||||
// This only happens if we should stop pinging
|
||||
return;
|
||||
}
|
||||
}
|
||||
try {
|
||||
res = pingMyServer(false);
|
||||
}
|
||||
catch (SmackException e) {
|
||||
LOGGER.log(Level.WARNING, "SmackError while pinging server", e);
|
||||
res = false;
|
||||
}
|
||||
// stop when we receive a pong back
|
||||
if (res) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
LOGGER.fine("ServerPingTask res=" + res);
|
||||
if (!res) {
|
||||
for (PingFailedListener l : pingFailedListeners) {
|
||||
l.pingFailed();
|
||||
}
|
||||
} else {
|
||||
// Ping was successful, wind-up the periodic task again
|
||||
maybeSchedulePingServerTask();
|
||||
}
|
||||
} else {
|
||||
LOGGER.warning("ServerPingTask: XMPPConnection was not authenticated");
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2012 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.ping.packet;
|
||||
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smackx.ping.PingManager;
|
||||
|
||||
public class Ping extends IQ {
|
||||
|
||||
public static final String ELEMENT = "ping";
|
||||
|
||||
public Ping() {
|
||||
}
|
||||
|
||||
public Ping(String to) {
|
||||
setTo(to);
|
||||
setType(IQ.Type.GET);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getChildElementXML() {
|
||||
return "<" + ELEMENT + " xmlns=\'" + PingManager.NAMESPACE + "\' />";
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2012-2014 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.ping.packet;
|
||||
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smack.packet.Packet;
|
||||
|
||||
public class Pong extends IQ {
|
||||
|
||||
/**
|
||||
* Composes a Pong packet from a received ping packet. This basically swaps
|
||||
* the 'from' and 'to' attributes. And sets the IQ type to result.
|
||||
*
|
||||
* @param ping
|
||||
*/
|
||||
public Pong(Packet ping) {
|
||||
setType(IQ.Type.RESULT);
|
||||
setFrom(ping.getTo());
|
||||
setTo(ping.getFrom());
|
||||
setPacketID(ping.getPacketID());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the child element of the Pong reply, which is non-existent. This
|
||||
* is why we return 'null' here. See e.g. Example 11 from
|
||||
* http://xmpp.org/extensions/xep-0199.html#e2e
|
||||
*/
|
||||
public String getChildElementXML() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2012 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.ping.provider;
|
||||
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smack.provider.IQProvider;
|
||||
import org.jivesoftware.smackx.ping.packet.Ping;
|
||||
import org.xmlpull.v1.XmlPullParser;
|
||||
|
||||
public class PingProvider implements IQProvider {
|
||||
|
||||
public IQ parseIQ(XmlPullParser parser) throws Exception {
|
||||
// No need to use the ping constructor with arguments. IQ will already
|
||||
// have filled out all relevant fields ('from', 'to', 'id').
|
||||
return new Ping();
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue