You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by gg...@apache.org on 2023/03/20 20:53:11 UTC
[mina-vysper] branch master updated: Fix Javadoc errors
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-vysper.git
The following commit(s) were added to refs/heads/master by this push:
new 995a8f7b Fix Javadoc errors
995a8f7b is described below
commit 995a8f7badbdabb0051f1d2bfac8020e04d960a7
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 16:53:06 2023 -0400
Fix Javadoc errors
---
.../org/apache/vysper/xml/fragment/XMLElement.java | 4 +--
.../vysper/xml/fragment/XMLElementVerifier.java | 4 +--
.../apache/vysper/xml/sax/impl/XMLTokenizer.java | 4 +--
.../org/apache/vysper/xmpp/addressing/Entity.java | 31 +++++++++++-----------
.../xmpp/addressing/stringprep/StringPrep.java | 4 +--
.../core/base/BaseStreamStanzaDictionary.java | 4 +--
.../modules/core/sasl/SASLStanzaDictionary.java | 4 +--
.../core/starttls/StartTLSStanzaDictionary.java | 4 +--
.../modules/roster/handler/RosterIQHandler.java | 2 +-
.../vysper/xmpp/parser/ParsingException.java | 9 +++----
.../apache/vysper/xmpp/server/SessionContext.java | 6 ++---
.../vysper/xmpp/server/components/Component.java | 4 +--
.../java/org/apache/vysper/xmpp/stanza/Stanza.java | 4 +--
.../xmpp/state/presence/AbstractBaseCache.java | 2 +-
.../state/presence/EhCachePresenceCacheImpl.java | 8 +++---
.../resourcebinding/DefaultResourceRegistry.java | 12 ++++++---
.../extension/websockets/WebSocketEndpoint.java | 2 +-
.../extension/xep0045_muc/model/Privilege.java | 2 +-
.../AbstractPublishSubscribeIQHandler.java | 2 +-
.../xep0060_pubsub/NodeDiscoItemsVisitor.java | 2 +-
.../xep0060_pubsub/ServiceDiscoItemsVisitor.java | 2 +-
.../xmpp/extension/xep0065_socks/Socks5Module.java | 2 +-
.../xep0124/BoshBackedSessionContext.java | 2 +-
.../xmpp/extension/xep0124/BoshEndpoint.java | 2 +-
.../xmpp/extension/xep0124/BoshStanzaUtils.java | 3 +--
.../extension/xep0313_mam/query/QuerySet.java | 2 +-
.../xep0313_mam/spi/ArchivedMessages.java | 2 +-
.../extension/xep0313_mam/spi/MessageArchive.java | 2 +-
.../apache/vysper/storage/hbase/HBaseStorage.java | 2 ++
29 files changed, 69 insertions(+), 64 deletions(-)
diff --git a/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElement.java b/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElement.java
index 3557d818..ac00833f 100644
--- a/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElement.java
+++ b/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElement.java
@@ -279,8 +279,8 @@ public class XMLElement implements XMLFragment {
/**
* collects all inner elements with given name and puts them in a map indexed by
* @param name
- * @return Map<String language, XMLElement>
- * @exception no language attribute may occur more than once for the same element
+ * @return Map from String language to XMLElement
+ * @throws XMLSemanticError no language attribute may occur more than once for the same element
*/
public Map<String, XMLElement> getInnerElementsByXMLLangNamed(String name) throws XMLSemanticError {
if (name == null) return null;
diff --git a/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElementVerifier.java b/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElementVerifier.java
index 35c22b71..8115fb32 100644
--- a/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElementVerifier.java
+++ b/nbxml/src/main/java/org/apache/vysper/xml/fragment/XMLElementVerifier.java
@@ -158,8 +158,8 @@ public class XMLElementVerifier {
}
/**
- * example for "http://myNS.org/anything", this method returns "myNS" for
- * element <test xmlns:myNS="http://myNS.org/anything" />
+ * Example for "http://myNS.org/anything", this method returns "myNS" for
+ * element {@code <test xmlns:myNS="http://myNS.org/anything" />}
*
* @return the identifier for the given namespace definition
*/
diff --git a/nbxml/src/main/java/org/apache/vysper/xml/sax/impl/XMLTokenizer.java b/nbxml/src/main/java/org/apache/vysper/xml/sax/impl/XMLTokenizer.java
index 37c20ea4..37237bd7 100644
--- a/nbxml/src/main/java/org/apache/vysper/xml/sax/impl/XMLTokenizer.java
+++ b/nbxml/src/main/java/org/apache/vysper/xml/sax/impl/XMLTokenizer.java
@@ -56,8 +56,8 @@ public class XMLTokenizer {
/**
* @param byteBuffer
- * @param charsetDecoder
- * @throws Exception
+ * @param decoder
+ * @throws SAXException
*/
public void parse(IoBuffer byteBuffer, CharsetDecoder decoder) throws SAXException {
while (byteBuffer.hasRemaining() && state != State.CLOSED) {
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/addressing/Entity.java b/server/core/src/main/java/org/apache/vysper/xmpp/addressing/Entity.java
index fd3e21c2..03c66fe6 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/addressing/Entity.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/addressing/Entity.java
@@ -21,25 +21,26 @@
package org.apache.vysper.xmpp.addressing;
/**
- * <code>
- * The "JID"<br/>
- * jid = [ node "@" ] domain [ "/" resource ]<br/>
- * domain = fqdn / address-literal<br/>
- * fqdn = (sub-domain 1*("." sub-domain))<br/>
- * sub-domain = (internationalized domain label)<br/>
- * address-literal = IPv4address / IPv6address<br/>
- *<br/>
+ * The "JID"
+ * <pre>
+ * jid = [ node "@" ] domain [ "/" resource ]
+ * domain = fqdn / address-literal
+ * fqdn = (sub-domain 1*("." sub-domain))
+ * sub-domain = (internationalized domain label)
+ * address-literal = IPv4address / IPv6address
+ * </pre>
+ * <p>
* Each allowable portion of a JID (node identifier, domain identifier,
* and resource identifier) MUST NOT be more than 1023 bytes in length,
* resulting in a maximum total size (including the '@' and '/'
* separators) of 3071 bytes.
- * </code>
- * <br/><br/>
- * romeo@example.net - typical user/client JID<br/>
- * example.net - typical server JID<br/>
- * node@domain - a BARE JID<br/>
- * node@domain/resource - a FULL JID - client id after resource binding, a CONNECTED RESOURCE<br/>
- *
+ * </p>
+ * <ul>
+ * <li>romeo@example.net - typical user/client JID</li>
+ * <li>example.net - typical server JID</li>
+ * <li>node@domain - a BARE JID</li>
+ * <li>node@domain/resource - a FULL JID - client id after resource binding, a CONNECTED RESOURCE</li>
+ * </ul>
*
* @author The Apache MINA Project (dev@mina.apache.org)
*
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/addressing/stringprep/StringPrep.java b/server/core/src/main/java/org/apache/vysper/xmpp/addressing/stringprep/StringPrep.java
index 22cf96d2..f3de0966 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/addressing/stringprep/StringPrep.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/addressing/stringprep/StringPrep.java
@@ -105,7 +105,7 @@ public class StringPrep {
* Override this method and return a custom map of character mappings to
* alter the Stringprep behavior.
*
- * @return a {@link Map}<String, String> containing all character mappings
+ * @return a {@link Map}{@code <String, String>} containing all character mappings
*/
protected Map<String, String> buildMapping() {
Map<String, String> mapping = new HashMap<String, String>();
@@ -120,7 +120,7 @@ public class StringPrep {
* Override this method and return a custom set of prohibited characters to
* alter the Stringprep behavior.
*
- * @return a {@link Set}<String> containing all characters that are
+ * @return a {@link Set}{@code <String>} containing all characters that are
* prohibited
*/
protected Set<String> buildProhibitedSet() {
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/base/BaseStreamStanzaDictionary.java b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/base/BaseStreamStanzaDictionary.java
index 2fd1fc4f..e5f21af3 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/base/BaseStreamStanzaDictionary.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/base/BaseStreamStanzaDictionary.java
@@ -28,8 +28,8 @@ import org.apache.vysper.xmpp.protocol.NamespaceHandlerDictionary;
import org.apache.vysper.xmpp.protocol.NamespaceURIs;
/**
- * handler for base stanzas from RFC3920 (xmpp core)<br/>
- * they are: stream, message, presence, iq
+ * Handler for base stanzas from RFC3920 (xmpp core):
+ * stream, message, presence, iq
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/sasl/SASLStanzaDictionary.java b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/sasl/SASLStanzaDictionary.java
index 8945014c..d79dc77a 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/sasl/SASLStanzaDictionary.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/sasl/SASLStanzaDictionary.java
@@ -24,8 +24,8 @@ import org.apache.vysper.xmpp.protocol.NamespaceHandlerDictionary;
import org.apache.vysper.xmpp.protocol.NamespaceURIs;
/**
- * handler for authorization stanzas from RFC3920 (xmpp core)<br/>
- * they are: auth, challenge, abort, aborted, failure, sucess, response
+ * Handler for authorization stanzas from RFC3920 (xmpp core):
+ * auth, challenge, abort, aborted, failure, sucess, response
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/starttls/StartTLSStanzaDictionary.java b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/starttls/StartTLSStanzaDictionary.java
index 2f63d4be..4032dc23 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/starttls/StartTLSStanzaDictionary.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/modules/core/starttls/StartTLSStanzaDictionary.java
@@ -24,8 +24,8 @@ import org.apache.vysper.xmpp.protocol.NamespaceHandlerDictionary;
import org.apache.vysper.xmpp.protocol.NamespaceURIs;
/**
- * handler for stream securing (TLS) stanzas from RFC3920 (xmpp core)<br/>
- * they are: starttls, failure, proceed
+ * Handler for stream securing (TLS) stanzas from RFC3920 (xmpp core):
+ * starttls, failure, proceed
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/roster/handler/RosterIQHandler.java b/server/core/src/main/java/org/apache/vysper/xmpp/modules/roster/handler/RosterIQHandler.java
index bbf5f1f3..c1af67f1 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/modules/roster/handler/RosterIQHandler.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/modules/roster/handler/RosterIQHandler.java
@@ -62,7 +62,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * handles roster get, set, push & result requests
+ * Handles roster get, set, push and result requests.
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/parser/ParsingException.java b/server/core/src/main/java/org/apache/vysper/xmpp/parser/ParsingException.java
index a3f9b376..ea3d07af 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/parser/ParsingException.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/parser/ParsingException.java
@@ -21,14 +21,13 @@
package org.apache.vysper.xmpp.parser;
/**
- * <bad-format/> -- the entity has sent XML that cannot be processed;
+ * {@code <bad-format/>} -- the entity has sent XML that cannot be processed;
* this error MAY be used instead of the more specific XML-related
- * errors, such as <bad-namespace-prefix/>, <invalid-xml/>,
- * <restricted-xml/>, <unsupported-encoding/>, and
- * <xml-not-well-formed/>, although the more specific errors are
+ * errors, such as {@code <bad-namespace-prefix/>}, {@code <invalid-xml/>},
+ * {@code <restricted-xml/>}, {@code <unsupported-encoding/>}, and
+ * {@code <xml-not-well-formed/>}, although the more specific errors are
* preferred.
*
- *
* @author The Apache MINA Project (dev@mina.apache.org)
*/
public class ParsingException extends Exception {
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java b/server/core/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
index 61018639..770ada20 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
@@ -40,7 +40,7 @@ public interface SessionContext {
*/
CONNECTION_ABORT,
/**
- * the client regularily ended the session (sending </stream:stream>)
+ * the client regularly ended the session (sending {@code </stream:stream>})
*/
CLIENT_BYEBYE,
/**
@@ -48,7 +48,7 @@ public interface SessionContext {
*/
SERVER_SHUTDOWN,
/**
- * the server signalled a stream error to the client and subsequently needs to
+ * the server signaled a stream error to the client and subsequently needs to
* close the session down
*/
STREAM_ERROR;
@@ -150,7 +150,7 @@ public interface SessionContext {
void switchToTLS(boolean delayed, boolean clientTls);
/**
- * this method signals that from now on a new <stream:stream>... xml stream
+ * Signals that from now on a new {@code <stream:stream>...} XML stream
* begins. this is used at the very beginning of the session, then again after
* encryption and after authentication. see RFC3920.7.5.7 and RFC3920.6.2
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/server/components/Component.java b/server/core/src/main/java/org/apache/vysper/xmpp/server/components/Component.java
index a7d2462d..b22d0bbb 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/server/components/Component.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/server/components/Component.java
@@ -26,7 +26,7 @@ import org.apache.vysper.xmpp.protocol.NamespaceHandlerDictionary;
import org.apache.vysper.xmpp.protocol.StanzaHandler;
/**
- * a component is a server subsystem providing a dedicated extension. components
+ * A component is a server subsystem providing a dedicated extension. components
* operate on their own subdomain, e.g. conference.vysper.org for MUC.
* components have a dedicated context in which they receive stanzas
*/
@@ -34,7 +34,7 @@ public interface Component {
/**
* the subdomain this component should become available under. example:
- * subdomain = 'chat' + server domain = 'vysper.org' => 'chat.vysper.org'
+ * subdomain = 'chat' + server domain = 'vysper.org' {@code =>} 'chat.vysper.org'
*
* @return
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/Stanza.java b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/Stanza.java
index b907b25a..25c73bf1 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/Stanza.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/Stanza.java
@@ -66,8 +66,8 @@ public class Stanza extends XMLElement {
/**
* Returns the from attribute <b>if</b> it is sent with the stanza (rare).
- * Use {@link XMPPCoreStanzaHandler#extractSenderJID()} to make sure you get
- * a JID (either with or without resource).
+ * Use {@link XMPPCoreStanzaHandler#extractSenderJID(XMPPCoreStanza, org.apache.vysper.xmpp.server.SessionContext)}
+ * to make sure you get a JID (either with or without resource).
*
* @return the sender JID, or null if not set.
*/
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/AbstractBaseCache.java b/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/AbstractBaseCache.java
index 5b274487..646326ac 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/AbstractBaseCache.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/AbstractBaseCache.java
@@ -50,7 +50,7 @@ public abstract class AbstractBaseCache implements LatestPresenceCache {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
public void put(Entity entity, PresenceStanza presenceStanza) throws PresenceCachingException {
checkEntry(entity);
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/EhCachePresenceCacheImpl.java b/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/EhCachePresenceCacheImpl.java
index 3867d3dd..cbf0038a 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/EhCachePresenceCacheImpl.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/state/presence/EhCachePresenceCacheImpl.java
@@ -92,7 +92,7 @@ public class EhCachePresenceCacheImpl extends AbstractBaseCache {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
protected void put0(Entity entity, PresenceStanza presenceStanza) throws PresenceCachingException {
@@ -105,7 +105,7 @@ public class EhCachePresenceCacheImpl extends AbstractBaseCache {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
protected PresenceStanza get0(Entity entity) throws PresenceCachingException {
@@ -120,7 +120,7 @@ public class EhCachePresenceCacheImpl extends AbstractBaseCache {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
public PresenceStanza getForBareJID(Entity entity) throws PresenceCachingException {
// return null for null entries
@@ -138,7 +138,7 @@ public class EhCachePresenceCacheImpl extends AbstractBaseCache {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
public void remove(Entity entity) {
// if entity is null, keep silent
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/state/resourcebinding/DefaultResourceRegistry.java b/server/core/src/main/java/org/apache/vysper/xmpp/state/resourcebinding/DefaultResourceRegistry.java
index 5d57c0a7..d55b2f5a 100644
--- a/server/core/src/main/java/org/apache/vysper/xmpp/state/resourcebinding/DefaultResourceRegistry.java
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/state/resourcebinding/DefaultResourceRegistry.java
@@ -131,9 +131,13 @@ public class DefaultResourceRegistry implements InternalResourceRegistry {
/**
* not as commonly used as #unbindSession, this method unbinds only one of multiple resource ids for the _same_
* session. In XMPP, this is done by sending a stanza like
- * <iq id='unbind_1' type='set'><unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'>
- * <resource>resourceId</resource>
- * </unbind></iq>
+ * <pre>
+ * {@code <iq id='unbind_1' type='set'>
+ * <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'>
+ * <resource>resourceId</resource>
+ * </unbind>
+ * </iq>}
+ * </pre>
* @param resourceId
*/
public boolean unbindResource(String resourceId) {
@@ -169,7 +173,7 @@ public class DefaultResourceRegistry implements InternalResourceRegistry {
/**
* unbinds a complete session, together with all its bound resources. this is typically done when a XMPP session
- * end because the client sends a </stream:stream> or the connection is cut.
+ * end because the client sends a {@code </stream:stream>} or the connection is cut.
* @param unbindingSessionContext sessionContext to be unbound
*/
public void unbindSession(SessionContext unbindingSessionContext) {
diff --git a/server/extensions/websockets/src/main/java/org/apache/vysper/xmpp/extension/websockets/WebSocketEndpoint.java b/server/extensions/websockets/src/main/java/org/apache/vysper/xmpp/extension/websockets/WebSocketEndpoint.java
index b4b04730..1474368e 100644
--- a/server/extensions/websockets/src/main/java/org/apache/vysper/xmpp/extension/websockets/WebSocketEndpoint.java
+++ b/server/extensions/websockets/src/main/java/org/apache/vysper/xmpp/extension/websockets/WebSocketEndpoint.java
@@ -99,7 +99,7 @@ public class WebSocketEndpoint implements Endpoint {
* Enables/disables SSL for this endpoint.
* <p>
* If SSL is enabled it requires SSL certificate information that can be
- * configured with {@link #setSSLCertificateInfo(String, String)}
+ * configured with {@link #setSSLCertificateKeystore(String, String)}
* @param value
*/
public void setSSLEnabled(boolean value) {
diff --git a/server/extensions/xep0045-muc/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0045_muc/model/Privilege.java b/server/extensions/xep0045-muc/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0045_muc/model/Privilege.java
index 873966f6..4dacb6a9 100644
--- a/server/extensions/xep0045-muc/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0045_muc/model/Privilege.java
+++ b/server/extensions/xep0045-muc/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0045_muc/model/Privilege.java
@@ -117,7 +117,7 @@ public enum Privilege {
/**
* Get the privileges for the specified {@link Affiliation}
- * @param role The {@link Affiliation} to look up privileges for
+ * @param affiliation The {@link Affiliation} to look up privileges for
* @return The privileges for the specified affiliation
*/
public static EnumSet<Privilege> getPrivileges(Affiliation affiliation) {
diff --git a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/AbstractPublishSubscribeIQHandler.java b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/AbstractPublishSubscribeIQHandler.java
index 7841deb5..7a9bf3bf 100644
--- a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/AbstractPublishSubscribeIQHandler.java
+++ b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/AbstractPublishSubscribeIQHandler.java
@@ -47,7 +47,7 @@ public abstract class AbstractPublishSubscribeIQHandler extends DefaultIQHandler
/**
* Initialize the handler with the given root CollectionNode.
*
- * @param root the one and only "root" CollectionNode
+ * @param serviceConfiguration the one and only "root" CollectionNode
*/
public AbstractPublishSubscribeIQHandler(PubSubServiceConfiguration serviceConfiguration) {
this.serviceConfiguration = serviceConfiguration;
diff --git a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/NodeDiscoItemsVisitor.java b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/NodeDiscoItemsVisitor.java
index 1d30c59b..fb4edcae 100644
--- a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/NodeDiscoItemsVisitor.java
+++ b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/NodeDiscoItemsVisitor.java
@@ -51,7 +51,7 @@ public class NodeDiscoItemsVisitor implements ItemVisitor {
* Gets called with each itemID and payload of a node. Builds the answer
* for disco#items requests to a node.
*
- * @see org.apache.vysper.xmpp.modules.extension.xep0060_pubsub.ItemVisitor#visit(java.lang.String, org.apache.vysper.xmpp.xmlfragment.XMLElement)
+ * @see org.apache.vysper.xmpp.modules.extension.xep0060_pubsub.ItemVisitor#visit(String, PayloadItem)
*/
public void visit(String itemID, PayloadItem payload) {
itemList.add(payload);
diff --git a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/ServiceDiscoItemsVisitor.java b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/ServiceDiscoItemsVisitor.java
index cd1e614d..8af9298e 100644
--- a/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/ServiceDiscoItemsVisitor.java
+++ b/server/extensions/xep0060-pubsub/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0060_pubsub/ServiceDiscoItemsVisitor.java
@@ -42,7 +42,7 @@ public class ServiceDiscoItemsVisitor implements NodeVisitor {
/**
* Prepare the node-list for the disco#items response.
*
- * @see org.apache.vysper.xmpp.modules.extension.xep0060_pubsub.NodeVisitor#visit(org.apache.vysper.xmpp.addressing.Entity, org.apache.vysper.xmpp.modules.extension.xep0060_pubsub.model.LeafNode)
+ * @see org.apache.vysper.xmpp.modules.extension.xep0060_pubsub.NodeVisitor#visit(LeafNode)
*/
public void visit(LeafNode ln) {
this.itemList.add(new Item(serviceConfiguration.getDomainJID(), ln.getTitle(), ln.getName()));
diff --git a/server/extensions/xep0065-socks/src/main/java/org/apache/vysper/xmpp/extension/xep0065_socks/Socks5Module.java b/server/extensions/xep0065-socks/src/main/java/org/apache/vysper/xmpp/extension/xep0065_socks/Socks5Module.java
index 24ef2de7..ec3802c8 100644
--- a/server/extensions/xep0065-socks/src/main/java/org/apache/vysper/xmpp/extension/xep0065_socks/Socks5Module.java
+++ b/server/extensions/xep0065-socks/src/main/java/org/apache/vysper/xmpp/extension/xep0065_socks/Socks5Module.java
@@ -49,7 +49,7 @@ import org.apache.vysper.xmpp.server.components.ComponentStanzaProcessor;
/**
- * Implementation of XEO-0065 SOCKS5 Bytestreams {@link http://xmpp.org/extensions/xep-0065.html}.
+ * Implementation of <a href="http://xmpp.org/extensions/xep-0065.html">XEO-0065 SOCKS5 Bytestreams</a>.
* Will start a SOCKS5 proxy and support the required disco elements.
*
* <p>
diff --git a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshBackedSessionContext.java b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshBackedSessionContext.java
index f281d96a..dc87bcc0 100644
--- a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshBackedSessionContext.java
+++ b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshBackedSessionContext.java
@@ -544,7 +544,7 @@ public class BoshBackedSessionContext extends AbstractSessionContext implements
* Suspends and enqueues an HTTP request to be used later when an asynchronous message needs to be sent from
* the connection manager to the BOSH client.
*
- * @param req the HTTP request
+ * @param br the HTTP request
*/
public void insertRequest(final BoshRequest br) {
diff --git a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshEndpoint.java b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshEndpoint.java
index c303d010..5b5b43ce 100644
--- a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshEndpoint.java
+++ b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshEndpoint.java
@@ -115,7 +115,7 @@ public class BoshEndpoint implements Endpoint {
* Enables/disables SSL for this endpoint.
* <p>
* If SSL is enabled it requires SSL certificate information that can be
- * configured with {@link #setSSLCertificateInfo(String, String)}
+ * configured with {@link #setSSLCertificateKeystore(String)}.
* @param value
*/
public void setSSLEnabled(boolean value) {
diff --git a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshStanzaUtils.java b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshStanzaUtils.java
index f444e20c..8aca5090 100644
--- a/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshStanzaUtils.java
+++ b/server/extensions/xep0124-xep0206-bosh/src/main/java/org/apache/vysper/xmpp/extension/xep0124/BoshStanzaUtils.java
@@ -45,8 +45,7 @@ public class BoshStanzaUtils {
/**
* Creates a unified BOSH response by merging BOSH responses, this is useful when sending more than one message as
* a response to a HTTP request.
- * @param response1 the first BOSH response to merge
- * @param response2 the second BOSH response to merge
+ * @param mergeCandidates the BOSH responses to merge
* @return the merged BOSH response
*/
public static Stanza mergeResponses(Collection<Stanza> mergeCandidates) {
diff --git a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/query/QuerySet.java b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/query/QuerySet.java
index 968f3be4..96c035d2 100644
--- a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/query/QuerySet.java
+++ b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/query/QuerySet.java
@@ -69,7 +69,7 @@ public class QuerySet implements MessagePageRequest {
* Page in a Result Set</a>
*
* The requesting entity MAY ask for the last page in a result set by including
- * in its request an empty <before/> element, and the maximum number of items to
+ * in its request an empty {@code <before/>} element, and the maximum number of items to
* return.
*/
public boolean lastPage() {
diff --git a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/ArchivedMessages.java b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/ArchivedMessages.java
index a8e3cb1d..ff66fc5f 100644
--- a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/ArchivedMessages.java
+++ b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/ArchivedMessages.java
@@ -35,7 +35,7 @@ public interface ArchivedMessages {
* When the results returned by the server are complete (that is: when they have
* not been limited by the maximum size of the result page (either as specified
* or enforced by the server)), the server MUST include a 'complete' attribute
- * on the <fin> element, with a value of 'true'; this informs the client that it
+ * on the {@code <fin>} element, with a value of 'true'; this informs the client that it
* doesn't need to perform further paging to retreive the requested data. If it
* is not the last page of the result set, the server MUST either omit the
* 'complete' attribute, or give it a value of 'false'.
diff --git a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/MessageArchive.java b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/MessageArchive.java
index 7834df15..c1173cab 100644
--- a/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/MessageArchive.java
+++ b/server/extensions/xep0313-mam/src/main/java/org/apache/vysper/xmpp/modules/extension/xep0313_mam/spi/MessageArchive.java
@@ -29,7 +29,7 @@ package org.apache.vysper.xmpp.modules.extension.xep0313_mam.spi;
public interface MessageArchive {
/**
- * At a minimum, the server MUST store the <body> elements of a stanza. It is
+ * At a minimum, the server MUST store the {@code <body>} elements of a stanza. It is
* suggested that other elements that are used in a given deployment to
* supplement conversations (e.g. XHTML-IM payloads) are also stored. Other
* elements MAY be stored.
diff --git a/server/storage/hbase/src/main/java/org/apache/vysper/storage/hbase/HBaseStorage.java b/server/storage/hbase/src/main/java/org/apache/vysper/storage/hbase/HBaseStorage.java
index 2e0b16fc..4ef6bba0 100644
--- a/server/storage/hbase/src/main/java/org/apache/vysper/storage/hbase/HBaseStorage.java
+++ b/server/storage/hbase/src/main/java/org/apache/vysper/storage/hbase/HBaseStorage.java
@@ -41,7 +41,9 @@ import static org.apache.vysper.storage.hbase.HBaseUtils.*;
* back-end adaptor for HBase
*
* prepare HBase by creating table vysper_user:
+ * <pre>{@code
* create 'vysper_user', {NAME => 'bsc', VERSIONS => 1}, {NAME => 'cct', VERSIONS => 1}, {NAME => 'rst', VERSIONS => 1}, {NAME => 'xep', VERSIONS => 5}
+ * }</pre>
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/