Commit bccab4bf authored by Christian Schudt's avatar Christian Schudt

Fixing more JavaDoc errors in order to make it build with Java 8's DocLint...

Fixing more JavaDoc errors in order to make it build with Java 8's DocLint eventually (JavaDoc for Openfire's core builds now with DocLint)
parent 30d69258
......@@ -92,8 +92,7 @@ public class XMPPPacketReader {
/**
* <p>Reads a Document from the given URL or filename.</p>
* <p/>
* <p/>
* <p>
* If the systemID contains a <code>':'</code> character then it is
* assumed to be a URL otherwise its assumed to be a file name.
* If you want finer grained control over this mechansim then please
......
......@@ -35,9 +35,9 @@ import org.slf4j.LoggerFactory;
/**
* Manages the AuthorizationProvider objects.
* <p/>
* <p>
* Overall description of the authentication and authorization process:
* <p/>
* </p>
* After a client connects, and indicates a desire to use SASL, the
* SASLAuthentication object decides which SASL mechanisms to advertise,
* and then performs the authentication. If authentication is successful,
......
......@@ -23,12 +23,12 @@ package org.jivesoftware.openfire.auth;
/**
* This is the interface the used to provide default defualt authorization
* ID's when none was selected by the client.
* <p/>
* <p>
* Users that wish to integrate with their own authorization
* system must implement this interface.
* Register the class with Openfire in the <tt>openfire.xml</tt>
* file. An entry in that file would look like the following:
* <p/>
* </p>
* <pre>
* &lt;provider&gt;
* &lt;authorizationMapping&gt;
......
......@@ -23,7 +23,7 @@ package org.jivesoftware.openfire.auth;
/**
* This is the interface the AuthorizationManager uses to
* conduct authorizations.
* <p/>
* <p>
* Users that wish to integrate with their own authorization
* system must implement this interface, and are strongly
* encouraged to extend either the AbstractAuthoriationPolicy
......@@ -31,7 +31,7 @@ package org.jivesoftware.openfire.auth;
* the admin console manage the classes more effectively.
* Register the class with Openfire in the <tt>openfire.xml</tt>
* file. An entry in that file would look like the following:
* <p/>
* </p>
* <pre>
* &lt;provider&gt;
* &lt;authorization&gt;
......
......@@ -61,7 +61,7 @@ import com.cenqua.shaj.Shaj;
* If the value is not set, the machine's default domain will be used or standard OS
* auth will be used if the machine is not part of a domain. On Unix/Linux, this
* value specifies the PAM module to use for authentication. If the value is not set,
* the PAM module "other" will be used.
* the PAM module "other" will be used.</i></li>
* </ul>
*
* For more information about configuring the domain value and other aspects of Shaj,
......
......@@ -208,8 +208,8 @@ public class ClearspaceMUCEventDelegate extends MUCEventDelegate {
/**
* This event will be triggered when an entity attempts to destroy a room.
* <p/>
* Returns true if the user is allowed to destroy the room.
* <p>
* Returns true if the user is allowed to destroy the room.</p>
*
* @param roomName the name of the MUC room being destroyed.
* @param userjid the JID of the user attempting to destroy the room.
......
......@@ -54,6 +54,8 @@ import org.xmpp.packet.Message;
* the effective size as it will appear in a transcript-update packet).
*
* Example of a transcript-update packet:
* <pre>
* {@code
* <iq type='set' to='clearspace.example.org' from='clearspace-conference.example.org'>
* <transcript-update xmlns='http://jivesoftware.com/clearspace'>
* <presence from='user1@example.org'>
......@@ -88,7 +90,8 @@ import org.xmpp.packet.Message;
* ...
* </transcript-update>
* </iq>
*
* }
* </pre>
* @author Armando Jagucki
*/
public class ClearspaceMUCTranscriptManager implements MUCEventListener {
......
......@@ -112,7 +112,6 @@ import org.xmpp.packet.JID;
/**
* Centralized administration of Clearspace connections. The {@link #getInstance()} method
* should be used to get an instance. The following properties configure this manager:
* <p/>
* <ul>
* <li>clearspace.uri</li>
* <li>clearspace.sharedSecret</li>
......
......@@ -57,7 +57,7 @@ public class ClearspaceSaslServer implements SaslServer {
/**
* Evaluates the response data and generates a challenge.
* <p/>
* <p>
* If a response is received from the client during the authentication
* process, this method is called to prepare an appropriate next
* challenge to submit to the client. The challenge is null if the
......@@ -67,7 +67,7 @@ public class ClearspaceSaslServer implements SaslServer {
* succeeded but challenge data needs to be processed by the client.
* <tt>isComplete()</tt> should be called
* after each call to <tt>evaluateResponse()</tt>,to determine if any further
* response is needed from the client.
* response is needed from the client.</p>
*
* @param response The non-null (but possibly empty) response sent
* by the client.
......@@ -156,11 +156,11 @@ public class ClearspaceSaslServer implements SaslServer {
* the authentication exchange has negotiated integrity and/or privacy
* as the quality of protection; otherwise,
* an <tt>IllegalStateException</tt> is thrown.
* <p/>
* <p>
* <tt>incoming</tt> is the contents of the SASL buffer as defined in RFC 2222
* without the leading four octet field that represents the length.
* <tt>offset</tt> and <tt>len</tt> specify the portion of <tt>incoming</tt>
* to use.
* to use.</p>
*
* @param incoming A non-null byte array containing the encoded bytes
* from the client.
......@@ -184,12 +184,12 @@ public class ClearspaceSaslServer implements SaslServer {
* completed (i.e., when <tt>isComplete()</tt> returns true) and only if
* the authentication exchange has negotiated integrity and/or privacy
* as the quality of protection; otherwise, a <tt>SaslException</tt> is thrown.
* <p/>
* <p>
* The result of this method
* will make up the contents of the SASL buffer as defined in RFC 2222
* without the leading four octet field that represents the length.
* <tt>offset</tt> and <tt>len</tt> specify the portion of <tt>outgoing</tt>
* to use.
* to use.</p>
*
* @param outgoing A non-null byte array containing the bytes to encode.
* @param offset The starting position at <tt>outgoing</tt> of the bytes to use.
......
package org.jivesoftware.openfire.clearspace;
/**
* Provides a method to encode any string into a URL-safe
* form.
......@@ -8,7 +7,7 @@ package org.jivesoftware.openfire.clearspace;
* encoded as %HH escapes.
*
* Created: 17 April 1997
* Author: Bert Bos <bert@w3.org>
* Author: Bert Bos &lt;bert@w3.org&gt;
*
* URLUTF8Encoder: http://www.w3.org/International/URLUTF8Encoder.java
*
......@@ -22,7 +21,6 @@ package org.jivesoftware.openfire.clearspace;
*
* [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
*/
public class URLUTF8Encoder
{
......
......@@ -92,12 +92,15 @@ public class WSUtils {
/**
* Parse REST responses of the type String[], that are XML of the form:
* <p/>
* <pre>
* {@code
* <something>
* <return>text1</return>
* <return>text2</return>
* <return>text3</return>
* </something>
* }
* </pre>
*
* @param element Element from REST response to be parsed.
* @return An array of strings from the REST response.
......@@ -114,12 +117,15 @@ public class WSUtils {
/**
* Parse REST responses of the type String[] that represent usernames, that are XML of the form:
* <p/>
* <pre>
* {@code
* <something>
* <return>text1</return>
* <return>text2</return>
* <return>text3</return>
* </something>
* }
* </pre>
*
* @param element Element from REST response to be parsed.
* @return An array of strings from the REST response.
......
......@@ -166,10 +166,10 @@ public class ClusterManager {
* Triggers event indicating that this JVM is now part of a cluster. At this point the
* {@link org.jivesoftware.openfire.XMPPServer#getNodeID()} holds the new nodeID value and
* the old nodeID value is passed in case the listener needs it.<p>
* <p/>
* <p>
* When joining the cluster as the senior cluster member the {@link #fireMarkedAsSeniorClusterMember()}
* event will be sent right after this event.<p>
* <p/>
* event will be sent right after this event.
* </p>
* This event will be triggered in another thread. This will avoid potential deadlocks
* in Coherence.
*
......@@ -256,16 +256,16 @@ public class ClusterManager {
/**
* Triggers event indicating that this JVM is now the senior cluster member. This
* could either happen when initially joining the cluster or when the senior cluster
* member node left the cluster and this JVM was marked as the new senior cluster member.<p>
* <p/>
* member node left the cluster and this JVM was marked as the new senior cluster member.
* <p>
* Moreover, in the case of a "split brain" scenario (ie. separated cluster islands) each
* island will have its own senior cluster member. However, when the islands meet again there
* could only be one senior cluster member so one of the senior cluster members will stop playing
* that role. When that happens the JVM no longer playing that role will receive the
* {@link #fireLeftCluster()} and {@link #fireJoinedCluster(boolean)} events.<p>
* <p/>
* {@link #fireLeftCluster()} and {@link #fireJoinedCluster(boolean)} events.</p>
* <p>
* This event will be triggered in another thread. This will avoid potential deadlocks
* in Coherence.
* in Coherence.</p>
*/
public static void fireMarkedAsSeniorClusterMember() {
try {
......
......@@ -33,6 +33,7 @@ import org.slf4j.LoggerFactory;
* and optional parameters, as follows:<p>
*
* <table border="1">
* <caption></caption>
* <tr><th>Event Type</th><th>Extra Params</th></tr>
* <tr><td>{@link EventType#group_created group_created}</td><td><i>None</i></td></tr>
* <tr><td>{@link EventType#group_deleting group_deleting}</td><td><i>None</i></td></tr>
......@@ -45,7 +46,9 @@ import org.slf4j.LoggerFactory;
* <tr><td>{@link EventType#admin_removed admin_removed}</td><td>A param named <tt>admin</tt> with a String username
* as a payload</td></tr>
* <tr valign="top"><td>{@link EventType#group_modified group_modified}</td><td>
* <table><tr><td><b>Reason</b></td><td><b>Key</b></td><td><b>Value</b></td></tr>
* <table>
* <caption></caption>
* <tr><td><b>Reason</b></td><td><b>Key</b></td><td><b>Value</b></td></tr>
* <tr><td colspan="3">Name modified</td></tr>
* <tr><td>&nbsp;</td><td>type</td><td>nameModified</td></tr>
* <tr><td>&nbsp;</td><td>originalValue</td><td><i>(Name before it was modified)</i>
......
......@@ -33,11 +33,14 @@ import org.slf4j.LoggerFactory;
* and optional parameters, as follows:<p>
*
* <table border="1">
* <caption></caption>
* <tr><th>Event Type</th><th>Extra Params</th></tr>
* <tr><td>{@link EventType#user_created user_created}</td><td><i>None</i></td></tr>
* <tr><td>{@link EventType#user_deleting user_deleting}</td><td><i>None</i></td></tr>
* <tr valign="top"><td>{@link EventType#user_modified user_modified}</td><td>
* <table><tr><td><b>Reason</b></td><td><b>Key</b></td><td><b>Value</b></td></tr>
* <table>
* <caption></caption>
* <tr><td><b>Reason</b></td><td><b>Key</b></td><td><b>Value</b></td></tr>
* <tr><td colspan="3">Name modified</td></tr>
* <tr><td>&nbsp;</td><td>type</td><td>nameModified</td></tr>
* <tr><td>&nbsp;</td><td>originalValue</td><td><i>(Name before it was modified)</i></td></tr>
......
......@@ -30,7 +30,7 @@ import org.dom4j.QName;
/**
* A concrete DataForm capable of sending itself to a writer and recover its state from an XMPP
* stanza. XDataForms are packets of the form:
* <code><pre>
* <pre><code>
* &lt;x xmlns='jabber:x:data' type='{form-type}'&gt;
* &lt;title/&gt;
* &lt;instructions/&gt;
......@@ -44,11 +44,10 @@ import org.dom4j.QName;
* &lt;option label='option-label'&gt;&lt;value&gt;option-value&lt;/value&gt;&lt;/option&gt;
* &lt;/field&gt;
* &lt;/x&gt;
* </pre></code>
* <p/>
* An XDataFormImpl can contain zero or more XFormFieldImpl 'field' fragments.<p>
* <p/>
* To learn more follow this link: <a href="http://www.jabber.org/jeps/jep-0004.html">JEP-04</a>.
* </code></pre>
* An XDataFormImpl can contain zero or more XFormFieldImpl 'field' fragments.
* <p>
* To learn more follow this link: <a href="http://www.jabber.org/jeps/jep-0004.html">JEP-04</a>.</p>
*
* @author gdombiak
* @deprecated replaced by {@link org.xmpp.forms.DataForm}
......
......@@ -41,13 +41,13 @@ import org.xmpp.packet.StreamError;
/**
* Binds a resource to the stream so that the client's address becomes a full JID. Once a resource
* has been binded to the session the entity (i.e. client) is considered a "connected resource".<p>
* <p/>
* has been binded to the session the entity (i.e. client) is considered a "connected resource".
* <p>
* Clients may specify a desired resource but if none was specified then the server will create
* a random resource for the session. The new resource should be in accordance with ResourcePrep.
* The server will also verify if there are previous sessions from the same user that are already
* using the resource specified by the user. Depending on the server configuration the old session
* may be kicked or the new session may be rejected.
* may be kicked or the new session may be rejected.</p>
*
* @author Gaston Dombiak
*/
......
......@@ -38,19 +38,19 @@ import java.util.List;
* use this protocol to store and retrieve arbitrary application
* configuration information. Using the server for setting storage
* allows client configurations to follow users where ever they go.
* <p/>
* <p>
* A 'get' query retrieves any stored data.
* A 'set' query stores new data.
* <p/>
* </p>
* <p>
* Currently an empty implementation to allow usage with normal
* clients. Future implementation needed.
* <p/>
* </p>
* <h2>Assumptions</h2>
* This handler assumes that the request is addressed to the server.
* An appropriate TYPE_IQ tag matcher should be placed in front of this
* one to route TYPE_IQ requests not addressed to the server to
* another channel (probably for direct delivery to the recipient).
* <p/>
* <h2>Warning</h2>
* There should be a way of determining whether a session has
* authorization to access this feature. I'm not sure it is a good
......
......@@ -60,14 +60,11 @@ import org.xmpp.packet.StreamError;
* for registration. Return the registration form.
* A 'set' query attempts to create a new user account
* with information given in the registration form.
* <p/>
* <h2>Assumptions</h2>
* This handler assumes that the request is addressed to the server.
* An appropriate TYPE_IQ tag matcher should be placed in front of this
* one to route TYPE_IQ requests not addressed to the server to
* another channel (probably for direct delivery to the recipient).
* <p/>
* <h2>Compatibility</h2>
* The current behavior is designed to emulate jabberd1.4. However
* this behavior differs significantly from JEP-0078 (non-SASL registration).
......
......@@ -54,21 +54,20 @@ import org.xmpp.packet.PacketError;
* and iq:roster packets, while the client maintains the user
* interface aspects of rosters such as organizing roster
* entries into groups.
* <p/>
* <p>
* A 'get' query retrieves a snapshot of the roster.
* A 'set' query updates the roster (typically with new group info).
* The server sends 'set' updates asynchronously when roster
* entries change status.
* <p/>
* </p>
* <p>
* Currently an empty implementation to allow usage with normal
* clients. Future implementation needed.
* <p/>
* clients. Future implementation needed.</p>
* <h2>Assumptions</h2>
* This handler assumes that the request is addressed to the server.
* An appropriate TYPE_IQ tag matcher should be placed in front of this
* one to route TYPE_IQ requests not addressed to the server to
* another channel (probably for direct delivery to the recipient).
* <p/>
* <h2>Warning</h2>
* There should be a way of determining whether a session has
* authorization to access this feature. I'm not sure it is a good
......
......@@ -37,13 +37,11 @@ import java.util.Iterator;
* Implements the TYPE_IQ jabber:iq:time protocol (time info) as
* as defined by JEP-0090. Allows Jabber entities to query each
* other's local time. The server will respond with its local time.
* <p/>
* <h2>Assumptions</h2>
* This handler assumes that the time request is addressed to itself.
* An appropriate TYPE_IQ tag matcher should be placed in front of this
* one to route TYPE_IQ time requests not addressed to the server to
* another channel (probably for direct delivery to the recipient).
* <p/>
* <h2>Warning</h2>
* There should be a way of determining whether a session has
* authorization to access this feature. I'm not sure it is a good
......
......@@ -42,25 +42,24 @@ import org.xmpp.packet.PacketError;
* Implements the TYPE_IQ vcard-temp protocol. Clients
* use this protocol to set and retrieve the vCard information
* associated with someone's account.
* <p/>
* <p>
* A 'get' query retrieves the vcard for the addressee.
* A 'set' query sets the vcard information for the sender's account.
* <p/>
* </p>
* <p>
* Currently an empty implementation to allow usage with normal
* clients. Future implementation needed.
* <p/>
* </p>
* <h2>Assumptions</h2>
* This handler assumes that the request is addressed to the server.
* An appropriate TYPE_IQ tag matcher should be placed in front of this
* one to route TYPE_IQ requests not addressed to the server to
* another channel (probably for direct delivery to the recipient).
* <p/>
* <h2>Warning</h2>
* There should be a way of determining whether a session has
* authorization to access this feature. I'm not sure it is a good
* idea to do authorization in each handler. It would be nice if
* the framework could assert authorization policies across channels.
* <p/>
* <h2>Warning</h2>
* I have noticed incompatibility between vCard XML used by Exodus and Psi.
* There is a new vCard standard going through the JSF JEP process. We might
......
......@@ -49,13 +49,13 @@ import org.xmpp.packet.Presence;
/**
* Implements the presence protocol. Clients use this protocol to
* update presence and roster information.
* <p/>
* <p>
* The handler must properly detect the presence type, update the user's roster,
* and inform presence subscribers of the session's updated presence
* status. Presence serves many purposes in Jabber so this handler will
* likely be the most complex of all handlers in the server.
* <p/>
* There are four basic types of presence updates:
* likely be the most complex of all handlers in the server.</p>
* <p>
* There are four basic types of presence updates:</p>
* <ul>
* <li>Simple presence updates - addressed to the server (or to address), these updates
* are properly addressed by the server, and multicast to
......@@ -81,7 +81,6 @@ import org.xmpp.packet.Presence;
* for a presence update broadcast from the other server or tracking them
* as they are received. Requires S2S capabilities.
* </ul>
* <p/>
* <h2>Warning</h2>
* There should be a way of determining whether a session has
* authorization to access this feature. I'm not sure it is a good
......
......@@ -62,13 +62,15 @@ import org.xmpp.packet.Presence;
/**
* Implements the presence protocol. Clients use this protocol to
* update presence and roster information.
* <p/>
* <p>
* The handler must properly detect the presence type, update the user's roster,
* and inform presence subscribers of the session's updated presence
* status. Presence serves many purposes in Jabber so this handler will
* likely be the most complex of all handlers in the server.
* <p/>
* </p>
* <p>
* There are four basic types of presence updates:
* </p>
* <ul>
* <li>Simple presence updates - addressed to the server (or to address), these updates
* are properly addressed by the server, and multicast to
......
......@@ -44,7 +44,7 @@ import org.slf4j.LoggerFactory;
* <li><tt>ldap.princField = k5login</tt></li>
* <li><tt>ldap.princSearchFilter = princField={0}</tt></li>
* </ul>
* <p/>
* <p>
* Each ldap object that represents a user is expcted to have exactly one of
* ldap.usernameField and ldap.princField, and they are both expected to be unique
* over the search base. A search will be performed over all objects where
......@@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory;
* If more control over the search is needed, you can specify the mapSearchFilter
* used to perform the LDAP query.
* This implementation requires that LDAP be configured, obviously.
*
* </p>
*
* @author Jay Kline
*/
......
......@@ -48,25 +48,25 @@ import org.slf4j.LoggerFactory;
import org.xmpp.packet.JID;
/**
* Read-only LDAP provider for vCards.Configuration consists of adding a provider:<p/>
*
* Read-only LDAP provider for vCards.Configuration consists of adding a provider:
* <p>
* <tt>provider.vcard.className = org.jivesoftware.openfire.ldap.LdapVCardProvider</tt>
*
* and an xml vcard-mapping in the system properties.<p/>
*
* </p>
* <p>and an xml vcard-mapping in the system properties.</p>
* <p>
* The vcard attributes can be configured by adding an <code>attrs="attr1,attr2"</code>
* attribute to the vcard elements.<p/>
*
* attribute to the vcard elements.</p>
* <p>
* Arbitrary text can be used for the element values as well as <code>MessageFormat</code>
* style placeholders for the ldap attributes. For example, if you wanted to map the LDAP
* attribute <code>displayName</code> to the vcard element <code>FN</code>, the xml
* nippet would be:<br><pre>&lt;FN attrs=&quot;displayName&quot;&gt;{0}&lt;/FN&gt;</pre><p/>
*
* nippet would be:</p><br><pre>&lt;FN attrs=&quot;displayName&quot;&gt;{0}&lt;/FN&gt;</pre>
* <p>
* The vCard XML must be escaped in CDATA and must also be well formed. It is the exact
* XML this provider will send to a client after after stripping <code>attr</code> attributes
* and populating the placeholders with the data retrieved from LDAP. This system should
* be flexible enough to handle any client's vCard format. An example mapping follows.<br>
*
* </p>
* <tt>ldap.vcard-mapping =
* &lt;![CDATA[
* &lt;vCard xmlns='vcard-temp'&gt;
......@@ -104,11 +104,11 @@ import org.xmpp.packet.JID;
* &lt;/vCard&gt;
* ]]&gt;
* </tt>
* <p/>
* <p>
* An easy way to get the vcard format your client needs, assuming you've been
* using the database store, is to do a <code>SELECT value FROM ofVCard WHERE
* username='some_user'</code> in your favorite sql querier and paste the result
* into the <code>vcard-mapping</code> (don't forget the CDATA).
* into the <code>vcard-mapping</code> (don't forget the CDATA).</p>
*
* @author rkelly
*/
......
......@@ -37,8 +37,8 @@ import java.util.*;
* This class adds jabber:iq:search combined with 'result set management'
* functionality to the MUC service of Openfire.
*
* @author Guus der Kinderen - Nimbuzz B.V. <guus@nimbuzz.com>
* @author Giancarlo Frison - Nimbuzz B.V. <giancarlo@nimbuzz.com>
* @author Guus der Kinderen - Nimbuzz B.V. &lt;guus@nimbuzz.com&gt;
* @author Giancarlo Frison - Nimbuzz B.V. &lt;giancarlo@nimbuzz.com&gt;
*/
public class IQMUCSearchHandler
{
......@@ -370,7 +370,7 @@ public class IQMUCSearchHandler
/**
* Checks if the room may be included in search results. This is almost
* identical to {@link MultiUserChatServiceImpl#canDiscoverRoom(MUCRoom room)},
* identical to {@link MultiUserChatServiceImpl#canDiscoverRoom(org.jivesoftware.openfire.muc.MUCRoom, org.xmpp.packet.JID)},
* but that method is private and cannot be re-used here.
*
* @param room
......
......@@ -32,6 +32,7 @@ import org.slf4j.LoggerFactory;
* and optional parameters, as follows:<p>
*
* <table border="1">
* <caption></caption>
* <tr><th>Event Type</th><th>Extra Params</th></tr>
* <tr><td>{@link EventType#property_set property_set}</td><td>A param named <tt>value</tt> that
* has the value of the property set.</td></tr>
......
......@@ -82,14 +82,14 @@ import org.xmpp.resultsetmanagement.ResultSet;
* responsible for responding Multi-User Chat disco requests as well as removing inactive users from
* the rooms after a period of time and to maintain a log of the conversation in the rooms that
* require to log their conversations. The conversations log is saved to the database using a
* separate process<p>
* <p/>
* separate process.
* <p>
* Temporary rooms are held in memory as long as they have occupants. They will be destroyed after
* the last occupant left the room. On the other hand, persistent rooms are always present in memory
* even after the last occupant left the room. In order to keep memory clean of persistent rooms that
* have been forgotten or abandoned this class includes a clean up process. The clean up process
* will remove from memory rooms that haven't had occupants for a while. Moreover, forgotten or
* abandoned rooms won't be loaded into memory when the Multi-User Chat service starts up.
* abandoned rooms won't be loaded into memory when the Multi-User Chat service starts up.</p>
*
* @author Gaston Dombiak
*/
......
......@@ -39,10 +39,10 @@ import org.xmpp.packet.PacketError;
/**
* IQ packets sent from Connection Managers themselves to the server will be handled by
* instances of this class.<p>
* <p/>
* instances of this class.
* <p>
* This class will interact with {@link ConnectionMultiplexerManager} to create, close or
* get client sessions.
* get client sessions.</p>
*
* @author Gaston Dombiak
*/
......
......@@ -34,10 +34,11 @@ import javax.net.ssl.X509KeyManager;
* A skeleton placeholder for developers wishing to implement their own custom
* key manager. In future revisions we may expand the skeleton code if customers
* request assistance in creating custom key managers.
* <p/>
* <p>
* The key manager is an essential part of server SSL support. Typically you
* will implement a custom key manager to retrieve certificates from repositories
* that are not of standard Java types (e.g. obtaining them from LDAP or a JDBC database).
* </p>
*
* @author Iain Shigeoka
*/
......
......@@ -33,14 +33,14 @@ import javax.net.ssl.X509TrustManager;
/**
* Trust manager which accepts certificates without any validation
* except date validation.
* <p/>
* <p>
* A skeleton placeholder for developers wishing to implement their own custom
* trust manager. In future revisions we may expand the skeleton code if customers
* request assistance in creating custom trust managers.
* <p/>
* request assistance in creating custom trust managers.</p>
* <p>
* You only need a trust manager if your server will require clients
* to authenticated with the server (typically only the server authenticates
* with the client).
* with the client).</p>
*
* @author Iain Shigeoka
*/
......
......@@ -38,12 +38,12 @@ import org.slf4j.LoggerFactory;
* default trust manager or a standard keystore as specified in openfire.xml.
* There is no default trust keystore provided with the Jive distribution as most
* clients will not need to be authenticated with the server.
* <p/>
* <p>
* The Java Keystore (JKS) takes a single password which must apply to both the
* keystore and the key itself. Users may specify another keystore type and keystore
* location. Alternatively, don't set a keystore type to use the JVM defaults and
* configure your JVMs security files (see your JVM documentation) to plug in
* any TrustManagerFactory provider.
* any TrustManagerFactory provider.</p>
*
* @author Iain Shigeoka
*/
......
......@@ -316,11 +316,11 @@ public abstract class StanzaHandler {
/**
* Process the received IQ packet. Registered
* {@link org.jivesoftware.openfire.interceptor.PacketInterceptor} will be invoked before
* and after the packet was routed.<p>
* <p/>
* and after the packet was routed.
* <p>
* Subclasses may redefine this method for different reasons such as modifying the sender
* of the packet to avoid spoofing, rejecting the packet or even process the packet in
* another thread.
* another thread.</p>
*
* @param packet the received packet.
* @throws org.jivesoftware.openfire.auth.UnauthorizedException
......@@ -334,11 +334,11 @@ public abstract class StanzaHandler {
/**
* Process the received Presence packet. Registered
* {@link org.jivesoftware.openfire.interceptor.PacketInterceptor} will be invoked before
* and after the packet was routed.<p>
* <p/>
* and after the packet was routed.
* <p>
* Subclasses may redefine this method for different reasons such as modifying the sender
* of the packet to avoid spoofing, rejecting the packet or even process the packet in
* another thread.
* another thread.</p>
*
* @param packet the received packet.
* @throws org.jivesoftware.openfire.auth.UnauthorizedException
......@@ -352,11 +352,11 @@ public abstract class StanzaHandler {
/**
* Process the received Message packet. Registered
* {@link org.jivesoftware.openfire.interceptor.PacketInterceptor} will be invoked before
* and after the packet was routed.<p>
* <p/>
* and after the packet was routed.
* <p>
* Subclasses may redefine this method for different reasons such as modifying the sender
* of the packet to avoid spoofing, rejecting the packet or even process the packet in
* another thread.
* another thread.</p>
*
* @param packet the received packet.
* @throws org.jivesoftware.openfire.auth.UnauthorizedException
......@@ -663,7 +663,7 @@ public abstract class StanzaHandler {
*
* Note that the value that is returned for this method can
* change over time. For example, if no session has been established yet,
* this method will return </tt>null</tt>, or, if resource binding occurs,
* this method will return <tt>null</tt>, or, if resource binding occurs,
* the returned value might change. Values obtained from this method are
* therefore best <em>not</em> cached.
*
......
......@@ -85,12 +85,11 @@ import org.xmpp.packet.Presence;
* <p>
*
* <p>
* This handler is used for the following namespaces:
* This handler is used for the following namespaces:</p>
* <ul>
* <li><i>http://jabber.org/protocol/pubsub</i></li>
* <li><i>http://jabber.org/protocol/pubsub#owner</i></li>
* </ul>
* </p>
*
* @author Armando Jagucki
* @author Guus der Kinderen, guus.der.kinderen@gmail.com
......
......@@ -112,7 +112,7 @@ public class PEPService implements PubSubService, Cacheable {
* a node of the pep service and for which the node only delivers
* notifications for online users or node subscriptions deliver events based
* on the user presence show value. Offline users will not have an entry in
* the map. Note: Key-> bare JID and Value-> Map whose key is full JID of
* the map. Note: Key-&gt; bare JID and Value-&gt; Map whose key is full JID of
* connected resource and value is show value of the last received presence.
*/
private Map<String, Map<String, String>> barePresences = new ConcurrentHashMap<String, Map<String, String>>();
......
......@@ -37,12 +37,12 @@ public interface Result {
* Returns a unique identifier for this Result. Each element in a ResultSet
* must have a distinct UIDs.
*
* XEP-0059 says: <quote>(...) the UIDs are
* XEP-0059 says: <i>(...) the UIDs are
* unique in the context of all possible members of the full result set.
* Each UID MAY be based on part of the content of its associated item (...)
* or on an internal table index. Another possible method is to serialize
* the XML of the item and then hash it to generate the UID. Note: The
* requesting entity MUST treat all UIDs as opaque.</quote>
* requesting entity MUST treat all UIDs as opaque.</i>
*
* @return Unique ID of the Result
*/
......
......@@ -36,9 +36,9 @@ import javax.security.auth.callback.UnsupportedCallbackException;
/**
* Implements the PLAIN server-side mechanism.
* (<a href="http://www.ietf.org/rfc/rfc4616.txt">RFC 4616</a>)<br />
* (<a href="http://www.ietf.org/rfc/rfc4616.txt">RFC 4616</a>)<br>
* <p>
* client ----- {authzid, authcid, password} -----> server
* client ----- {authzid, authcid, password} -----&gt; server
* </p>
* Each paramater sent to the server is seperated by a null character
* The authorization ID (authzid) may be empty.
......
......@@ -53,7 +53,6 @@ public class XMPPServerInfoImpl implements XMPPServerInfo {
* @param version the server's version number.
* @param startDate the server's last start time (can be null indicating
* it hasn't been started).
* @param connectionManager the object that keeps track of the active ports.
*/
public XMPPServerInfoImpl(String xmppDomain, String hostname, Version version, Date startDate) {
this.xmppDomain = xmppDomain;
......
......@@ -63,10 +63,10 @@ import org.xmpp.packet.Message;
/**
* Service that frequently checks for new server or plugins releases. By default the service
* will check every 48 hours for updates. Use the system property <tt>update.frequency</tt>
* to set new values.<p>
* <p/>
* to set new values.
* <p>
* New versions of plugins can be downloaded and installed. However, new server releases
* should be manually installed.
* should be manually installed.</p>
*
* @author Gaston Dombiak
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment