Added UserIdentitiesProvider. See log message for r8774.

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/branches@8775 b35dd754-fafc-0310-a699-88a17e54d16e

pep/src/java/org/jivesoftware/openfire/disco/UserIdentitiesProvider.java

+/**
+ * $RCSfile: $
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
+package org.jivesoftware.openfire.disco;
+
+import java.util.Iterator;
+
+import org.dom4j.Element;
+
+/**
+ * <p>
+ * A <code>UserIdentitiesProvider</code> is responsible for providing the identities
+ * of protocols supported by users. An example of a user identity is one
+ * for PEP (XEP-0163): <identity category="pubsub" type="pep" />
+ * <p/>
+ * 
+ * <p>
+ * When the server starts up, IQDiscoInfoHandler will request to all the services that implement
+ * the UserIdentitiesProvider interface for their identities. Whenever a disco request is received
+ * IQDiscoInfoHandler will add to the provided information all the collected identities. Therefore, a
+ * service must implement this interface in order to offer/publish its identities as part of the
+ * user identities.
+ * </p>
+ *
+ * @author Armando Jagucki
+ */
+public interface UserIdentitiesProvider {
+
+    /**
+     * Returns an Iterator (of Element) with the supported identities by users. The identities to
+     * include are the identities of protocols supported by all registered users on the server. The
+     * idea is that different modules may provide their identities that will ultimately be included
+     * in the list user identities.
+     *
+     * @return an Iterator (of Element) with identities of protocols supported by users.
+     */
+    public abstract Iterator<Element> getIdentities();
+}