Skip to content

O
Openfire
Commit dcea025c authored by Guus der Kinderen's avatar Guus der Kinderen
Browse files
Options

Remove redundant modifiers on interfaces or interface components. 

These add nothing, but warnings in tooling.
parent 10149310
Hide whitespace changes
Inline Side-by-side
Showing with 422 additions and 422 deletions
src/java/org/jivesoftware/admin/PluginFilter.java
View file @ dcea025c
...@@ -263,7 +263,7 @@ public class PluginFilter implements Filter { ...@@ -263,7 +263,7 @@ public class PluginFilter implements Filter {
* @throws ServletException if a servlet exception occurs. * @throws ServletException if a servlet exception occurs.
* @return true if further filters in the chain should be run. * @return true if further filters in the chain should be run.
*/ */
public boolean doFilter(ServletRequest request, ServletResponse response) boolean doFilter( ServletRequest request, ServletResponse response )
throws IOException, ServletException; throws IOException, ServletException;
} }
......
src/java/org/jivesoftware/database/ConnectionProvider.java
View file @ dcea025c
...@@ -39,7 +39,7 @@ public interface ConnectionProvider { ...@@ -39,7 +39,7 @@ public interface ConnectionProvider {
* @return true if the Connection objects returned by this provider are * @return true if the Connection objects returned by this provider are
* pooled. * pooled.
*/ */
public boolean isPooled(); boolean isPooled();
/** /**
* Returns a database connection. When a Jive component is done with a * Returns a database connection. When a Jive component is done with a
...@@ -52,20 +52,20 @@ public interface ConnectionProvider { ...@@ -52,20 +52,20 @@ public interface ConnectionProvider {
* @return a Connection object. * @return a Connection object.
* @throws SQLException is an SQL error occured while retrieving the connection. * @throws SQLException is an SQL error occured while retrieving the connection.
*/ */
public Connection getConnection() throws SQLException; Connection getConnection() throws SQLException;
/** /**
* Starts the connection provider. For some connection providers, this * Starts the connection provider. For some connection providers, this
* will be a no-op. However, connection provider users should always call * will be a no-op. However, connection provider users should always call
* this method to make sure the connection provider is started. * this method to make sure the connection provider is started.
*/ */
public void start(); void start();
/** /**
* This method should be called whenever properties have been changed so * This method should be called whenever properties have been changed so
* that the changes will take effect. * that the changes will take effect.
*/ */
public void restart(); void restart();
/** /**
* Tells the connection provider to destroy itself. For many connection * Tells the connection provider to destroy itself. For many connection
...@@ -74,5 +74,5 @@ public interface ConnectionProvider { ...@@ -74,5 +74,5 @@ public interface ConnectionProvider {
* from one connection provider to another to ensure that there are no * from one connection provider to another to ensure that there are no
* dangling database connections. * dangling database connections.
*/ */
public void destroy(); void destroy();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/ChannelHandler.java
View file @ dcea025c
...@@ -34,5 +34,5 @@ public interface ChannelHandler<T extends Packet> { ...@@ -34,5 +34,5 @@ public interface ChannelHandler<T extends Packet> {
* @throws PacketException thrown if the packet is malformed (results in the sender's * @throws PacketException thrown if the packet is malformed (results in the sender's
* session being shutdown). * session being shutdown).
*/ */
public abstract void process(T packet) throws UnauthorizedException, PacketException; void process( T packet ) throws UnauthorizedException, PacketException;
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/Connection.java
View file @ dcea025c
...@@ -38,7 +38,7 @@ public interface Connection extends Closeable { ...@@ -38,7 +38,7 @@ public interface Connection extends Closeable {
* *
* @return true if the socket remains valid, false otherwise. * @return true if the socket remains valid, false otherwise.
*/ */
public boolean validate(); boolean validate();
/** /**
* Initializes the connection with it's owning session. Allows the * Initializes the connection with it's owning session. Allows the
...@@ -47,7 +47,7 @@ public interface Connection extends Closeable { ...@@ -47,7 +47,7 @@ public interface Connection extends Closeable {
* *
* @param session the session that owns this connection * @param session the session that owns this connection
*/ */
public void init(LocalSession session); void init( LocalSession session );
/** /**
* Returns the raw IP address of this <code>InetAddress</code> * Returns the raw IP address of this <code>InetAddress</code>
...@@ -57,7 +57,7 @@ public interface Connection extends Closeable { ...@@ -57,7 +57,7 @@ public interface Connection extends Closeable {
* @return the raw IP address of this object. * @return the raw IP address of this object.
* @throws java.net.UnknownHostException if IP address of host could not be determined. * @throws java.net.UnknownHostException if IP address of host could not be determined.
*/ */
public byte[] getAddress() throws UnknownHostException; byte[] getAddress() throws UnknownHostException;
/** /**
* Returns the IP address string in textual presentation. * Returns the IP address string in textual presentation.
...@@ -65,7 +65,7 @@ public interface Connection extends Closeable { ...@@ -65,7 +65,7 @@ public interface Connection extends Closeable {
* @return the raw IP address in a string format. * @return the raw IP address in a string format.
* @throws java.net.UnknownHostException if IP address of host could not be determined. * @throws java.net.UnknownHostException if IP address of host could not be determined.
*/ */
public String getHostAddress() throws UnknownHostException; String getHostAddress() throws UnknownHostException;
/** /**
* Gets the host name for this IP address. * Gets the host name for this IP address.
...@@ -93,7 +93,7 @@ public interface Connection extends Closeable { ...@@ -93,7 +93,7 @@ public interface Connection extends Closeable {
* @see java.net.InetAddress#getCanonicalHostName * @see java.net.InetAddress#getCanonicalHostName
* @see SecurityManager#checkConnect * @see SecurityManager#checkConnect
*/ */
public String getHostName() throws UnknownHostException; String getHostName() throws UnknownHostException;
/** /**
* Returns the local underlying {@link javax.security.cert.X509Certificate} * Returns the local underlying {@link javax.security.cert.X509Certificate}
...@@ -103,7 +103,7 @@ public interface Connection extends Closeable { ...@@ -103,7 +103,7 @@ public interface Connection extends Closeable {
* first followed by any certificate authorities. If no certificates * first followed by any certificate authorities. If no certificates
* is present for the connection, then <tt>null</tt> is returned. * is present for the connection, then <tt>null</tt> is returned.
*/ */
public Certificate[] getLocalCertificates(); Certificate[] getLocalCertificates();
/** /**
* Returns the underlying {@link javax.security.cert.X509Certificate} for * Returns the underlying {@link javax.security.cert.X509Certificate} for
...@@ -112,7 +112,7 @@ public interface Connection extends Closeable { ...@@ -112,7 +112,7 @@ public interface Connection extends Closeable {
* @return an ordered array of peer certificates, with the peer's own * @return an ordered array of peer certificates, with the peer's own
* certificate first followed by any certificate authorities. * certificate first followed by any certificate authorities.
*/ */
public Certificate[] getPeerCertificates(); Certificate[] getPeerCertificates();
/** /**
* Keeps track if the other peer of this session presented a self-signed certificate. When * Keeps track if the other peer of this session presented a self-signed certificate. When
...@@ -122,7 +122,7 @@ public interface Connection extends Closeable { ...@@ -122,7 +122,7 @@ public interface Connection extends Closeable {
* *
* @param isSelfSigned true if the other peer presented a self-signed certificate. * @param isSelfSigned true if the other peer presented a self-signed certificate.
*/ */
public void setUsingSelfSignedCertificate(boolean isSelfSigned); void setUsingSelfSignedCertificate( boolean isSelfSigned );
/** /**
* Returns true if the other peer of this session presented a self-signed certificate. When * Returns true if the other peer of this session presented a self-signed certificate. When
...@@ -132,7 +132,7 @@ public interface Connection extends Closeable { ...@@ -132,7 +132,7 @@ public interface Connection extends Closeable {
* *
* @return true if the other peer of this session presented a self-signed certificate. * @return true if the other peer of this session presented a self-signed certificate.
*/ */
public boolean isUsingSelfSignedCertificate(); boolean isUsingSelfSignedCertificate();
/** /**
* Close this session including associated socket connection. The order of * Close this session including associated socket connection. The order of
...@@ -147,28 +147,28 @@ public interface Connection extends Closeable { ...@@ -147,28 +147,28 @@ public interface Connection extends Closeable {
* (idempotent, try-with-resources, etc.) * (idempotent, try-with-resources, etc.)
*/ */
@Override @Override
public void close(); void close();
/** /**
* Notification message indicating that the server is being shutdown. Implementors * Notification message indicating that the server is being shutdown. Implementors
* should send a stream error whose condition is system-shutdown before closing * should send a stream error whose condition is system-shutdown before closing
* the connection. * the connection.
*/ */
public void systemShutdown(); void systemShutdown();
/** /**
* Returns true if the connection/session is closed. * Returns true if the connection/session is closed.
* *
* @return true if the connection is closed. * @return true if the connection is closed.
*/ */
public boolean isClosed(); boolean isClosed();
/** /**
* Returns true if this connection is secure. * Returns true if this connection is secure.
* *
* @return true if the connection is secure (e.g. SSL/TLS) * @return true if the connection is secure (e.g. SSL/TLS)
*/ */
public boolean isSecure(); boolean isSecure();
/** /**
* Registers a listener for close event notification. Registrations after * Registers a listener for close event notification. Registrations after
...@@ -181,7 +181,7 @@ public interface Connection extends Closeable { ...@@ -181,7 +181,7 @@ public interface Connection extends Closeable {
* @param listener the listener to register for events. * @param listener the listener to register for events.
* @param handbackMessage the object to send in the event notification. * @param handbackMessage the object to send in the event notification.
*/ */
public void registerCloseListener(ConnectionCloseListener listener, Object handbackMessage); void registerCloseListener( ConnectionCloseListener listener, Object handbackMessage );
/** /**
* Removes a registered close event listener. Registered listeners must * Removes a registered close event listener. Registered listeners must
...@@ -191,7 +191,7 @@ public interface Connection extends Closeable { ...@@ -191,7 +191,7 @@ public interface Connection extends Closeable {
* *
* @param listener the listener to deregister for close events. * @param listener the listener to deregister for close events.
*/ */
public void removeCloseListener(ConnectionCloseListener listener); void removeCloseListener( ConnectionCloseListener listener );
/** /**
* Delivers the packet to this connection without checking the recipient. * Delivers the packet to this connection without checking the recipient.
...@@ -200,7 +200,7 @@ public interface Connection extends Closeable { ...@@ -200,7 +200,7 @@ public interface Connection extends Closeable {
* @param packet the packet to deliver. * @param packet the packet to deliver.
* @throws org.jivesoftware.openfire.auth.UnauthorizedException if a permission error was detected. * @throws org.jivesoftware.openfire.auth.UnauthorizedException if a permission error was detected.
*/ */
public void deliver(Packet packet) throws UnauthorizedException; void deliver( Packet packet ) throws UnauthorizedException;
/** /**
* Delivers raw text to this connection. This is a very low level way for sending * Delivers raw text to this connection. This is a very low level way for sending
...@@ -213,7 +213,7 @@ public interface Connection extends Closeable { ...@@ -213,7 +213,7 @@ public interface Connection extends Closeable {
* *
* @param text the XML stanzas represented kept in a String. * @param text the XML stanzas represented kept in a String.
*/ */
public void deliverRawText(String text); void deliverRawText( String text );
/** /**
* Returns true if the connected client is a flash client. Flash clients need * Returns true if the connected client is a flash client. Flash clients need
...@@ -223,7 +223,7 @@ public interface Connection extends Closeable { ...@@ -223,7 +223,7 @@ public interface Connection extends Closeable {
* *
* @return true if the connected client is a flash client. * @return true if the connected client is a flash client.
*/ */
public boolean isFlashClient(); boolean isFlashClient();
/** /**
* Sets whether the connected client is a flash client. Flash clients need to * Sets whether the connected client is a flash client. Flash clients need to
...@@ -233,7 +233,7 @@ public interface Connection extends Closeable { ...@@ -233,7 +233,7 @@ public interface Connection extends Closeable {
* *
* @param flashClient true if the if the connection is a flash client. * @param flashClient true if the if the connection is a flash client.
*/ */
public void setFlashClient(boolean flashClient); void setFlashClient( boolean flashClient );
/** /**
* Returns the major version of XMPP being used by this connection * Returns the major version of XMPP being used by this connection
...@@ -243,7 +243,7 @@ public interface Connection extends Closeable { ...@@ -243,7 +243,7 @@ public interface Connection extends Closeable {
* *
* @return the major XMPP version being used by this connection. * @return the major XMPP version being used by this connection.
*/ */
public int getMajorXMPPVersion(); int getMajorXMPPVersion();
/** /**
* Returns the minor version of XMPP being used by this connection * Returns the minor version of XMPP being used by this connection
...@@ -253,7 +253,7 @@ public interface Connection extends Closeable { ...@@ -253,7 +253,7 @@ public interface Connection extends Closeable {
* *
* @return the minor XMPP version being used by this connection. * @return the minor XMPP version being used by this connection.
*/ */
public int getMinorXMPPVersion(); int getMinorXMPPVersion();
/** /**
* Sets the XMPP version information. In most cases, the version should be "1.0". * Sets the XMPP version information. In most cases, the version should be "1.0".
...@@ -263,7 +263,7 @@ public interface Connection extends Closeable { ...@@ -263,7 +263,7 @@ public interface Connection extends Closeable {
* @param majorVersion the major version. * @param majorVersion the major version.
* @param minorVersion the minor version. * @param minorVersion the minor version.
*/ */
public void setXMPPVersion(int majorVersion, int minorVersion); void setXMPPVersion( int majorVersion, int minorVersion );
/** /**
* Returns true if the connection is using compression. * Returns true if the connection is using compression.
......
src/java/org/jivesoftware/openfire/ConnectionCloseListener.java
View file @ dcea025c
...@@ -28,5 +28,5 @@ public interface ConnectionCloseListener { ...@@ -28,5 +28,5 @@ public interface ConnectionCloseListener {
* *
* @param handback The handback object associated with the connection listener during Connection.registerCloseListener() * @param handback The handback object associated with the connection listener during Connection.registerCloseListener()
*/ */
public void onConnectionClose(Object handback); void onConnectionClose( Object handback );
} }
src/java/org/jivesoftware/openfire/ConnectionManager.java
View file @ dcea025c
...@@ -30,36 +30,36 @@ public interface ConnectionManager { ...@@ -30,36 +30,36 @@ public interface ConnectionManager {
* and unsecured connections. Clients will initially connect using an unsecure * and unsecured connections. Clients will initially connect using an unsecure
* connection and may secure it by using StartTLS. * connection and may secure it by using StartTLS.
*/ */
final int DEFAULT_PORT = 5222; int DEFAULT_PORT = 5222;
/** /**
* The default legacy Jabber port for SSL traffic. This old method, and soon * The default legacy Jabber port for SSL traffic. This old method, and soon
* to be deprecated, uses encrypted connections as soon as they are created. * to be deprecated, uses encrypted connections as soon as they are created.
*/ */
final int DEFAULT_SSL_PORT = 5223; int DEFAULT_SSL_PORT = 5223;
/** /**
* The default XMPP port for external components. * The default XMPP port for external components.
*/ */
final int DEFAULT_COMPONENT_PORT = 5275; int DEFAULT_COMPONENT_PORT = 5275;
/** /**
* The XMPP port for external components using SSL traffic. * The XMPP port for external components using SSL traffic.
*/ */
final int DEFAULT_COMPONENT_SSL_PORT = 5276; int DEFAULT_COMPONENT_SSL_PORT = 5276;
/** /**
* The default XMPP port for server2server communication. * The default XMPP port for server2server communication.
*/ */
final int DEFAULT_SERVER_PORT = 5269; int DEFAULT_SERVER_PORT = 5269;
/** /**
* The default XMPP port for connection multiplex. * The default XMPP port for connection multiplex.
*/ */
final int DEFAULT_MULTIPLEX_PORT = 5262; int DEFAULT_MULTIPLEX_PORT = 5262;
/** /**
* The default XMPP port for connection multiplex. * The default XMPP port for connection multiplex.
*/ */
final int DEFAULT_MULTIPLEX_SSL_PORT = 5263; int DEFAULT_MULTIPLEX_SSL_PORT = 5263;
/** /**
* Returns an array of the ports managed by this connection manager. * Returns an array of the ports managed by this connection manager.
...@@ -67,7 +67,7 @@ public interface ConnectionManager { ...@@ -67,7 +67,7 @@ public interface ConnectionManager {
* @return an iterator of the ports managed by this connection manager * @return an iterator of the ports managed by this connection manager
* (can be an empty but never null). * (can be an empty but never null).
*/ */
public Collection<ServerPort> getPorts(); Collection<ServerPort> getPorts();
/** /**
* Sets if the port listener for unsecured clients will be available or not. When disabled * Sets if the port listener for unsecured clients will be available or not. When disabled
...@@ -76,7 +76,7 @@ public interface ConnectionManager { ...@@ -76,7 +76,7 @@ public interface ConnectionManager {
* *
* @param enabled true if new unsecured clients will be able to connect to the server. * @param enabled true if new unsecured clients will be able to connect to the server.
*/ */
public void enableClientListener(boolean enabled); void enableClientListener( boolean enabled );
/** /**
* Returns true if the port listener for unsecured clients is available. When disabled * Returns true if the port listener for unsecured clients is available. When disabled
...@@ -85,7 +85,7 @@ public interface ConnectionManager { ...@@ -85,7 +85,7 @@ public interface ConnectionManager {
* *
* @return true if the port listener for unsecured clients is available. * @return true if the port listener for unsecured clients is available.
*/ */
public boolean isClientListenerEnabled(); boolean isClientListenerEnabled();
/** /**
* Sets if the port listener for secured clients will be available or not. When disabled * Sets if the port listener for secured clients will be available or not. When disabled
...@@ -94,7 +94,7 @@ public interface ConnectionManager { ...@@ -94,7 +94,7 @@ public interface ConnectionManager {
* *
* @param enabled true if new secured clients will be able to connect to the server. * @param enabled true if new secured clients will be able to connect to the server.
*/ */
public void enableClientSSLListener(boolean enabled); void enableClientSSLListener( boolean enabled );
/** /**
* Returns true if the port listener for secured clients is available. When disabled * Returns true if the port listener for secured clients is available. When disabled
...@@ -103,7 +103,7 @@ public interface ConnectionManager { ...@@ -103,7 +103,7 @@ public interface ConnectionManager {
* *
* @return true if the port listener for unsecured clients is available. * @return true if the port listener for unsecured clients is available.
*/ */
public boolean isClientSSLListenerEnabled(); boolean isClientSSLListenerEnabled();
/** /**
* Sets if the port listener for external components will be available or not. When disabled * Sets if the port listener for external components will be available or not. When disabled
...@@ -112,7 +112,7 @@ public interface ConnectionManager { ...@@ -112,7 +112,7 @@ public interface ConnectionManager {
* *
* @param enabled true if new external components will be able to connect to the server. * @param enabled true if new external components will be able to connect to the server.
*/ */
public void enableComponentListener(boolean enabled); void enableComponentListener( boolean enabled );
/** /**
* Returns true if the port listener for external components is available. When disabled * Returns true if the port listener for external components is available. When disabled
...@@ -121,7 +121,7 @@ public interface ConnectionManager { ...@@ -121,7 +121,7 @@ public interface ConnectionManager {
* *
* @return true if the port listener for external components is available. * @return true if the port listener for external components is available.
*/ */
public boolean isComponentListenerEnabled(); boolean isComponentListenerEnabled();
/** /**
* Sets if the port listener for remote servers will be available or not. When disabled * Sets if the port listener for remote servers will be available or not. When disabled
...@@ -130,7 +130,7 @@ public interface ConnectionManager { ...@@ -130,7 +130,7 @@ public interface ConnectionManager {
* *
* @param enabled true if new remote servers will be able to connect to the server. * @param enabled true if new remote servers will be able to connect to the server.
*/ */
public void enableServerListener(boolean enabled); void enableServerListener( boolean enabled );
/** /**
* Returns true if the port listener for remote servers is available. When disabled * Returns true if the port listener for remote servers is available. When disabled
...@@ -139,7 +139,7 @@ public interface ConnectionManager { ...@@ -139,7 +139,7 @@ public interface ConnectionManager {
* *
* @return true if the port listener for remote servers is available. * @return true if the port listener for remote servers is available.
*/ */
public boolean isServerListenerEnabled(); boolean isServerListenerEnabled();
/** /**
* Sets if the port listener for connection managers will be available or not. When disabled * Sets if the port listener for connection managers will be available or not. When disabled
...@@ -148,7 +148,7 @@ public interface ConnectionManager { ...@@ -148,7 +148,7 @@ public interface ConnectionManager {
* *
* @param enabled true if new connection managers will be able to connect to the server. * @param enabled true if new connection managers will be able to connect to the server.
*/ */
public void enableConnectionManagerListener(boolean enabled); void enableConnectionManagerListener( boolean enabled );
/** /**
* Returns true if the port listener for connection managers is available. When disabled * Returns true if the port listener for connection managers is available. When disabled
...@@ -157,49 +157,49 @@ public interface ConnectionManager { ...@@ -157,49 +157,49 @@ public interface ConnectionManager {
* *
* @return true if the port listener for connection managers is available. * @return true if the port listener for connection managers is available.
*/ */
public boolean isConnectionManagerListenerEnabled(); boolean isConnectionManagerListenerEnabled();
/** /**
* Sets the port to use for unsecured clients. Default port: 5222. * Sets the port to use for unsecured clients. Default port: 5222.
* *
* @param port the port to use for unsecured clients. * @param port the port to use for unsecured clients.
*/ */
public void setClientListenerPort(int port); void setClientListenerPort( int port );
/** /**
* Returns the port to use for unsecured clients. Default port: 5222. * Returns the port to use for unsecured clients. Default port: 5222.
* *
* @return the port to use for unsecured clients. * @return the port to use for unsecured clients.
*/ */
public int getClientListenerPort(); int getClientListenerPort();
/** /**
* Sets the port to use for secured clients. Default port: 5223. * Sets the port to use for secured clients. Default port: 5223.
* *
* @param port the port to use for secured clients. * @param port the port to use for secured clients.
*/ */
public void setClientSSLListenerPort(int port); void setClientSSLListenerPort( int port );
/** /**
* Returns the port to use for secured clients. Default port: 5223. * Returns the port to use for secured clients. Default port: 5223.
* *
* @return the port to use for secured clients. * @return the port to use for secured clients.
*/ */
public int getClientSSLListenerPort(); int getClientSSLListenerPort();
/** /**
* Sets the port to use for external components. * Sets the port to use for external components.
* *
* @param port the port to use for external components. * @param port the port to use for external components.
*/ */
public void setComponentListenerPort(int port); void setComponentListenerPort( int port );
/** /**
* Returns the port to use for external components. * Returns the port to use for external components.
* *
* @return the port to use for external components. * @return the port to use for external components.
*/ */
public int getComponentListenerPort(); int getComponentListenerPort();
/** /**
* Sets the port to use for remote servers. This port is used for remote servers to connect * Sets the port to use for remote servers. This port is used for remote servers to connect
...@@ -207,7 +207,7 @@ public interface ConnectionManager { ...@@ -207,7 +207,7 @@ public interface ConnectionManager {
* *
* @param port the port to use for remote servers. * @param port the port to use for remote servers.
*/ */
public void setServerListenerPort(int port); void setServerListenerPort( int port );
/** /**
* Returns the port to use for remote servers. This port is used for remote servers to connect * Returns the port to use for remote servers. This port is used for remote servers to connect
...@@ -215,7 +215,7 @@ public interface ConnectionManager { ...@@ -215,7 +215,7 @@ public interface ConnectionManager {
* *
* @return the port to use for remote servers. * @return the port to use for remote servers.
*/ */
public int getServerListenerPort(); int getServerListenerPort();
/** /**
* Sets the port to use for connection managers. This port is used for connection managers * Sets the port to use for connection managers. This port is used for connection managers
...@@ -223,7 +223,7 @@ public interface ConnectionManager { ...@@ -223,7 +223,7 @@ public interface ConnectionManager {
* *
* @param port the port to use for connection managers. * @param port the port to use for connection managers.
*/ */
public void setConnectionManagerListenerPort(int port); void setConnectionManagerListenerPort( int port );
/** /**
* Returns the port to use for remote servers. This port is used for connection managers * Returns the port to use for remote servers. This port is used for connection managers
...@@ -231,5 +231,5 @@ public interface ConnectionManager { ...@@ -231,5 +231,5 @@ public interface ConnectionManager {
* *
* @return the port to use for connection managers. * @return the port to use for connection managers.
*/ */
public int getConnectionManagerListenerPort(); int getConnectionManagerListenerPort();
} }
src/java/org/jivesoftware/openfire/PacketDeliverer.java
View file @ dcea025c
...@@ -37,5 +37,5 @@ public interface PacketDeliverer { ...@@ -37,5 +37,5 @@ public interface PacketDeliverer {
* @param packet the packet to route * @param packet the packet to route
* @throws PacketException if the packet is null or the packet could not be routed. * @throws PacketException if the packet is null or the packet could not be routed.
*/ */
public void deliver(Packet packet) throws UnauthorizedException, PacketException; void deliver( Packet packet ) throws UnauthorizedException, PacketException;
} }
src/java/org/jivesoftware/openfire/PresenceManager.java
View file @ dcea025c
...@@ -37,12 +37,12 @@ public interface PresenceManager { ...@@ -37,12 +37,12 @@ public interface PresenceManager {
/** /**
* Sort by username. * Sort by username.
*/ */
public static final int SORT_USERNAME = 0; int SORT_USERNAME = 0;
/** /**
* Sort by online time. * Sort by online time.
*/ */
public static final int SORT_ONLINE_TIME = 1; int SORT_ONLINE_TIME = 1;
/** /**
* <p>Returns the availability of the user.<p> * <p>Returns the availability of the user.<p>
...@@ -50,7 +50,7 @@ public interface PresenceManager { ...@@ -50,7 +50,7 @@ public interface PresenceManager {
* @param user the user who's availability is in question * @param user the user who's availability is in question
* @return true if the user as available for messaging (1 or more available sessions) * @return true if the user as available for messaging (1 or more available sessions)
*/ */
public boolean isAvailable(User user); boolean isAvailable( User user );
/** /**
* Returns the user's current presence, or <tt>null</tt> if the user is unavailable. * Returns the user's current presence, or <tt>null</tt> if the user is unavailable.
...@@ -60,7 +60,7 @@ public interface PresenceManager { ...@@ -60,7 +60,7 @@ public interface PresenceManager {
* @param user the user. * @param user the user.
* @return the user's current presence. * @return the user's current presence.
*/ */
public Presence getPresence(User user); Presence getPresence( User user );
/** /**
* Returns all presences for the user, or <tt>null</tt> if the user is unavailable. * Returns all presences for the user, or <tt>null</tt> if the user is unavailable.
...@@ -68,7 +68,7 @@ public interface PresenceManager { ...@@ -68,7 +68,7 @@ public interface PresenceManager {
* @param username the name of the user. * @param username the name of the user.
* @return the Presence packets for all the users's connected sessions. * @return the Presence packets for all the users's connected sessions.
*/ */
public Collection<Presence> getPresences(String username); Collection<Presence> getPresences( String username );
/** /**
* Probes the presence of the given XMPPAddress and attempts to send it to the given user. If * Probes the presence of the given XMPPAddress and attempts to send it to the given user. If
...@@ -78,7 +78,7 @@ public interface PresenceManager { ...@@ -78,7 +78,7 @@ public interface PresenceManager {
* @param prober The user requesting the probe * @param prober The user requesting the probe
* @param probee The XMPPAddress whos presence we would like sent have have probed * @param probee The XMPPAddress whos presence we would like sent have have probed
*/ */
public void probePresence(JID prober, JID probee); void probePresence( JID prober, JID probee );
/** /**
* Handle a presence probe sent by a remote server. The logic to apply is the following: If * Handle a presence probe sent by a remote server. The logic to apply is the following: If
...@@ -88,7 +88,7 @@ public interface PresenceManager { ...@@ -88,7 +88,7 @@ public interface PresenceManager {
* *
* @param packet the received probe presence from a remote server. * @param packet the received probe presence from a remote server.
*/ */
public void handleProbe(Presence packet) throws UnauthorizedException; void handleProbe( Presence packet ) throws UnauthorizedException;
/** /**
* Returns true if the the prober is allowed to see the presence of the probee. * Returns true if the the prober is allowed to see the presence of the probee.
...@@ -99,7 +99,7 @@ public interface PresenceManager { ...@@ -99,7 +99,7 @@ public interface PresenceManager {
* @throws UserNotFoundException If the probee does not exist in the local server or the prober * @throws UserNotFoundException If the probee does not exist in the local server or the prober
* is not present in the roster of the probee. * is not present in the roster of the probee.
*/ */
public boolean canProbePresence(JID prober, String probee) throws UserNotFoundException; boolean canProbePresence( JID prober, String probee ) throws UserNotFoundException;
/** /**
* Sends unavailable presence from all of the user's available resources to the remote user. * Sends unavailable presence from all of the user's available resources to the remote user.
...@@ -111,21 +111,21 @@ public interface PresenceManager { ...@@ -111,21 +111,21 @@ public interface PresenceManager {
* @param recipientJID JID of the remote user that will receive the unavailable presences. * @param recipientJID JID of the remote user that will receive the unavailable presences.
* @param userJID JID of the local user. * @param userJID JID of the local user.
*/ */
public void sendUnavailableFromSessions(JID recipientJID, JID userJID); void sendUnavailableFromSessions( JID recipientJID, JID userJID );
/** /**
* Notification message saying that the sender of the given presence just became available. * Notification message saying that the sender of the given presence just became available.
* *
* @param presence the presence sent by the available user. * @param presence the presence sent by the available user.
*/ */
public void userAvailable(Presence presence); void userAvailable( Presence presence );
/** /**
* Notification message saying that the sender of the given presence just became unavailable. * Notification message saying that the sender of the given presence just became unavailable.
* *
* @param presence the presence sent by the unavailable user. * @param presence the presence sent by the unavailable user.
*/ */
public void userUnavailable(Presence presence); void userUnavailable( Presence presence );
/** /**
* Returns the status sent by the user in his last unavailable presence or <tt>null</tt> if the * Returns the status sent by the user in his last unavailable presence or <tt>null</tt> if the
...@@ -135,7 +135,7 @@ public interface PresenceManager { ...@@ -135,7 +135,7 @@ public interface PresenceManager {
* @return the status sent by the user in his last unavailable presence or <tt>null</tt> if the * @return the status sent by the user in his last unavailable presence or <tt>null</tt> if the
* user is online or never set such information. * user is online or never set such information.
*/ */
public String getLastPresenceStatus(User user); String getLastPresenceStatus( User user );
/** /**
* Returns the number of milliseconds since the user went offline or -1 if such information * Returns the number of milliseconds since the user went offline or -1 if such information
...@@ -145,5 +145,5 @@ public interface PresenceManager { ...@@ -145,5 +145,5 @@ public interface PresenceManager {
* @return the number of milliseconds since the user went offline or -1 if such information * @return the number of milliseconds since the user went offline or -1 if such information
* is not available or if the user is online. * is not available or if the user is online.
*/ */
public long getLastActivity(User user); long getLastActivity( User user );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/RoutableChannelHandler.java
View file @ dcea025c
...@@ -33,5 +33,5 @@ public interface RoutableChannelHandler extends ChannelHandler<Packet> { ...@@ -33,5 +33,5 @@ public interface RoutableChannelHandler extends ChannelHandler<Packet> {
* *
* @return the XMPP address. * @return the XMPP address.
*/ */
public JID getAddress(); JID getAddress();
} }
src/java/org/jivesoftware/openfire/StreamID.java
View file @ dcea025c
...@@ -29,5 +29,5 @@ public interface StreamID { ...@@ -29,5 +29,5 @@ public interface StreamID {
* *
* @return The unique ID for this stream * @return The unique ID for this stream
*/ */
public String getID(); String getID();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/StreamIDFactory.java
View file @ dcea025c
...@@ -28,5 +28,5 @@ public interface StreamIDFactory { ...@@ -28,5 +28,5 @@ public interface StreamIDFactory {
* *
* @return A new, unique stream id * @return A new, unique stream id
*/ */
public StreamID createStreamID(); StreamID createStreamID();
} }
src/java/org/jivesoftware/openfire/admin/AdminProvider.java
View file @ dcea025c
...@@ -32,14 +32,14 @@ public interface AdminProvider { ...@@ -32,14 +32,14 @@ public interface AdminProvider {
* *
* @return The list of admin users. * @return The list of admin users.
*/ */
public List<JID> getAdmins(); List<JID> getAdmins();
/** /**
* Sets the list of admin accounts, by JID. * Sets the list of admin accounts, by JID.
* *
* @param admins List of JIDs of accounts to grant admin access to. * @param admins List of JIDs of accounts to grant admin access to.
*/ */
public void setAdmins(List<JID> admins); void setAdmins( List<JID> admins );
/** /**
* Indicates whether the admin list is read-only or not. In other words, whether an admin can * Indicates whether the admin list is read-only or not. In other words, whether an admin can
...@@ -47,6 +47,6 @@ public interface AdminProvider { ...@@ -47,6 +47,6 @@ public interface AdminProvider {
* *
* @return True or false if the admin list can be edited. * @return True or false if the admin list can be edited.
*/ */
public boolean isReadOnly(); boolean isReadOnly();
} }
src/java/org/jivesoftware/openfire/audit/AuditManager.java
View file @ dcea025c
...@@ -32,10 +32,10 @@ import java.util.Iterator; ...@@ -32,10 +32,10 @@ import java.util.Iterator;
public interface AuditManager { public interface AuditManager {
// Presence transitions // Presence transitions
public static final int PRESENCE_UNAVAILABLE_AVAILABLE = 1; int PRESENCE_UNAVAILABLE_AVAILABLE = 1;
public static final int PRESENCE_AVAILABLE_AVAILABLE = 2; int PRESENCE_AVAILABLE_AVAILABLE = 2;
public static final int PRESENCE_AVAILABLE_UNAVAILABLE = 4; int PRESENCE_AVAILABLE_UNAVAILABLE = 4;
public static final int PRESENCE_UNAVAILABLE_UNAVAILABLE = 8; int PRESENCE_UNAVAILABLE_UNAVAILABLE = 8;
/** /**
* Determines if auditing is enabled at all. * Determines if auditing is enabled at all.
......
src/java/org/jivesoftware/openfire/auth/AuthProvider.java
View file @ dcea025c
...@@ -59,7 +59,7 @@ public interface AuthProvider { ...@@ -59,7 +59,7 @@ public interface AuthProvider {
* @throws UnsupportedOperationException if the provider does not * @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation). * support the operation (this is an optional operation).
*/ */
public String getPassword(String username) throws UserNotFoundException, String getPassword( String username ) throws UserNotFoundException,
UnsupportedOperationException; UnsupportedOperationException;
/** /**
...@@ -72,7 +72,7 @@ public interface AuthProvider { ...@@ -72,7 +72,7 @@ public interface AuthProvider {
* @throws UnsupportedOperationException if the provider does not * @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation). * support the operation (this is an optional operation).
*/ */
public void setPassword(String username, String password) void setPassword( String username, String password )
throws UserNotFoundException, UnsupportedOperationException; throws UserNotFoundException, UnsupportedOperationException;
/** /**
...@@ -83,7 +83,7 @@ public interface AuthProvider { ...@@ -83,7 +83,7 @@ public interface AuthProvider {
* @return true if this UserProvider is able to retrieve user passwords from the * @return true if this UserProvider is able to retrieve user passwords from the
* backend user store. * backend user store.
*/ */
public boolean supportsPasswordRetrieval(); boolean supportsPasswordRetrieval();
boolean isScramSupported(); boolean isScramSupported();
String getSalt(String username) throws UnsupportedOperationException, UserNotFoundException; String getSalt(String username) throws UnsupportedOperationException, UserNotFoundException;
......
src/java/org/jivesoftware/openfire/auth/AuthorizationMapping.java
View file @ dcea025c
...@@ -42,19 +42,19 @@ public interface AuthorizationMapping { ...@@ -42,19 +42,19 @@ public interface AuthorizationMapping {
* @param principal The autheticated principal requesting authorization. * @param principal The autheticated principal requesting authorization.
* @return The name of the default username to use. * @return The name of the default username to use.
*/ */
public String map(String principal); String map( String principal );
/** /**
* Returns the short name of the Policy * Returns the short name of the Policy
* *
* @return The short name of the Policy * @return The short name of the Policy
*/ */
public abstract String name(); String name();
/** /**
* Returns a description of the Policy * Returns a description of the Policy
* *
* @return The description of the Policy. * @return The description of the Policy.
*/ */
public abstract String description(); String description();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/auth/AuthorizationPolicy.java
View file @ dcea025c
...@@ -46,19 +46,19 @@ public interface AuthorizationPolicy { ...@@ -46,19 +46,19 @@ public interface AuthorizationPolicy {
* @param principal The principal requesting the username. * @param principal The principal requesting the username.
* @return true is the user is authorized to be principal * @return true is the user is authorized to be principal
*/ */
public boolean authorize(String username, String principal); boolean authorize( String username, String principal );
/** /**
* Returns the short name of the Policy * Returns the short name of the Policy
* *
* @return The short name of the Policy * @return The short name of the Policy
*/ */
public abstract String name(); String name();
/** /**
* Returns a description of the Policy * Returns a description of the Policy
* *
* @return The description of the Policy. * @return The description of the Policy.
*/ */
public abstract String description(); String description();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/component/ComponentEventListener.java
View file @ dcea025c
...@@ -48,7 +48,7 @@ public interface ComponentEventListener { ...@@ -48,7 +48,7 @@ public interface ComponentEventListener {
* *
* @param componentJID address where the component can be located (e.g. search.myserver.com) * @param componentJID address where the component can be located (e.g. search.myserver.com)
*/ */
public void componentRegistered(JID componentJID); void componentRegistered( JID componentJID );
/** /**
* A component was removed. This means that no other cluster node has this component * A component was removed. This means that no other cluster node has this component
...@@ -56,7 +56,7 @@ public interface ComponentEventListener { ...@@ -56,7 +56,7 @@ public interface ComponentEventListener {
* *
* @param componentJID address where the component was located (e.g. search.myserver.com) * @param componentJID address where the component was located (e.g. search.myserver.com)
*/ */
public void componentUnregistered(JID componentJID); void componentUnregistered( JID componentJID );
/** /**
* The server has received a disco#info response from the component. Once a component * The server has received a disco#info response from the component. Once a component
...@@ -66,5 +66,5 @@ public interface ComponentEventListener { ...@@ -66,5 +66,5 @@ public interface ComponentEventListener {
* *
* @param iq the IQ packet with the disco#info sent by the component. * @param iq the IQ packet with the disco#info sent by the component.
*/ */
public void componentInfoReceived(IQ iq); void componentInfoReceived( IQ iq );
} }
src/java/org/jivesoftware/openfire/container/Plugin.java
View file @ dcea025c
...@@ -70,7 +70,7 @@ public interface Plugin { ...@@ -70,7 +70,7 @@ public interface Plugin {
* @param manager the plugin manager. * @param manager the plugin manager.
* @param pluginDirectory the directory where the plugin is located. * @param pluginDirectory the directory where the plugin is located.
*/ */
public void initializePlugin(PluginManager manager, File pluginDirectory); void initializePlugin( PluginManager manager, File pluginDirectory );
/** /**
* Destroys the plugin.<p> * Destroys the plugin.<p>
...@@ -81,6 +81,6 @@ public interface Plugin { ...@@ -81,6 +81,6 @@ public interface Plugin {
* garbage collection executed after this method is called must be able * garbage collection executed after this method is called must be able
* to clean up all plugin classes. * to clean up all plugin classes.
*/ */
public void destroyPlugin(); void destroyPlugin();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/disco/DiscoInfoProvider.java
View file @ dcea025c
...@@ -45,7 +45,7 @@ public interface DiscoInfoProvider { ...@@ -45,7 +45,7 @@ public interface DiscoInfoProvider {
* @param senderJID the XMPPAddress of user that sent the disco info request. * @param senderJID the XMPPAddress of user that sent the disco info request.
* @return an Iterator (of Element) with the target entity's identities. * @return an Iterator (of Element) with the target entity's identities.
*/ */
public abstract Iterator<Element> getIdentities(String name, String node, JID senderJID); Iterator<Element> getIdentities( String name, String node, JID senderJID );
/** /**
* Returns an Iterator (of String) with the supported features. The features to include are the * Returns an Iterator (of String) with the supported features. The features to include are the
...@@ -57,7 +57,7 @@ public interface DiscoInfoProvider { ...@@ -57,7 +57,7 @@ public interface DiscoInfoProvider {
* @param senderJID the XMPPAddress of user that sent the disco info request. * @param senderJID the XMPPAddress of user that sent the disco info request.
* @return an Iterator (of String) with the supported features. * @return an Iterator (of String) with the supported features.
*/ */
public abstract Iterator<String> getFeatures(String name, String node, JID senderJID); Iterator<String> getFeatures( String name, String node, JID senderJID );
/** /**
* Returns an XDataForm with the extended information about the entity or null if none. Each bit * Returns an XDataForm with the extended information about the entity or null if none. Each bit
...@@ -68,7 +68,7 @@ public interface DiscoInfoProvider { ...@@ -68,7 +68,7 @@ public interface DiscoInfoProvider {
* @param senderJID the XMPPAddress of user that sent the disco info request. * @param senderJID the XMPPAddress of user that sent the disco info request.
* @return an XDataForm with the extended information about the entity or null if none. * @return an XDataForm with the extended information about the entity or null if none.
*/ */
public abstract DataForm getExtendedInfo(String name, String node, JID senderJID); DataForm getExtendedInfo( String name, String node, JID senderJID );
/** /**
* Returns true if we can provide information related to the requested name and node. For * Returns true if we can provide information related to the requested name and node. For
...@@ -81,5 +81,5 @@ public interface DiscoInfoProvider { ...@@ -81,5 +81,5 @@ public interface DiscoInfoProvider {
* @param senderJID the XMPPAddress of user that sent the disco info request. * @param senderJID the XMPPAddress of user that sent the disco info request.
* @return true if we can provide information related to the requested name and node. * @return true if we can provide information related to the requested name and node.
*/ */
public abstract boolean hasInfo(String name, String node, JID senderJID); boolean hasInfo( String name, String node, JID senderJID );
} }
src/java/org/jivesoftware/openfire/disco/DiscoItemsProvider.java
View file @ dcea025c
...@@ -44,6 +44,6 @@ public interface DiscoItemsProvider { ...@@ -44,6 +44,6 @@ public interface DiscoItemsProvider {
* @param senderJID the XMPPAddress of user that sent the disco items request. * @param senderJID the XMPPAddress of user that sent the disco items request.
* @return an Iterator (of DiscoItem) with the target entity's items or null if none. * @return an Iterator (of DiscoItem) with the target entity's items or null if none.
*/ */
public abstract Iterator<DiscoItem> getItems(String name, String node, JID senderJID); Iterator<DiscoItem> getItems( String name, String node, JID senderJID );
} }
src/java/org/jivesoftware/openfire/disco/ServerFeaturesProvider.java
View file @ dcea025c
...@@ -40,5 +40,5 @@ public interface ServerFeaturesProvider { ...@@ -40,5 +40,5 @@ public interface ServerFeaturesProvider {
* *
* @return an Iterator (of String) with the supported features by the server. * @return an Iterator (of String) with the supported features by the server.
*/ */
public abstract Iterator<String> getFeatures(); Iterator<String> getFeatures();
} }
src/java/org/jivesoftware/openfire/disco/ServerIdentitiesProvider.java
View file @ dcea025c
...@@ -46,5 +46,5 @@ public interface ServerIdentitiesProvider { ...@@ -46,5 +46,5 @@ public interface ServerIdentitiesProvider {
* *
* @return an Iterator (of Element) with identities of protocols supported by the server. * @return an Iterator (of Element) with identities of protocols supported by the server.
*/ */
public abstract Iterator<Element> getIdentities(); Iterator<Element> getIdentities();
} }
src/java/org/jivesoftware/openfire/disco/ServerItemsProvider.java
View file @ dcea025c
...@@ -42,5 +42,5 @@ public interface ServerItemsProvider { ...@@ -42,5 +42,5 @@ public interface ServerItemsProvider {
* @return an Iterator (of DiscoServerItem) with the items associated with the server or null * @return an Iterator (of DiscoServerItem) with the items associated with the server or null
* if none. * if none.
*/ */
public abstract Iterator<DiscoServerItem> getItems(); Iterator<DiscoServerItem> getItems();
} }
src/java/org/jivesoftware/openfire/disco/UserIdentitiesProvider.java
View file @ dcea025c
...@@ -46,5 +46,5 @@ public interface UserIdentitiesProvider { ...@@ -46,5 +46,5 @@ public interface UserIdentitiesProvider {
* *
* @return an Iterator (of Element) with identities of protocols supported by users. * @return an Iterator (of Element) with identities of protocols supported by users.
*/ */
public abstract Iterator<Element> getIdentities(); Iterator<Element> getIdentities();
} }
src/java/org/jivesoftware/openfire/disco/UserItemsProvider.java
View file @ dcea025c
...@@ -49,5 +49,5 @@ public interface UserItemsProvider { ...@@ -49,5 +49,5 @@ public interface UserItemsProvider {
* @param senderJID the XMPPAddress of user that sent the disco items request. * @param senderJID the XMPPAddress of user that sent the disco items request.
* @return an Iterator (of Element) with the target entity's items or null if none. * @return an Iterator (of Element) with the target entity's items or null if none.
*/ */
public abstract Iterator<Element> getUserItems(String name, JID senderJID); Iterator<Element> getUserItems( String name, JID senderJID );
} }
src/java/org/jivesoftware/openfire/event/GroupEventListener.java
View file @ dcea025c
...@@ -35,7 +35,7 @@ public interface GroupEventListener { ...@@ -35,7 +35,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void groupCreated(Group group, Map params); void groupCreated( Group group, Map params );
/** /**
* A group is being deleted. * A group is being deleted.
...@@ -43,7 +43,7 @@ public interface GroupEventListener { ...@@ -43,7 +43,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void groupDeleting(Group group, Map params); void groupDeleting( Group group, Map params );
/** /**
* A group's name, description, or an extended property was changed. * A group's name, description, or an extended property was changed.
...@@ -51,7 +51,7 @@ public interface GroupEventListener { ...@@ -51,7 +51,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void groupModified(Group group, Map params); void groupModified( Group group, Map params );
/** /**
* A member was added to a group. * A member was added to a group.
...@@ -59,7 +59,7 @@ public interface GroupEventListener { ...@@ -59,7 +59,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void memberAdded(Group group, Map params); void memberAdded( Group group, Map params );
/** /**
* A member was removed from a group. * A member was removed from a group.
...@@ -67,7 +67,7 @@ public interface GroupEventListener { ...@@ -67,7 +67,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void memberRemoved(Group group, Map params); void memberRemoved( Group group, Map params );
/** /**
* An administrator was added to a group. * An administrator was added to a group.
...@@ -75,7 +75,7 @@ public interface GroupEventListener { ...@@ -75,7 +75,7 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void adminAdded(Group group, Map params); void adminAdded( Group group, Map params );
/** /**
* An administrator was removed from a group. * An administrator was removed from a group.
...@@ -83,5 +83,5 @@ public interface GroupEventListener { ...@@ -83,5 +83,5 @@ public interface GroupEventListener {
* @param group the group. * @param group the group.
* @param params event parameters. * @param params event parameters.
*/ */
public void adminRemoved(Group group, Map params); void adminRemoved( Group group, Map params );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/event/SessionEventListener.java
View file @ dcea025c
...@@ -33,33 +33,33 @@ public interface SessionEventListener { ...@@ -33,33 +33,33 @@ public interface SessionEventListener {
* *
* @param session the authenticated session of a non anonymous user. * @param session the authenticated session of a non anonymous user.
*/ */
public void sessionCreated(Session session); void sessionCreated( Session session );
/** /**
* An authenticated session of a non anonymous user was destroyed. * An authenticated session of a non anonymous user was destroyed.
* *
* @param session the authenticated session of a non anonymous user. * @param session the authenticated session of a non anonymous user.
*/ */
public void sessionDestroyed(Session session); void sessionDestroyed( Session session );
/** /**
* Notification event indicating that an anonymous user has authenticated with the server. * Notification event indicating that an anonymous user has authenticated with the server.
* *
* @param session the authenticated session of an anonymous user. * @param session the authenticated session of an anonymous user.
*/ */
public void anonymousSessionCreated(Session session); void anonymousSessionCreated( Session session );
/** /**
* An authenticated session of an anonymous user was destroyed. * An authenticated session of an anonymous user was destroyed.
* *
* @param session the authenticated session of an anonymous user. * @param session the authenticated session of an anonymous user.
*/ */
public void anonymousSessionDestroyed(Session session); void anonymousSessionDestroyed( Session session );
/** /**
* A session has finished resource binding. * A session has finished resource binding.
* *
* @param session the session on which resource binding was performed. * @param session the session on which resource binding was performed.
*/ */
public void resourceBound(Session session); void resourceBound( Session session );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/event/UserEventListener.java
View file @ dcea025c
...@@ -35,7 +35,7 @@ public interface UserEventListener { ...@@ -35,7 +35,7 @@ public interface UserEventListener {
* @param user the user. * @param user the user.
* @param params event parameters. * @param params event parameters.
*/ */
public void userCreated(User user, Map<String,Object> params); void userCreated( User user, Map<String, Object> params );
/** /**
* A user is being deleted. * A user is being deleted.
...@@ -43,7 +43,7 @@ public interface UserEventListener { ...@@ -43,7 +43,7 @@ public interface UserEventListener {
* @param user the user. * @param user the user.
* @param params event parameters. * @param params event parameters.
*/ */
public void userDeleting(User user, Map<String,Object> params); void userDeleting( User user, Map<String, Object> params );
/** /**
* A user's name, email, or an extended property was changed. * A user's name, email, or an extended property was changed.
...@@ -51,5 +51,5 @@ public interface UserEventListener { ...@@ -51,5 +51,5 @@ public interface UserEventListener {
* @param user the user. * @param user the user.
* @param params event parameters. * @param params event parameters.
*/ */
public void userModified(User user, Map<String,Object> params); void userModified( User user, Map<String, Object> params );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/filetransfer/FileTransferManager.java
View file @ dcea025c
...@@ -29,18 +29,18 @@ public interface FileTransferManager extends Module { ...@@ -29,18 +29,18 @@ public interface FileTransferManager extends Module {
/** /**
* The Stream Initiation, SI, namespace. * The Stream Initiation, SI, namespace.
*/ */
static final String NAMESPACE_SI = "http://jabber.org/protocol/si"; String NAMESPACE_SI = "http://jabber.org/protocol/si";
/** /**
* Namespace for the file transfer profile of Stream Initiation. * Namespace for the file transfer profile of Stream Initiation.
*/ */
static final String NAMESPACE_SI_FILETRANSFER = String NAMESPACE_SI_FILETRANSFER =
"http://jabber.org/protocol/si/profile/file-transfer"; "http://jabber.org/protocol/si/profile/file-transfer";
/** /**
* Bytestreams namespace * Bytestreams namespace
*/ */
static final String NAMESPACE_BYTESTREAMS = "http://jabber.org/protocol/bytestreams"; String NAMESPACE_BYTESTREAMS = "http://jabber.org/protocol/bytestreams";
/** /**
* Checks an incoming file transfer request to see if it should be accepted or rejected. * Checks an incoming file transfer request to see if it should be accepted or rejected.
......
src/java/org/jivesoftware/openfire/filetransfer/FileTransferProgress.java
View file @ dcea025c
...@@ -33,34 +33,34 @@ public interface FileTransferProgress { ...@@ -33,34 +33,34 @@ public interface FileTransferProgress {
* @return the number of bytes that has been transferred. * @return the number of bytes that has been transferred.
* @throws UnsupportedOperationException * @throws UnsupportedOperationException
*/ */
public long getAmountTransferred() throws UnsupportedOperationException; long getAmountTransferred() throws UnsupportedOperationException;
/** /**
* Returns the fully qualified JID of the initiator of the file transfer. * Returns the fully qualified JID of the initiator of the file transfer.
* *
* @return the fully qualified JID of the initiator of the file transfer. * @return the fully qualified JID of the initiator of the file transfer.
*/ */
public String getInitiator(); String getInitiator();
public void setInitiator(String initiator); void setInitiator( String initiator );
/** /**
* Returns the full qualified JID of the target of the file transfer. * Returns the full qualified JID of the target of the file transfer.
* *
* @return the fully qualified JID of the target * @return the fully qualified JID of the target
*/ */
public String getTarget(); String getTarget();
public void setTarget(String target); void setTarget( String target );
/** /**
* Returns the unique session id that correlates to the file transfer. * Returns the unique session id that correlates to the file transfer.
* *
* @return Returns the unique session id that correlates to the file transfer. * @return Returns the unique session id that correlates to the file transfer.
*/ */
public String getSessionID(); String getSessionID();
public void setSessionID(String streamID); void setSessionID( String streamID );
/** /**
* When the file transfer is being caried out by another thread this will set the Future * When the file transfer is being caried out by another thread this will set the Future
...@@ -68,13 +68,13 @@ public interface FileTransferProgress { ...@@ -68,13 +68,13 @@ public interface FileTransferProgress {
* *
* @param future the furute that is carrying out the transfer * @param future the furute that is carrying out the transfer
*/ */
public void setTransferFuture(Future<?> future); void setTransferFuture( Future<?> future );
public void setInputStream(InputStream initiatorInputStream); void setInputStream( InputStream initiatorInputStream );
public InputStream getInputStream(); InputStream getInputStream();
public void setOutputStream(OutputStream targetOutputStream); void setOutputStream( OutputStream targetOutputStream );
public OutputStream getOutputStream(); OutputStream getOutputStream();
} }
src/java/org/jivesoftware/openfire/filetransfer/proxy/ProxyTransfer.java
View file @ dcea025c
...@@ -32,21 +32,21 @@ public interface ProxyTransfer extends Cacheable, FileTransferProgress { ...@@ -32,21 +32,21 @@ public interface ProxyTransfer extends Cacheable, FileTransferProgress {
* *
* @param digest the digest which uniquely identifies this transfer. * @param digest the digest which uniquely identifies this transfer.
*/ */
public void setTransferDigest(String digest); void setTransferDigest( String digest );
/** /**
* Returns the transfer digest uniquely identifies a file transfer in the system. * Returns the transfer digest uniquely identifies a file transfer in the system.
* *
* @return the transfer digest uniquely identifies a file transfer in the system. * @return the transfer digest uniquely identifies a file transfer in the system.
*/ */
public String getTransferDigest(); String getTransferDigest();
/** /**
* Returns true if the Bytestream is ready to be activated and the proxy transfer can begin. * Returns true if the Bytestream is ready to be activated and the proxy transfer can begin.
* *
* @return true if the Bytestream is ready to be activated. * @return true if the Bytestream is ready to be activated.
*/ */
public boolean isActivatable(); boolean isActivatable();
/** /**
* Transfers the file from the initiator to the target. * Transfers the file from the initiator to the target.
...@@ -54,5 +54,5 @@ public interface ProxyTransfer extends Cacheable, FileTransferProgress { ...@@ -54,5 +54,5 @@ public interface ProxyTransfer extends Cacheable, FileTransferProgress {
* @throws java.io.IOException when an error occurs either reading from the input stream or * @throws java.io.IOException when an error occurs either reading from the input stream or
* writing to the output stream. * writing to the output stream.
*/ */
public void doTransfer() throws IOException; void doTransfer() throws IOException;
} }
src/java/org/jivesoftware/openfire/forms/DataForm.java
View file @ dcea025c
...@@ -43,10 +43,10 @@ import java.util.List; ...@@ -43,10 +43,10 @@ import java.util.List;
@Deprecated @Deprecated
public interface DataForm { public interface DataForm {
public static final String TYPE_FORM = "form"; String TYPE_FORM = "form";
public static final String TYPE_SUBMIT = "submit"; String TYPE_SUBMIT = "submit";
public static final String TYPE_CANCEL = "cancel"; String TYPE_CANCEL = "cancel";
public static final String TYPE_RESULT = "result"; String TYPE_RESULT = "result";
/** /**
* Sets the description of the data. It is similar to the title on a web page or an X window. * Sets the description of the data. It is similar to the title on a web page or an X window.
...@@ -54,7 +54,7 @@ public interface DataForm { ...@@ -54,7 +54,7 @@ public interface DataForm {
* *
* @param title description of the data. * @param title description of the data.
*/ */
public abstract void setTitle(String title); void setTitle( String title );
/** /**
* Sets the list of instructions that explain how to fill out the form and what the form is * Sets the list of instructions that explain how to fill out the form and what the form is
...@@ -63,7 +63,7 @@ public interface DataForm { ...@@ -63,7 +63,7 @@ public interface DataForm {
* *
* @param instructions list of instructions that explain how to fill out the form. * @param instructions list of instructions that explain how to fill out the form.
*/ */
public abstract void setInstructions(List instructions); void setInstructions( List instructions );
/** /**
* Returns the meaning of the data within the context. The data could be part of a form * Returns the meaning of the data within the context. The data could be part of a form
...@@ -82,7 +82,7 @@ public interface DataForm { ...@@ -82,7 +82,7 @@ public interface DataForm {
* *
* @return the form's type. * @return the form's type.
*/ */
public abstract String getType(); String getType();
/** /**
* Returns the description of the data. It is similar to the title on a web page or an X * Returns the description of the data. It is similar to the title on a web page or an X
...@@ -90,7 +90,7 @@ public interface DataForm { ...@@ -90,7 +90,7 @@ public interface DataForm {
* *
* @return description of the data. * @return description of the data.
*/ */
public abstract String getTitle(); String getTitle();
/** /**
* Returns an Iterator for the list of instructions that explain how to fill out the form and * Returns an Iterator for the list of instructions that explain how to fill out the form and
...@@ -100,7 +100,7 @@ public interface DataForm { ...@@ -100,7 +100,7 @@ public interface DataForm {
* *
* @return an Iterator for the list of instructions that explain how to fill out the form. * @return an Iterator for the list of instructions that explain how to fill out the form.
*/ */
public abstract Iterator getInstructions(); Iterator getInstructions();
/** /**
* Returns the field of the form whose variable matches the specified variable. * Returns the field of the form whose variable matches the specified variable.
...@@ -110,21 +110,21 @@ public interface DataForm { ...@@ -110,21 +110,21 @@ public interface DataForm {
* @param variable the variable to look for in the form fields. * @param variable the variable to look for in the form fields.
* @return the field of the form whose variable matches the specified variable. * @return the field of the form whose variable matches the specified variable.
*/ */
public FormField getField(String variable); FormField getField( String variable );
/** /**
* Returns an Iterator for the fields that are part of the form. * Returns an Iterator for the fields that are part of the form.
* *
* @return an Iterator for the fields that are part of the form. * @return an Iterator for the fields that are part of the form.
*/ */
public abstract Iterator getFields(); Iterator getFields();
/** /**
* Returns the number of fields included in the form. * Returns the number of fields included in the form.
* *
* @return the number of fields included in the form. * @return the number of fields included in the form.
*/ */
public abstract int getFieldsSize(); int getFieldsSize();
/** /**
* Adds a new instruction to the list of instructions that explain how to fill out the form * Adds a new instruction to the list of instructions that explain how to fill out the form
...@@ -133,14 +133,14 @@ public interface DataForm { ...@@ -133,14 +133,14 @@ public interface DataForm {
* *
* @param instruction the new instruction that explain how to fill out the form. * @param instruction the new instruction that explain how to fill out the form.
*/ */
public abstract void addInstruction(String instruction); void addInstruction( String instruction );
/** /**
* Adds a new field as part of the form. * Adds a new field as part of the form.
* *
* @param field the field to add to the form. * @param field the field to add to the form.
*/ */
public abstract void addField(FormField field); void addField( FormField field );
/** /**
* Adds a field to the list of fields that will be returned from a search. Each field represents * Adds a field to the list of fields that will be returned from a search. Each field represents
...@@ -149,7 +149,7 @@ public interface DataForm { ...@@ -149,7 +149,7 @@ public interface DataForm {
* *
* @param field the field to add to the list of fields that will be returned from a search. * @param field the field to add to the list of fields that will be returned from a search.
*/ */
public abstract void addReportedField(FormField field); void addReportedField( FormField field );
/** /**
* Adds a new row of items of reported data. The list of items to add will be formed by * Adds a new row of items of reported data. The list of items to add will be formed by
...@@ -158,5 +158,5 @@ public interface DataForm { ...@@ -158,5 +158,5 @@ public interface DataForm {
* *
* @param itemFields list of FormFields to add as a row in the report. * @param itemFields list of FormFields to add as a row in the report.
*/ */
public abstract void addItemFields(ArrayList itemFields); void addItemFields( ArrayList itemFields );
} }
src/java/org/jivesoftware/openfire/forms/FormField.java
View file @ dcea025c
...@@ -29,16 +29,16 @@ import java.util.Iterator; ...@@ -29,16 +29,16 @@ import java.util.Iterator;
@Deprecated @Deprecated
public interface FormField { public interface FormField {
public static final String TYPE_BOOLEAN = "boolean"; String TYPE_BOOLEAN = "boolean";
public static final String TYPE_FIXED = "fixed"; String TYPE_FIXED = "fixed";
public static final String TYPE_HIDDEN = "hidden"; String TYPE_HIDDEN = "hidden";
public static final String TYPE_JID_MULTI = "jid-multi"; String TYPE_JID_MULTI = "jid-multi";
public static final String TYPE_JID_SINGLE = "jid-single"; String TYPE_JID_SINGLE = "jid-single";
public static final String TYPE_LIST_MULTI = "list-multi"; String TYPE_LIST_MULTI = "list-multi";
public static final String TYPE_LIST_SINGLE = "list-single"; String TYPE_LIST_SINGLE = "list-single";
public static final String TYPE_TEXT_MULTI = "text-multi"; String TYPE_TEXT_MULTI = "text-multi";
public static final String TYPE_TEXT_PRIVATE = "text-private"; String TYPE_TEXT_PRIVATE = "text-private";
public static final String TYPE_TEXT_SINGLE = "text-single"; String TYPE_TEXT_SINGLE = "text-single";
/** /**
* Adds a default value to the question if the question is part of a form to fill out. * Adds a default value to the question if the question is part of a form to fill out.
...@@ -46,12 +46,12 @@ public interface FormField { ...@@ -46,12 +46,12 @@ public interface FormField {
* *
* @param value a default value or an answered value of the question. * @param value a default value or an answered value of the question.
*/ */
public void addValue(String value); void addValue( String value );
/** /**
* Removes all the values of the field. * Removes all the values of the field.
*/ */
public void clearValues(); void clearValues();
/** /**
* Adds an available option to the question that the user has in order to answer * Adds an available option to the question that the user has in order to answer
...@@ -60,7 +60,7 @@ public interface FormField { ...@@ -60,7 +60,7 @@ public interface FormField {
* @param label a label that represents the option. * @param label a label that represents the option.
* @param value the value of the option. * @param value the value of the option.
*/ */
public void addOption(String label, String value); void addOption( String label, String value );
/** /**
* Sets an indicative of the format for the data to answer. Valid formats are: * Sets an indicative of the format for the data to answer. Valid formats are:
...@@ -82,14 +82,14 @@ public interface FormField { ...@@ -82,14 +82,14 @@ public interface FormField {
* *
* @param type an indicative of the format for the data to answer. * @param type an indicative of the format for the data to answer.
*/ */
public abstract void setType(String type); void setType( String type );
/** /**
* Sets if the question must be answered in order to complete the questionnaire. * Sets if the question must be answered in order to complete the questionnaire.
* *
* @param required if the question must be answered in order to complete the questionnaire. * @param required if the question must be answered in order to complete the questionnaire.
*/ */
public abstract void setRequired(boolean required); void setRequired( boolean required );
/** /**
* Sets the label of the question which should give enough information to the user to * Sets the label of the question which should give enough information to the user to
...@@ -97,7 +97,7 @@ public interface FormField { ...@@ -97,7 +97,7 @@ public interface FormField {
* *
* @param label the label of the question. * @param label the label of the question.
*/ */
public abstract void setLabel(String label); void setLabel( String label );
/** /**
* Sets a description that provides extra clarification about the question. This information * Sets a description that provides extra clarification about the question. This information
...@@ -109,21 +109,21 @@ public interface FormField { ...@@ -109,21 +109,21 @@ public interface FormField {
* *
* @param description provides extra clarification about the question. * @param description provides extra clarification about the question.
*/ */
public abstract void setDescription(String description); void setDescription( String description );
/** /**
* Returns true if the question must be answered in order to complete the questionnaire. * Returns true if the question must be answered in order to complete the questionnaire.
* *
* @return true if the question must be answered in order to complete the questionnaire. * @return true if the question must be answered in order to complete the questionnaire.
*/ */
public abstract boolean isRequired(); boolean isRequired();
/** /**
* Returns the variable name that the question is filling out. * Returns the variable name that the question is filling out.
* *
* @return the variable name of the question. * @return the variable name of the question.
*/ */
public abstract String getVariable(); String getVariable();
/** /**
* Returns an Iterator for the default values of the question if the question is part * Returns an Iterator for the default values of the question if the question is part
...@@ -132,7 +132,7 @@ public interface FormField { ...@@ -132,7 +132,7 @@ public interface FormField {
* *
* @return an Iterator for the default values or answered values of the question. * @return an Iterator for the default values or answered values of the question.
*/ */
public abstract Iterator<String> getValues(); Iterator<String> getValues();
/** /**
* Returns an indicative of the format for the data to answer. Valid formats are: * Returns an indicative of the format for the data to answer. Valid formats are:
...@@ -154,7 +154,7 @@ public interface FormField { ...@@ -154,7 +154,7 @@ public interface FormField {
* *
* @return format for the data to answer. * @return format for the data to answer.
*/ */
public abstract String getType(); String getType();
/** /**
* Returns the label of the question which should give enough information to the user to * Returns the label of the question which should give enough information to the user to
...@@ -162,7 +162,7 @@ public interface FormField { ...@@ -162,7 +162,7 @@ public interface FormField {
* *
* @return label of the question. * @return label of the question.
*/ */
public abstract String getLabel(); String getLabel();
/** /**
* Returns a description that provides extra clarification about the question. This information * Returns a description that provides extra clarification about the question. This information
...@@ -174,5 +174,5 @@ public interface FormField { ...@@ -174,5 +174,5 @@ public interface FormField {
* *
* @return description that provides extra clarification about the question. * @return description that provides extra clarification about the question.
*/ */
public abstract String getDescription(); String getDescription();
} }
src/java/org/jivesoftware/openfire/group/GroupAwareMap.java
View file @ dcea025c
...@@ -20,7 +20,7 @@ public interface GroupAwareMap<K, V> extends Map<K, V> { ...@@ -20,7 +20,7 @@ public interface GroupAwareMap<K, V> extends Map<K, V> {
* @param key The target, presumably a JID * @param key The target, presumably a JID
* @return True if the target is in the key list, or in any groups in the key list * @return True if the target is in the key list, or in any groups in the key list
*/ */
public boolean includesKey(Object key); boolean includesKey( Object key );
/** /**
* Returns true if the map contains a value referencing the given JID. If the JID * Returns true if the map contains a value referencing the given JID. If the JID
...@@ -30,7 +30,7 @@ public interface GroupAwareMap<K, V> extends Map<K, V> { ...@@ -30,7 +30,7 @@ public interface GroupAwareMap<K, V> extends Map<K, V> {
* @param value The target, presumably a JID * @param value The target, presumably a JID
* @return True if the target is in the key list, or in any groups in the key list * @return True if the target is in the key list, or in any groups in the key list
*/ */
public boolean includesValue(Object value); boolean includesValue( Object value );
/** /**
* Returns the groups that are implied (resolvable) from the keys in the map. * Returns the groups that are implied (resolvable) from the keys in the map.
......
src/java/org/jivesoftware/openfire/handler/IQRegisterInfo.java
View file @ dcea025c
...@@ -120,7 +120,7 @@ public interface IQRegisterInfo { ...@@ -120,7 +120,7 @@ public interface IQRegisterInfo {
* *
* @return the location type. * @return the location type.
*/ */
public int getFieldStoreLocation(); int getFieldStoreLocation();
/** /**
* Sets the location for storing field information. * Sets the location for storing field information.
...@@ -129,7 +129,7 @@ public interface IQRegisterInfo { ...@@ -129,7 +129,7 @@ public interface IQRegisterInfo {
* @throws org.jivesoftware.openfire.auth.UnauthorizedException * @throws org.jivesoftware.openfire.auth.UnauthorizedException
* If you don't have permission to adjust this setting * If you don't have permission to adjust this setting
*/ */
public void setFieldStoreLocation(int location) throws UnauthorizedException; void setFieldStoreLocation( int location ) throws UnauthorizedException;
/** /**
* Determines if users can automatically register user accounts * Determines if users can automatically register user accounts
...@@ -137,7 +137,7 @@ public interface IQRegisterInfo { ...@@ -137,7 +137,7 @@ public interface IQRegisterInfo {
* *
* @return True if open registration is supported * @return True if open registration is supported
*/ */
public boolean isOpenRegistrationSupported(); boolean isOpenRegistrationSupported();
/** /**
* Tells the server whether to support open registration or not. * Tells the server whether to support open registration or not.
...@@ -146,7 +146,7 @@ public interface IQRegisterInfo { ...@@ -146,7 +146,7 @@ public interface IQRegisterInfo {
* @throws org.jivesoftware.openfire.auth.UnauthorizedException * @throws org.jivesoftware.openfire.auth.UnauthorizedException
* If you don't have permission to change this setting * If you don't have permission to change this setting
*/ */
public void setOpenRegistrationSupported(boolean isSupported) throws UnauthorizedException; void setOpenRegistrationSupported( boolean isSupported ) throws UnauthorizedException;
/** /**
* Determines if a given field is required for registration. * Determines if a given field is required for registration.
...@@ -154,7 +154,7 @@ public interface IQRegisterInfo { ...@@ -154,7 +154,7 @@ public interface IQRegisterInfo {
* @param fieldType The field to check * @param fieldType The field to check
* @return True if the field is required * @return True if the field is required
*/ */
public boolean isFieldRequired(int fieldType); boolean isFieldRequired( int fieldType );
/** /**
* Tells the server whether to require a registration field or not. * Tells the server whether to require a registration field or not.
...@@ -164,7 +164,7 @@ public interface IQRegisterInfo { ...@@ -164,7 +164,7 @@ public interface IQRegisterInfo {
* @throws org.jivesoftware.openfire.auth.UnauthorizedException * @throws org.jivesoftware.openfire.auth.UnauthorizedException
* If you don't have permission to change this setting * If you don't have permission to change this setting
*/ */
public void setFieldRequired(int fieldType, boolean isRequired) throws UnauthorizedException; void setFieldRequired( int fieldType, boolean isRequired ) throws UnauthorizedException;
/** /**
* Get the setting type from a field's element name. This is a convenience * Get the setting type from a field's element name. This is a convenience
...@@ -173,7 +173,7 @@ public interface IQRegisterInfo { ...@@ -173,7 +173,7 @@ public interface IQRegisterInfo {
* @param fieldElementName The known element name * @param fieldElementName The known element name
* @return The field type, one of the static int types defined in this class * @return The field type, one of the static int types defined in this class
*/ */
public int getFieldType(String fieldElementName); int getFieldType( String fieldElementName );
/** /**
* Obtain the element name from a field type. This is a convience for * Obtain the element name from a field type. This is a convience for
...@@ -182,5 +182,5 @@ public interface IQRegisterInfo { ...@@ -182,5 +182,5 @@ public interface IQRegisterInfo {
* @param fieldType The known field type * @param fieldType The known field type
* @return The field element name * @return The field element name
*/ */
public String getFieldElementName(int fieldType); String getFieldElementName( int fieldType );
} }
src/java/org/jivesoftware/openfire/http/SessionListener.java
View file @ dcea025c
...@@ -29,7 +29,7 @@ public interface SessionListener { ...@@ -29,7 +29,7 @@ public interface SessionListener {
* @param session the session. * @param session the session.
* @param connection the connection. * @param connection the connection.
*/ */
public void connectionOpened(HttpSession session, HttpConnection connection); void connectionOpened( HttpSession session, HttpConnection connection );
/** /**
* A conneciton was closed. * A conneciton was closed.
...@@ -37,12 +37,12 @@ public interface SessionListener { ...@@ -37,12 +37,12 @@ public interface SessionListener {
* @param session the session. * @param session the session.
* @param connection the connection. * @param connection the connection.
*/ */
public void connectionClosed(HttpSession session, HttpConnection connection); void connectionClosed( HttpSession session, HttpConnection connection );
/** /**
* A session ended. * A session ended.
* *
* @param session the session. * @param session the session.
*/ */
public void sessionClosed(HttpSession session); void sessionClosed( HttpSession session );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/lockout/LockOutEventListener.java
View file @ dcea025c
...@@ -30,20 +30,20 @@ public interface LockOutEventListener { ...@@ -30,20 +30,20 @@ public interface LockOutEventListener {
* *
* @param flag The LockOutFlag that was set, which includes the username of the account and start/end times. * @param flag The LockOutFlag that was set, which includes the username of the account and start/end times.
*/ */
public void accountLocked(LockOutFlag flag); void accountLocked( LockOutFlag flag );
/** /**
* Notifies the listeners that an account was just enabled (lockout removed). * Notifies the listeners that an account was just enabled (lockout removed).
* *
* @param username The username of the account that was enabled. * @param username The username of the account that was enabled.
*/ */
public void accountUnlocked(String username); void accountUnlocked( String username );
/** /**
* Notifies the listeners that a locked out account attempted to log in. * Notifies the listeners that a locked out account attempted to log in.
* *
* @param username The username of the account that tried to log in. * @param username The username of the account that tried to log in.
*/ */
public void lockedAccountDenied(String username); void lockedAccountDenied( String username );
} }
src/java/org/jivesoftware/openfire/lockout/LockOutProvider.java
View file @ dcea025c
...@@ -33,21 +33,21 @@ public interface LockOutProvider { ...@@ -33,21 +33,21 @@ public interface LockOutProvider {
* @return The LockOutFlag instance describing the accounts disabled status or null if user * @return The LockOutFlag instance describing the accounts disabled status or null if user
* account specified is not currently locked out (disabled). * account specified is not currently locked out (disabled).
*/ */
public LockOutFlag getDisabledStatus(String username); LockOutFlag getDisabledStatus( String username );
/** /**
* Sets the locked out (disabled) status of an account according to a LockOutFlag. * Sets the locked out (disabled) status of an account according to a LockOutFlag.
* *
* @param flag A LockOutFlag instance to describe the disabled status of a user. * @param flag A LockOutFlag instance to describe the disabled status of a user.
*/ */
public void setDisabledStatus(LockOutFlag flag); void setDisabledStatus( LockOutFlag flag );
/** /**
* Unsets the locked out (disabled) status of an account, thereby enabling it/cancelling the disable. * Unsets the locked out (disabled) status of an account, thereby enabling it/cancelling the disable.
* *
* @param username User to enable. * @param username User to enable.
*/ */
public void unsetDisabledStatus(String username); void unsetDisabledStatus( String username );
/** /**
* Returns true if this LockOutProvider is read-only. When read-only, * Returns true if this LockOutProvider is read-only. When read-only,
...@@ -55,7 +55,7 @@ public interface LockOutProvider { ...@@ -55,7 +55,7 @@ public interface LockOutProvider {
* *
* @return true if the lock out provider is read-only. * @return true if the lock out provider is read-only.
*/ */
public boolean isReadOnly(); boolean isReadOnly();
/** /**
* Returns true if the LockOutProvider allows for a delayed start to the lockout. * Returns true if the LockOutProvider allows for a delayed start to the lockout.
...@@ -65,7 +65,7 @@ public interface LockOutProvider { ...@@ -65,7 +65,7 @@ public interface LockOutProvider {
* *
* @return true if the lock out provider provides this feature. * @return true if the lock out provider provides this feature.
*/ */
public boolean isDelayedStartSupported(); boolean isDelayedStartSupported();
/** /**
* Returns true if the LockOutProvider allows for a timeout after which the lock out will expire. * Returns true if the LockOutProvider allows for a timeout after which the lock out will expire.
...@@ -75,7 +75,7 @@ public interface LockOutProvider { ...@@ -75,7 +75,7 @@ public interface LockOutProvider {
* *
* @return true if the lcok out provider provides this feature. * @return true if the lcok out provider provides this feature.
*/ */
public boolean isTimeoutSupported(); boolean isTimeoutSupported();
/** /**
* Returns true if the lock out flags should not be cached, meaning every status lookup will * Returns true if the lock out flags should not be cached, meaning every status lookup will
...@@ -84,6 +84,6 @@ public interface LockOutProvider { ...@@ -84,6 +84,6 @@ public interface LockOutProvider {
* *
* @return true if disabled status should not be cached. * @return true if disabled status should not be cached.
*/ */
public boolean shouldNotBeCached(); boolean shouldNotBeCached();
} }
src/java/org/jivesoftware/openfire/mediaproxy/DatagramListener.java
View file @ dcea025c
...@@ -32,5 +32,5 @@ public interface DatagramListener { ...@@ -32,5 +32,5 @@ public interface DatagramListener {
* @param datagramPacket the datagram packet received. * @param datagramPacket the datagram packet received.
* @return ? * @return ?
*/ */
public boolean datagramReceived(DatagramPacket datagramPacket); boolean datagramReceived( DatagramPacket datagramPacket );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/mediaproxy/ProxyCandidate.java
View file @ dcea025c
...@@ -25,37 +25,37 @@ import java.net.InetAddress; ...@@ -25,37 +25,37 @@ import java.net.InetAddress;
*/ */
public interface ProxyCandidate { public interface ProxyCandidate {
public String getSID(); String getSID();
public String getPass(); String getPass();
public InetAddress getLocalhost(); InetAddress getLocalhost();
public InetAddress getHostA(); InetAddress getHostA();
public InetAddress getHostB(); InetAddress getHostB();
public void setHostA(InetAddress hostA); void setHostA( InetAddress hostA );
public void setHostB(InetAddress hostB); void setHostB( InetAddress hostB );
public void sendFromPortA(String host, int port); void sendFromPortA( String host, int port );
public void sendFromPortB(String host, int port); void sendFromPortB( String host, int port );
public int getPortA(); int getPortA();
public int getPortB(); int getPortB();
public void setPortA(int portA); void setPortA( int portA );
public void setPortB(int portB); void setPortB( int portB );
public int getLocalPortA(); int getLocalPortA();
public int getLocalPortB(); int getLocalPortB();
public void start(); void start();
public void stopAgent(); void stopAgent();
} }
src/java/org/jivesoftware/openfire/mediaproxy/SessionListener.java
View file @ dcea025c
...@@ -29,6 +29,6 @@ public interface SessionListener { ...@@ -29,6 +29,6 @@ public interface SessionListener {
* *
* @param session the session that closed. * @param session the session that closed.
*/ */
public void sessionClosed(MediaProxySession session); void sessionClosed( MediaProxySession session );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/muc/MUCRole.java
View file @ dcea025c
...@@ -37,14 +37,14 @@ public interface MUCRole { ...@@ -37,14 +37,14 @@ public interface MUCRole {
* *
* @return The presence of the user in the room. * @return The presence of the user in the room.
*/ */
public Presence getPresence(); Presence getPresence();
/** /**
* Set the current presence status of a user in a chatroom. * Set the current presence status of a user in a chatroom.
* *
* @param presence The presence of the user in the room. * @param presence The presence of the user in the room.
*/ */
public void setPresence(Presence presence); void setPresence( Presence presence );
/** /**
* Call this method to promote or demote a user's role in a chatroom. * Call this method to promote or demote a user's role in a chatroom.
...@@ -59,14 +59,14 @@ public interface MUCRole { ...@@ -59,14 +59,14 @@ public interface MUCRole {
* @throws NotAllowedException Thrown if trying to change the moderator role to an owner or * @throws NotAllowedException Thrown if trying to change the moderator role to an owner or
* administrator. * administrator.
*/ */
public void setRole(Role newRole) throws NotAllowedException; void setRole( Role newRole ) throws NotAllowedException;
/** /**
* Obtain the role state of the user. * Obtain the role state of the user.
* *
* @return The role status of this user. * @return The role status of this user.
*/ */
public Role getRole(); Role getRole();
/** /**
* Call this method to promote or demote a user's affiliation in a chatroom. * Call this method to promote or demote a user's affiliation in a chatroom.
...@@ -74,14 +74,14 @@ public interface MUCRole { ...@@ -74,14 +74,14 @@ public interface MUCRole {
* @param newAffiliation the new affiliation that the user will play. * @param newAffiliation the new affiliation that the user will play.
* @throws NotAllowedException thrown if trying to ban an owner or an administrator. * @throws NotAllowedException thrown if trying to ban an owner or an administrator.
*/ */
public void setAffiliation(Affiliation newAffiliation) throws NotAllowedException; void setAffiliation( Affiliation newAffiliation ) throws NotAllowedException;
/** /**
* Obtain the affiliation state of the user. * Obtain the affiliation state of the user.
* *
* @return The affiliation status of this user. * @return The affiliation status of this user.
*/ */
public Affiliation getAffiliation(); Affiliation getAffiliation();
/** /**
* Changes the nickname of the occupant within the room to the new nickname. * Changes the nickname of the occupant within the room to the new nickname.
...@@ -95,13 +95,13 @@ public interface MUCRole { ...@@ -95,13 +95,13 @@ public interface MUCRole {
* *
* @return The user's nickname in the room or null if invisible. * @return The user's nickname in the room or null if invisible.
*/ */
public String getNickname(); String getNickname();
/** /**
* Destroys this role after the occupant left the room. This role will be * Destroys this role after the occupant left the room. This role will be
* removed from MUCUser. * removed from MUCUser.
*/ */
public void destroy(); void destroy();
/** /**
* Returns true if the room occupant does not want to get messages broadcasted to all * Returns true if the room occupant does not want to get messages broadcasted to all
...@@ -128,14 +128,14 @@ public interface MUCRole { ...@@ -128,14 +128,14 @@ public interface MUCRole {
* *
* @return The chatroom hosting this role. * @return The chatroom hosting this role.
*/ */
public MUCRoom getChatRoom(); MUCRoom getChatRoom();
/** /**
* Obtain the XMPPAddress representing this role in a room: room@server/nickname * Obtain the XMPPAddress representing this role in a room: room@server/nickname
* *
* @return The Jabber ID that represents this role in the room. * @return The Jabber ID that represents this role in the room.
*/ */
public JID getRoleAddress(); JID getRoleAddress();
/** /**
* Obtain the XMPPAddress of the user that joined the room. A <tt>null</tt> null value * Obtain the XMPPAddress of the user that joined the room. A <tt>null</tt> null value
...@@ -143,30 +143,30 @@ public interface MUCRole { ...@@ -143,30 +143,30 @@ public interface MUCRole {
* *
* @return The address of the user that joined the room or null if this role belongs to the room itself. * @return The address of the user that joined the room or null if this role belongs to the room itself.
*/ */
public JID getUserAddress(); JID getUserAddress();
/** /**
* Returns true if this room occupant is hosted by this JVM. * Returns true if this room occupant is hosted by this JVM.
* *
* @return true if this room occupant is hosted by this JVM * @return true if this room occupant is hosted by this JVM
*/ */
public boolean isLocal(); boolean isLocal();
/** /**
* Returns the id of the node that is hosting the room occupant. * Returns the id of the node that is hosting the room occupant.
* *
* @return the id of the node that is hosting the room occupant. * @return the id of the node that is hosting the room occupant.
*/ */
public NodeID getNodeID(); NodeID getNodeID();
/** /**
* Sends a packet to the user. * Sends a packet to the user.
* *
* @param packet The packet to send * @param packet The packet to send
*/ */
public void send(Packet packet); void send( Packet packet );
public enum Role { enum Role {
/** /**
* Runs moderated discussions. Is allowed to kick users, grant and revoke voice, etc. * Runs moderated discussions. Is allowed to kick users, grant and revoke voice, etc.
...@@ -220,7 +220,7 @@ public interface MUCRole { ...@@ -220,7 +220,7 @@ public interface MUCRole {
} }
} }
public enum Affiliation { enum Affiliation {
/** /**
* Owner of the room. * Owner of the room.
......
src/java/org/jivesoftware/openfire/muc/MUCRoom.java
View file @ dcea025c
...@@ -291,7 +291,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -291,7 +291,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return length of chat session in milliseconds. * @return length of chat session in milliseconds.
*/ */
public long getChatLength(); long getChatLength();
/** /**
* Adds a new user to the list of owners. The user is the actual creator of the room. Only the * Adds a new user to the list of owners. The user is the actual creator of the room. Only the
...@@ -300,7 +300,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -300,7 +300,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param bareJID The bare JID of the user to add as owner (cannot be <tt>null</tt>). * @param bareJID The bare JID of the user to add as owner (cannot be <tt>null</tt>).
*/ */
public void addFirstOwner(JID bareJID); void addFirstOwner( JID bareJID );
/** /**
* Adds a new user to the list of owners. * Adds a new user to the list of owners.
...@@ -311,7 +311,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -311,7 +311,7 @@ public interface MUCRoom extends Externalizable, Result {
* join the room. * join the room.
* @throws ForbiddenException If the user is not allowed to modify the owner list. * @throws ForbiddenException If the user is not allowed to modify the owner list.
*/ */
public List<Presence> addOwner(JID jid, MUCRole senderRole) throws ForbiddenException; List<Presence> addOwner( JID jid, MUCRole senderRole ) throws ForbiddenException;
/** /**
* Adds a list of users to the list of owners. * Adds a list of users to the list of owners.
...@@ -322,7 +322,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -322,7 +322,7 @@ public interface MUCRoom extends Externalizable, Result {
* join the room. * join the room.
* @throws ForbiddenException If the user is not allowed to modify the owner list. * @throws ForbiddenException If the user is not allowed to modify the owner list.
*/ */
public List<Presence> addOwners(List<JID> newOwners, MUCRole senderRole) List<Presence> addOwners( List<JID> newOwners, MUCRole senderRole )
throws ForbiddenException; throws ForbiddenException;
/** /**
...@@ -335,7 +335,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -335,7 +335,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to modify the admin list. * @throws ForbiddenException If the user is not allowed to modify the admin list.
* @throws ConflictException If the room was going to lose all its owners. * @throws ConflictException If the room was going to lose all its owners.
*/ */
public List<Presence> addAdmins(List<JID> newAdmins, MUCRole senderRole) List<Presence> addAdmins( List<JID> newAdmins, MUCRole senderRole )
throws ForbiddenException, ConflictException; throws ForbiddenException, ConflictException;
/** /**
...@@ -348,7 +348,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -348,7 +348,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to modify the admin list. * @throws ForbiddenException If the user is not allowed to modify the admin list.
* @throws ConflictException If the room was going to lose all its owners. * @throws ConflictException If the room was going to lose all its owners.
*/ */
public List<Presence> addAdmin(JID jid, MUCRole senderRole) throws ForbiddenException, List<Presence> addAdmin( JID jid, MUCRole senderRole ) throws ForbiddenException,
ConflictException; ConflictException;
/** /**
...@@ -363,7 +363,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -363,7 +363,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ConflictException If the desired room nickname is already reserved for the room or if * @throws ConflictException If the desired room nickname is already reserved for the room or if
* the room was going to lose all its owners. * the room was going to lose all its owners.
*/ */
public List<Presence> addMember(JID jid, String nickname, MUCRole senderRole) List<Presence> addMember( JID jid, String nickname, MUCRole senderRole )
throws ForbiddenException, ConflictException; throws ForbiddenException, ConflictException;
/** /**
...@@ -378,7 +378,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -378,7 +378,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to modify the outcast list. * @throws ForbiddenException If the user is not allowed to modify the outcast list.
* @throws ConflictException If the room was going to lose all its owners. * @throws ConflictException If the room was going to lose all its owners.
*/ */
public List<Presence> addOutcast(JID jid, String reason, MUCRole senderRole) List<Presence> addOutcast( JID jid, String reason, MUCRole senderRole )
throws NotAllowedException, ForbiddenException, ConflictException; throws NotAllowedException, ForbiddenException, ConflictException;
/** /**
...@@ -391,7 +391,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -391,7 +391,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to modify the none list. * @throws ForbiddenException If the user is not allowed to modify the none list.
* @throws ConflictException If the room was going to lose all its owners. * @throws ConflictException If the room was going to lose all its owners.
*/ */
public List<Presence> addNone(JID jid, MUCRole senderRole) throws ForbiddenException, List<Presence> addNone( JID jid, MUCRole senderRole ) throws ForbiddenException,
ConflictException; ConflictException;
/** /**
...@@ -404,7 +404,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -404,7 +404,7 @@ public interface MUCRoom extends Externalizable, Result {
* an existing occupant. * an existing occupant.
* @throws ForbiddenException If the user is not allowed to grant moderator privileges. * @throws ForbiddenException If the user is not allowed to grant moderator privileges.
*/ */
public Presence addModerator(JID fullJID, MUCRole senderRole) throws ForbiddenException; Presence addModerator( JID fullJID, MUCRole senderRole ) throws ForbiddenException;
/** /**
* Changes the role of the user within the room to participant. A participant is allowed to send * Changes the role of the user within the room to participant. A participant is allowed to send
...@@ -419,7 +419,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -419,7 +419,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws NotAllowedException If trying to change the moderator role to an owner or an admin. * @throws NotAllowedException If trying to change the moderator role to an owner or an admin.
* @throws ForbiddenException If the user is not allowed to grant participant privileges. * @throws ForbiddenException If the user is not allowed to grant participant privileges.
*/ */
public Presence addParticipant(JID fullJID, String reason, MUCRole senderRole) Presence addParticipant( JID fullJID, String reason, MUCRole senderRole )
throws NotAllowedException, ForbiddenException; throws NotAllowedException, ForbiddenException;
/** /**
...@@ -434,7 +434,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -434,7 +434,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws NotAllowedException if trying to change the moderator role to an owner or an admin. * @throws NotAllowedException if trying to change the moderator role to an owner or an admin.
* @throws ForbiddenException if the user is not a moderator. * @throws ForbiddenException if the user is not a moderator.
*/ */
public Presence addVisitor(JID jid, MUCRole senderRole) throws NotAllowedException, Presence addVisitor( JID jid, MUCRole senderRole ) throws NotAllowedException,
ForbiddenException; ForbiddenException;
/** /**
...@@ -444,7 +444,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -444,7 +444,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if the room is locked. * @return true if the room is locked.
*/ */
public boolean isLocked(); boolean isLocked();
/** /**
* Returns true if the room is locked and it was locked by a room owner after the room was * Returns true if the room is locked and it was locked by a room owner after the room was
...@@ -453,7 +453,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -453,7 +453,7 @@ public interface MUCRoom extends Externalizable, Result {
* @return true if the room is locked and it was locked by a room owner after the room was * @return true if the room is locked and it was locked by a room owner after the room was
* initially configured. * initially configured.
*/ */
public boolean isManuallyLocked(); boolean isManuallyLocked();
/** /**
* An event callback fired whenever an occupant updated his presence in the chatroom. * An event callback fired whenever an occupant updated his presence in the chatroom.
...@@ -461,7 +461,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -461,7 +461,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param occupantRole occupant that changed his presence in the room (cannot be <tt>null</tt>). * @param occupantRole occupant that changed his presence in the room (cannot be <tt>null</tt>).
* @param newPresence presence sent by the occupant (cannot be <tt>null</tt>). * @param newPresence presence sent by the occupant (cannot be <tt>null</tt>).
*/ */
public void presenceUpdated(MUCRole occupantRole, Presence newPresence); void presenceUpdated( MUCRole occupantRole, Presence newPresence );
/** /**
* An event callback fired whenever an occupant changes his nickname within the chatroom. * An event callback fired whenever an occupant changes his nickname within the chatroom.
...@@ -471,7 +471,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -471,7 +471,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param oldNick old nickname within the room (cannot be <tt>null</tt>). * @param oldNick old nickname within the room (cannot be <tt>null</tt>).
* @param newNick new nickname within the room (cannot be <tt>null</tt>). * @param newNick new nickname within the room (cannot be <tt>null</tt>).
*/ */
public void nicknameChanged(MUCRole occupantRole, Presence newPresence, String oldNick, String newNick); void nicknameChanged( MUCRole occupantRole, Presence newPresence, String oldNick, String newNick );
/** /**
* Changes the room's subject if the occupant has enough permissions. The occupant must be * Changes the room's subject if the occupant has enough permissions. The occupant must be
...@@ -484,14 +484,14 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -484,14 +484,14 @@ public interface MUCRoom extends Externalizable, Result {
* @param role the role of the user that is trying to change the subject (cannot be <tt>null</tt>). * @param role the role of the user that is trying to change the subject (cannot be <tt>null</tt>).
* @throws ForbiddenException If the user is not allowed to change the subject. * @throws ForbiddenException If the user is not allowed to change the subject.
*/ */
public void changeSubject(Message packet, MUCRole role) throws ForbiddenException; void changeSubject( Message packet, MUCRole role ) throws ForbiddenException;
/** /**
* Returns the last subject that some occupant set to the room. * Returns the last subject that some occupant set to the room.
* *
* @return the last subject that some occupant set to the room. * @return the last subject that some occupant set to the room.
*/ */
public String getSubject(); String getSubject();
/** /**
* Sets the last subject that some occupant set to the room. This message will only be used * Sets the last subject that some occupant set to the room. This message will only be used
...@@ -499,7 +499,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -499,7 +499,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param subject the last known subject of the room (cannot be <tt>null</tt>). * @param subject the last known subject of the room (cannot be <tt>null</tt>).
*/ */
public void setSubject(String subject); void setSubject( String subject );
/** /**
* Sends a message to the all the occupants. In a moderated room, this privilege is restricted * Sends a message to the all the occupants. In a moderated room, this privilege is restricted
...@@ -511,7 +511,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -511,7 +511,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to send a public message (i.e. does not * @throws ForbiddenException If the user is not allowed to send a public message (i.e. does not
* have voice in the room). * have voice in the room).
*/ */
public void sendPublicMessage(Message message, MUCRole senderRole) throws ForbiddenException; void sendPublicMessage( Message message, MUCRole senderRole ) throws ForbiddenException;
/** /**
* Sends a private packet to a selected occupant. The packet can be a Message for private * Sends a private packet to a selected occupant. The packet can be a Message for private
...@@ -523,7 +523,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -523,7 +523,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws NotFoundException If the user is sending a packet to a room JID that does not exist. * @throws NotFoundException If the user is sending a packet to a room JID that does not exist.
* @throws ForbiddenException If a user of this role is not permitted to send private messages in this room. * @throws ForbiddenException If a user of this role is not permitted to send private messages in this room.
*/ */
public void sendPrivatePacket(Packet packet, MUCRole senderRole) throws NotFoundException, ForbiddenException; void sendPrivatePacket( Packet packet, MUCRole senderRole ) throws NotFoundException, ForbiddenException;
/** /**
* Kicks a user from the room. If the user was in the room, the returned updated presence will * Kicks a user from the room. If the user was in the room, the returned updated presence will
...@@ -536,19 +536,19 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -536,19 +536,19 @@ public interface MUCRoom extends Externalizable, Result {
* @return the updated presence of the kicked user or null if the user was not in the room. * @return the updated presence of the kicked user or null if the user was not in the room.
* @throws NotAllowedException Thrown if trying to ban an owner or an administrator. * @throws NotAllowedException Thrown if trying to ban an owner or an administrator.
*/ */
public Presence kickOccupant(JID fullJID, JID actorJID, String actorNickname, String reason) Presence kickOccupant( JID fullJID, JID actorJID, String actorNickname, String reason )
throws NotAllowedException; throws NotAllowedException;
public IQOwnerHandler getIQOwnerHandler(); IQOwnerHandler getIQOwnerHandler();
public IQAdminHandler getIQAdminHandler(); IQAdminHandler getIQAdminHandler();
/** /**
* Returns the history of the room which includes chat transcripts. * Returns the history of the room which includes chat transcripts.
* *
* @return the history of the room which includes chat transcripts. * @return the history of the room which includes chat transcripts.
*/ */
public MUCRoomHistory getRoomHistory(); MUCRoomHistory getRoomHistory();
/** /**
* Returns a collection with the current list of owners. The collection contains the bareJID of * Returns a collection with the current list of owners. The collection contains the bareJID of
...@@ -556,7 +556,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -556,7 +556,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of owners. * @return a collection with the current list of owners.
*/ */
public Collection<JID> getOwners(); Collection<JID> getOwners();
/** /**
* Returns a collection with the current list of admins. The collection contains the bareJID of * Returns a collection with the current list of admins. The collection contains the bareJID of
...@@ -564,7 +564,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -564,7 +564,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of admins. * @return a collection with the current list of admins.
*/ */
public Collection<JID> getAdmins(); Collection<JID> getAdmins();
/** /**
* Returns a collection with the current list of room members. The collection contains the * Returns a collection with the current list of room members. The collection contains the
...@@ -574,7 +574,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -574,7 +574,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of members. * @return a collection with the current list of members.
*/ */
public Collection<JID> getMembers(); Collection<JID> getMembers();
/** /**
* Returns a collection with the current list of outcast users. An outcast user is not allowed * Returns a collection with the current list of outcast users. An outcast user is not allowed
...@@ -583,7 +583,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -583,7 +583,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of outcast users. * @return a collection with the current list of outcast users.
*/ */
public Collection<JID> getOutcasts(); Collection<JID> getOutcasts();
/** /**
* Returns a collection with the current list of room moderators. The collection contains the * Returns a collection with the current list of room moderators. The collection contains the
...@@ -591,7 +591,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -591,7 +591,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of moderators. * @return a collection with the current list of moderators.
*/ */
public Collection<MUCRole> getModerators(); Collection<MUCRole> getModerators();
/** /**
* Returns a collection with the current list of room participants. The collection contains the * Returns a collection with the current list of room participants. The collection contains the
...@@ -599,7 +599,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -599,7 +599,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a collection with the current list of moderators. * @return a collection with the current list of moderators.
*/ */
public Collection<MUCRole> getParticipants(); Collection<MUCRole> getParticipants();
/** /**
* Returns true if every presence packet will include the JID of every occupant. This * Returns true if every presence packet will include the JID of every occupant. This
...@@ -607,7 +607,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -607,7 +607,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if every presence packet will include the JID of every occupant. * @return true if every presence packet will include the JID of every occupant.
*/ */
public boolean canAnyoneDiscoverJID(); boolean canAnyoneDiscoverJID();
/** /**
* Sets if every presence packet will include the JID of every occupant. This * Sets if every presence packet will include the JID of every occupant. This
...@@ -616,7 +616,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -616,7 +616,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param canAnyoneDiscoverJID boolean that specifies if every presence packet will include the * @param canAnyoneDiscoverJID boolean that specifies if every presence packet will include the
* JID of every occupant. * JID of every occupant.
*/ */
public void setCanAnyoneDiscoverJID(boolean canAnyoneDiscoverJID); void setCanAnyoneDiscoverJID( boolean canAnyoneDiscoverJID );
/** /**
* Returns the minimal role of persons that are allowed to send private messages in the room. The returned value is * Returns the minimal role of persons that are allowed to send private messages in the room. The returned value is
...@@ -624,7 +624,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -624,7 +624,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return The minimal role of persons that are allowed to send private messages in the room (never null). * @return The minimal role of persons that are allowed to send private messages in the room (never null).
*/ */
public String canSendPrivateMessage(); String canSendPrivateMessage();
/** /**
* Sets the minimal role of persons that are allowed to send private messages in the room. The provided value is * Sets the minimal role of persons that are allowed to send private messages in the room. The provided value is
...@@ -632,14 +632,14 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -632,14 +632,14 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param role The minimal role of persons that are allowed to send private messages in the room (never null). * @param role The minimal role of persons that are allowed to send private messages in the room (never null).
*/ */
public void setCanSendPrivateMessage(String role); void setCanSendPrivateMessage( String role );
/** /**
* Returns true if participants are allowed to change the room's subject. * Returns true if participants are allowed to change the room's subject.
* *
* @return true if participants are allowed to change the room's subject. * @return true if participants are allowed to change the room's subject.
*/ */
public boolean canOccupantsChangeSubject(); boolean canOccupantsChangeSubject();
/** /**
* Sets if participants are allowed to change the room's subject. * Sets if participants are allowed to change the room's subject.
...@@ -647,7 +647,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -647,7 +647,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param canOccupantsChangeSubject boolean that specifies if participants are allowed to * @param canOccupantsChangeSubject boolean that specifies if participants are allowed to
* change the room's subject. * change the room's subject.
*/ */
public void setCanOccupantsChangeSubject(boolean canOccupantsChangeSubject); void setCanOccupantsChangeSubject( boolean canOccupantsChangeSubject );
/** /**
* Returns true if occupants can invite other users to the room. If the room does not require an * Returns true if occupants can invite other users to the room. If the room does not require an
...@@ -657,7 +657,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -657,7 +657,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if occupants can invite other users to the room. * @return true if occupants can invite other users to the room.
*/ */
public boolean canOccupantsInvite(); boolean canOccupantsInvite();
/** /**
* Sets if occupants can invite other users to the room. If the room does not require an * Sets if occupants can invite other users to the room. If the room does not require an
...@@ -668,7 +668,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -668,7 +668,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param canOccupantsInvite boolean that specified in any occupant can invite other users to * @param canOccupantsInvite boolean that specified in any occupant can invite other users to
* the room. * the room.
*/ */
public void setCanOccupantsInvite(boolean canOccupantsInvite); void setCanOccupantsInvite( boolean canOccupantsInvite );
/** /**
* Returns the natural language name of the room. This name can only be modified by room owners. * Returns the natural language name of the room. This name can only be modified by room owners.
...@@ -676,7 +676,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -676,7 +676,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return the natural language name of the room. * @return the natural language name of the room.
*/ */
public String getNaturalLanguageName(); String getNaturalLanguageName();
/** /**
* Sets the natural language name of the room. This name can only be modified by room owners. * Sets the natural language name of the room. This name can only be modified by room owners.
...@@ -684,7 +684,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -684,7 +684,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param naturalLanguageName the natural language name of the room. * @param naturalLanguageName the natural language name of the room.
*/ */
public void setNaturalLanguageName(String naturalLanguageName); void setNaturalLanguageName( String naturalLanguageName );
/** /**
* Returns a description set by the room's owners about the room. This information will be used * Returns a description set by the room's owners about the room. This information will be used
...@@ -692,7 +692,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -692,7 +692,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return a description set by the room's owners about the room. * @return a description set by the room's owners about the room.
*/ */
public String getDescription(); String getDescription();
/** /**
* Sets a description set by the room's owners about the room. This information will be used * Sets a description set by the room's owners about the room. This information will be used
...@@ -700,7 +700,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -700,7 +700,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param description a description set by the room's owners about the room. * @param description a description set by the room's owners about the room.
*/ */
public void setDescription(String description); void setDescription( String description );
/** /**
* Returns true if the room requires an invitation to enter. That is if the room is * Returns true if the room requires an invitation to enter. That is if the room is
...@@ -708,7 +708,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -708,7 +708,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if the room requires an invitation to enter. * @return true if the room requires an invitation to enter.
*/ */
public boolean isMembersOnly(); boolean isMembersOnly();
/** /**
* Sets if the room requires an invitation to enter. That is if the room is members-only. * Sets if the room requires an invitation to enter. That is if the room is members-only.
...@@ -717,7 +717,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -717,7 +717,7 @@ public interface MUCRoom extends Externalizable, Result {
* @return the list of updated presences of all the occupants that aren't members of the room if * @return the list of updated presences of all the occupants that aren't members of the room if
* the room is now members-only. * the room is now members-only.
*/ */
public List<Presence> setMembersOnly(boolean membersOnly); List<Presence> setMembersOnly( boolean membersOnly );
/** /**
* Returns true if the room's conversation is being logged. If logging is activated the room * Returns true if the room's conversation is being logged. If logging is activated the room
...@@ -727,7 +727,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -727,7 +727,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if the room's conversation is being logged. * @return true if the room's conversation is being logged.
*/ */
public boolean isLogEnabled(); boolean isLogEnabled();
/** /**
* Sets if the room's conversation is being logged. If logging is activated the room * Sets if the room's conversation is being logged. If logging is activated the room
...@@ -737,7 +737,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -737,7 +737,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param logEnabled boolean that specified if the room's conversation must be logged. * @param logEnabled boolean that specified if the room's conversation must be logged.
*/ */
public void setLogEnabled(boolean logEnabled); void setLogEnabled( boolean logEnabled );
/** /**
* Returns true if registered users can only join the room using their registered nickname. By * Returns true if registered users can only join the room using their registered nickname. By
...@@ -747,7 +747,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -747,7 +747,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if registered users can only join the room using their registered nickname. * @return true if registered users can only join the room using their registered nickname.
*/ */
public boolean isLoginRestrictedToNickname(); boolean isLoginRestrictedToNickname();
/** /**
* Sets if registered users can only join the room using their registered nickname. A * Sets if registered users can only join the room using their registered nickname. A
...@@ -756,7 +756,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -756,7 +756,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param restricted if registered users can only join the room using their registered nickname. * @param restricted if registered users can only join the room using their registered nickname.
*/ */
public void setLoginRestrictedToNickname(boolean restricted); void setLoginRestrictedToNickname( boolean restricted );
/** /**
* Returns true if room occupants are allowed to change their nicknames in the room. By * Returns true if room occupants are allowed to change their nicknames in the room. By
...@@ -768,7 +768,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -768,7 +768,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if room occupants are allowed to change their nicknames in the room. * @return true if room occupants are allowed to change their nicknames in the room.
*/ */
public boolean canChangeNickname(); boolean canChangeNickname();
/** /**
* Sets if room occupants are allowed to change their nicknames in the room. By default, * Sets if room occupants are allowed to change their nicknames in the room. By default,
...@@ -780,7 +780,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -780,7 +780,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param canChange if room occupants are allowed to change their nicknames in the room. * @param canChange if room occupants are allowed to change their nicknames in the room.
*/ */
public void setChangeNickname(boolean canChange); void setChangeNickname( boolean canChange );
/** /**
* Returns true if users are allowed to register with the room. By default, room registration * Returns true if users are allowed to register with the room. By default, room registration
...@@ -789,7 +789,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -789,7 +789,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if users are allowed to register with the room. * @return true if users are allowed to register with the room.
*/ */
public boolean isRegistrationEnabled(); boolean isRegistrationEnabled();
/** /**
* Sets if users are allowed to register with the room. By default, room registration * Sets if users are allowed to register with the room. By default, room registration
...@@ -798,7 +798,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -798,7 +798,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param registrationEnabled if users are allowed to register with the room. * @param registrationEnabled if users are allowed to register with the room.
*/ */
public void setRegistrationEnabled(boolean registrationEnabled); void setRegistrationEnabled( boolean registrationEnabled );
/** /**
* Returns the maximum number of occupants that can be simultaneously in the room. If the number * Returns the maximum number of occupants that can be simultaneously in the room. If the number
...@@ -807,7 +807,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -807,7 +807,7 @@ public interface MUCRoom extends Externalizable, Result {
* @return the maximum number of occupants that can be simultaneously in the room. Zero means * @return the maximum number of occupants that can be simultaneously in the room. Zero means
* unlimited number of occupants. * unlimited number of occupants.
*/ */
public int getMaxUsers(); int getMaxUsers();
/** /**
* Sets the maximum number of occupants that can be simultaneously in the room. If the number * Sets the maximum number of occupants that can be simultaneously in the room. If the number
...@@ -816,14 +816,14 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -816,14 +816,14 @@ public interface MUCRoom extends Externalizable, Result {
* @param maxUsers the maximum number of occupants that can be simultaneously in the room. Zero * @param maxUsers the maximum number of occupants that can be simultaneously in the room. Zero
* means unlimited number of occupants. * means unlimited number of occupants.
*/ */
public void setMaxUsers(int maxUsers); void setMaxUsers( int maxUsers );
/** /**
* Returns if the room in which only those with "voice" may send messages to all occupants. * Returns if the room in which only those with "voice" may send messages to all occupants.
* *
* @return if the room in which only those with "voice" may send messages to all occupants. * @return if the room in which only those with "voice" may send messages to all occupants.
*/ */
public boolean isModerated(); boolean isModerated();
/** /**
* Sets if the room in which only those with "voice" may send messages to all occupants. * Sets if the room in which only those with "voice" may send messages to all occupants.
...@@ -831,28 +831,28 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -831,28 +831,28 @@ public interface MUCRoom extends Externalizable, Result {
* @param moderated if the room in which only those with "voice" may send messages to all * @param moderated if the room in which only those with "voice" may send messages to all
* occupants. * occupants.
*/ */
public void setModerated(boolean moderated); void setModerated( boolean moderated );
/** /**
* Returns true if a user cannot enter without first providing the correct password. * Returns true if a user cannot enter without first providing the correct password.
* *
* @return true if a user cannot enter without first providing the correct password. * @return true if a user cannot enter without first providing the correct password.
*/ */
public boolean isPasswordProtected(); boolean isPasswordProtected();
/** /**
* Returns the password that the user must provide to enter the room. * Returns the password that the user must provide to enter the room.
* *
* @return the password that the user must provide to enter the room. * @return the password that the user must provide to enter the room.
*/ */
public String getPassword(); String getPassword();
/** /**
* Sets the password that the user must provide to enter the room. * Sets the password that the user must provide to enter the room.
* *
* @param password the password that the user must provide to enter the room. * @param password the password that the user must provide to enter the room.
*/ */
public void setPassword(String password); void setPassword( String password );
/** /**
* Returns true if the room is not destroyed if the last occupant exits. Persistent rooms are * Returns true if the room is not destroyed if the last occupant exits. Persistent rooms are
...@@ -861,7 +861,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -861,7 +861,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if the room is not destroyed if the last occupant exits. * @return true if the room is not destroyed if the last occupant exits.
*/ */
public boolean isPersistent(); boolean isPersistent();
/** /**
* Sets if the room is not destroyed if the last occupant exits. Persistent rooms are * Sets if the room is not destroyed if the last occupant exits. Persistent rooms are
...@@ -870,7 +870,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -870,7 +870,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @param persistent if the room is not destroyed if the last occupant exits. * @param persistent if the room is not destroyed if the last occupant exits.
*/ */
public void setPersistent(boolean persistent); void setPersistent( boolean persistent );
/** /**
* Returns true if the room has already been made persistent. If the room is temporary the * Returns true if the room has already been made persistent. If the room is temporary the
...@@ -878,34 +878,34 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -878,34 +878,34 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return true if the room has already been made persistent. * @return true if the room has already been made persistent.
*/ */
public boolean wasSavedToDB(); boolean wasSavedToDB();
/** /**
* Sets if the room has already been made persistent. * Sets if the room has already been made persistent.
* *
* @param saved boolean that indicates if the room was saved to the database. * @param saved boolean that indicates if the room was saved to the database.
*/ */
public void setSavedToDB(boolean saved); void setSavedToDB( boolean saved );
/** /**
* Saves the room configuration to the DB. After the room has been saved to the DB it will * Saves the room configuration to the DB. After the room has been saved to the DB it will
* become persistent. * become persistent.
*/ */
public void saveToDB(); void saveToDB();
/** /**
* Returns true if the room is searchable and visible through service discovery. * Returns true if the room is searchable and visible through service discovery.
* *
* @return true if the room is searchable and visible through service discovery. * @return true if the room is searchable and visible through service discovery.
*/ */
public boolean isPublicRoom(); boolean isPublicRoom();
/** /**
* Sets if the room is searchable and visible through service discovery. * Sets if the room is searchable and visible through service discovery.
* *
* @param publicRoom if the room is searchable and visible through service discovery. * @param publicRoom if the room is searchable and visible through service discovery.
*/ */
public void setPublicRoom(boolean publicRoom); void setPublicRoom( boolean publicRoom );
/** /**
* Returns the list of roles of which presence will be broadcasted to the rest of the occupants. * Returns the list of roles of which presence will be broadcasted to the rest of the occupants.
...@@ -913,7 +913,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -913,7 +913,7 @@ public interface MUCRoom extends Externalizable, Result {
* *
* @return the list of roles of which presence will be broadcasted to the rest of the occupants. * @return the list of roles of which presence will be broadcasted to the rest of the occupants.
*/ */
public List<String> getRolesToBroadcastPresence(); List<String> getRolesToBroadcastPresence();
/** /**
* Sets the list of roles of which presence will be broadcasted to the rest of the occupants. * Sets the list of roles of which presence will be broadcasted to the rest of the occupants.
...@@ -922,7 +922,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -922,7 +922,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param rolesToBroadcastPresence the list of roles of which presence will be broadcasted to * @param rolesToBroadcastPresence the list of roles of which presence will be broadcasted to
* the rest of the occupants. * the rest of the occupants.
*/ */
public void setRolesToBroadcastPresence(List<String> rolesToBroadcastPresence); void setRolesToBroadcastPresence( List<String> rolesToBroadcastPresence );
/** /**
* Returns true if the presences of the requested role will be broadcasted. * Returns true if the presences of the requested role will be broadcasted.
...@@ -930,7 +930,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -930,7 +930,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param roleToBroadcast the role to check if its presences will be broadcasted. * @param roleToBroadcast the role to check if its presences will be broadcasted.
* @return true if the presences of the requested role will be broadcasted. * @return true if the presences of the requested role will be broadcasted.
*/ */
public boolean canBroadcastPresence(String roleToBroadcast); boolean canBroadcastPresence( String roleToBroadcast );
/** /**
* Locks the room so that users cannot join the room. Only the owner of the room can lock/unlock * Locks the room so that users cannot join the room. Only the owner of the room can lock/unlock
...@@ -939,7 +939,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -939,7 +939,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param senderRole the role of the occupant that locked the room. * @param senderRole the role of the occupant that locked the room.
* @throws ForbiddenException If the user is not an owner of the room. * @throws ForbiddenException If the user is not an owner of the room.
*/ */
public void lock(MUCRole senderRole) throws ForbiddenException; void lock( MUCRole senderRole ) throws ForbiddenException;
/** /**
* Unlocks the room so that users can join the room. The room is locked when created and only * Unlocks the room so that users can join the room. The room is locked when created and only
...@@ -949,7 +949,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -949,7 +949,7 @@ public interface MUCRoom extends Externalizable, Result {
* @param senderRole the role of the occupant that unlocked the room. * @param senderRole the role of the occupant that unlocked the room.
* @throws ForbiddenException If the user is not an owner of the room. * @throws ForbiddenException If the user is not an owner of the room.
*/ */
public void unlock(MUCRole senderRole) throws ForbiddenException; void unlock( MUCRole senderRole ) throws ForbiddenException;
/** /**
* Sends an invitation to a user. The invitation will be sent as if the room is inviting the * Sends an invitation to a user. The invitation will be sent as if the room is inviting the
...@@ -966,7 +966,7 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -966,7 +966,7 @@ public interface MUCRoom extends Externalizable, Result {
* @throws ForbiddenException If the user is not allowed to send the invitation. * @throws ForbiddenException If the user is not allowed to send the invitation.
* @throws CannotBeInvitedException (Optionally) If the user being invited does not have access to the room * @throws CannotBeInvitedException (Optionally) If the user being invited does not have access to the room
*/ */
public void sendInvitation(JID to, String reason, MUCRole role, List<Element> extensions) void sendInvitation( JID to, String reason, MUCRole role, List<Element> extensions )
throws ForbiddenException, CannotBeInvitedException; throws ForbiddenException, CannotBeInvitedException;
/** /**
...@@ -980,12 +980,12 @@ public interface MUCRoom extends Externalizable, Result { ...@@ -980,12 +980,12 @@ public interface MUCRoom extends Externalizable, Result {
* @param reason the reason for the rejection or null if none. * @param reason the reason for the rejection or null if none.
* @param from the JID of the invitee that is rejecting the invitation. * @param from the JID of the invitee that is rejecting the invitation.
*/ */
public void sendInvitationRejection(JID to, String reason, JID from); void sendInvitationRejection( JID to, String reason, JID from );
/** /**
* Sends a packet to the user. * Sends a packet to the user.
* *
* @param packet The packet to send * @param packet The packet to send
*/ */
public void send(Packet packet); void send( Packet packet );
} }
src/java/org/jivesoftware/openfire/muc/MUCUser.java
View file @ dcea025c
...@@ -44,5 +44,5 @@ public interface MUCUser extends ChannelHandler<Packet> { ...@@ -44,5 +44,5 @@ public interface MUCUser extends ChannelHandler<Packet> {
* *
* @return the address of the packet handler. * @return the address of the packet handler.
*/ */
public JID getAddress(); JID getAddress();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/muc/MultiUserChatService.java
View file @ dcea025c
...@@ -270,7 +270,7 @@ public interface MultiUserChatService extends Component { ...@@ -270,7 +270,7 @@ public interface MultiUserChatService extends Component {
* *
* @param room the removed room in another cluster node. * @param room the removed room in another cluster node.
*/ */
public void chatRoomRemoved(LocalMUCRoom room); void chatRoomRemoved( LocalMUCRoom room );
/** /**
* Notification message indicating that a chat room has been created * Notification message indicating that a chat room has been created
...@@ -278,7 +278,7 @@ public interface MultiUserChatService extends Component { ...@@ -278,7 +278,7 @@ public interface MultiUserChatService extends Component {
* *
* @param room the created room in another cluster node. * @param room the created room in another cluster node.
*/ */
public void chatRoomAdded(LocalMUCRoom room); void chatRoomAdded( LocalMUCRoom room );
/** /**
* Removes the room associated with the given name. * Removes the room associated with the given name.
...@@ -303,7 +303,7 @@ public interface MultiUserChatService extends Component { ...@@ -303,7 +303,7 @@ public interface MultiUserChatService extends Component {
* *
* @return total chat time in milliseconds. * @return total chat time in milliseconds.
*/ */
public long getTotalChatTime(); long getTotalChatTime();
/** /**
* Retuns the number of existing rooms in the server (i.e. persistent or not, * Retuns the number of existing rooms in the server (i.e. persistent or not,
...@@ -311,7 +311,7 @@ public interface MultiUserChatService extends Component { ...@@ -311,7 +311,7 @@ public interface MultiUserChatService extends Component {
* *
* @return the number of existing rooms in the server. * @return the number of existing rooms in the server.
*/ */
public int getNumberChatRooms(); int getNumberChatRooms();
/** /**
* Retuns the total number of occupants in all rooms in the server. * Retuns the total number of occupants in all rooms in the server.
...@@ -319,14 +319,14 @@ public interface MultiUserChatService extends Component { ...@@ -319,14 +319,14 @@ public interface MultiUserChatService extends Component {
* @param onlyLocal true if only users connected to this JVM will be considered. Otherwise count cluster wise. * @param onlyLocal true if only users connected to this JVM will be considered. Otherwise count cluster wise.
* @return the number of existing rooms in the server. * @return the number of existing rooms in the server.
*/ */
public int getNumberConnectedUsers(boolean onlyLocal); int getNumberConnectedUsers( boolean onlyLocal );
/** /**
* Retuns the total number of users that have joined in all rooms in the server. * Retuns the total number of users that have joined in all rooms in the server.
* *
* @return the number of existing rooms in the server. * @return the number of existing rooms in the server.
*/ */
public int getNumberRoomOccupants(); int getNumberRoomOccupants();
/** /**
* Returns the total number of incoming messages since last reset. * Returns the total number of incoming messages since last reset.
...@@ -334,7 +334,7 @@ public interface MultiUserChatService extends Component { ...@@ -334,7 +334,7 @@ public interface MultiUserChatService extends Component {
* @param resetAfter True if you want the counter to be reset after results returned. * @param resetAfter True if you want the counter to be reset after results returned.
* @return the number of incoming messages through the service. * @return the number of incoming messages through the service.
*/ */
public long getIncomingMessageCount(boolean resetAfter); long getIncomingMessageCount( boolean resetAfter );
/** /**
* Returns the total number of outgoing messages since last reset. * Returns the total number of outgoing messages since last reset.
...@@ -342,7 +342,7 @@ public interface MultiUserChatService extends Component { ...@@ -342,7 +342,7 @@ public interface MultiUserChatService extends Component {
* @param resetAfter True if you want the counter to be reset after results returned. * @param resetAfter True if you want the counter to be reset after results returned.
* @return the number of outgoing messages through the service. * @return the number of outgoing messages through the service.
*/ */
public long getOutgoingMessageCount(boolean resetAfter); long getOutgoingMessageCount( boolean resetAfter );
/** /**
* Logs that a given message was sent to a room as part of a conversation. Every message sent * Logs that a given message was sent to a room as part of a conversation. Every message sent
......
src/java/org/jivesoftware/openfire/muc/spi/MUCServicePropertyEventListener.java
View file @ dcea025c
...@@ -35,7 +35,7 @@ public interface MUCServicePropertyEventListener { ...@@ -35,7 +35,7 @@ public interface MUCServicePropertyEventListener {
* @param property the name of the property. * @param property the name of the property.
* @param params event parameters. * @param params event parameters.
*/ */
public void propertySet(String service, String property, Map<String, Object> params); void propertySet( String service, String property, Map<String, Object> params );
/** /**
* A property was deleted. * A property was deleted.
...@@ -44,6 +44,6 @@ public interface MUCServicePropertyEventListener { ...@@ -44,6 +44,6 @@ public interface MUCServicePropertyEventListener {
* @param property the name of the property deleted. * @param property the name of the property deleted.
* @param params event parameters. * @param params event parameters.
*/ */
public void propertyDeleted(String service, String property, Map<String, Object> params); void propertyDeleted( String service, String property, Map<String, Object> params );
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/privacy/PrivacyListEventListener.java
View file @ dcea025c
...@@ -31,19 +31,19 @@ public interface PrivacyListEventListener { ...@@ -31,19 +31,19 @@ public interface PrivacyListEventListener {
* *
* @param list the privacy list. * @param list the privacy list.
*/ */
public void privacyListCreated(PrivacyList list); void privacyListCreated( PrivacyList list );
/** /**
* A privacy list is being deleted. * A privacy list is being deleted.
* *
* @param listName name of the the privacy list that has been deleted. * @param listName name of the the privacy list that has been deleted.
*/ */
public void privacyListDeleting(String listName); void privacyListDeleting( String listName );
/** /**
* Properties of the privacy list were changed. * Properties of the privacy list were changed.
* *
* @param list the privacy list. * @param list the privacy list.
*/ */
public void privacyListModified(PrivacyList list); void privacyListModified( PrivacyList list );
} }
src/java/org/jivesoftware/openfire/resultsetmanager/Result.java
View file @ dcea025c
...@@ -43,6 +43,6 @@ public interface Result { ...@@ -43,6 +43,6 @@ public interface Result {
* *
* @return Unique ID of the Result * @return Unique ID of the Result
*/ */
public String getUID(); String getUID();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/roster/RosterEventListener.java
View file @ dcea025c
...@@ -30,7 +30,7 @@ public interface RosterEventListener { ...@@ -30,7 +30,7 @@ public interface RosterEventListener {
* *
* @param roster the loaded roster. * @param roster the loaded roster.
*/ */
public void rosterLoaded(Roster roster); void rosterLoaded( Roster roster );
/** /**
* Notification message indicating that a contact is about to be added to a roster. New * Notification message indicating that a contact is about to be added to a roster. New
...@@ -43,7 +43,7 @@ public interface RosterEventListener { ...@@ -43,7 +43,7 @@ public interface RosterEventListener {
* @param persistent true if the new contact is going to be saved to the database. * @param persistent true if the new contact is going to be saved to the database.
* @return false if the contact should not be persisted to the database. * @return false if the contact should not be persisted to the database.
*/ */
public boolean addingContact(Roster roster, RosterItem item, boolean persistent); boolean addingContact( Roster roster, RosterItem item, boolean persistent );
/** /**
* Notification message indicating that a contact has been added to a roster. * Notification message indicating that a contact has been added to a roster.
...@@ -51,7 +51,7 @@ public interface RosterEventListener { ...@@ -51,7 +51,7 @@ public interface RosterEventListener {
* @param roster the roster that was updated. * @param roster the roster that was updated.
* @param item the new roster item. * @param item the new roster item.
*/ */
public void contactAdded(Roster roster, RosterItem item); void contactAdded( Roster roster, RosterItem item );
/** /**
* Notification message indicating that a contact has been updated. * Notification message indicating that a contact has been updated.
...@@ -59,7 +59,7 @@ public interface RosterEventListener { ...@@ -59,7 +59,7 @@ public interface RosterEventListener {
* @param roster the roster that was updated. * @param roster the roster that was updated.
* @param item the updated roster item. * @param item the updated roster item.
*/ */
public void contactUpdated(Roster roster, RosterItem item); void contactUpdated( Roster roster, RosterItem item );
/** /**
* Notification message indicating that a contact has been deleted from a roster. * Notification message indicating that a contact has been deleted from a roster.
...@@ -67,5 +67,5 @@ public interface RosterEventListener { ...@@ -67,5 +67,5 @@ public interface RosterEventListener {
* @param roster the roster that was updated. * @param roster the roster that was updated.
* @param item the roster item that was deleted. * @param item the roster item that was deleted.
*/ */
public void contactDeleted(Roster roster, RosterItem item); void contactDeleted( Roster roster, RosterItem item );
} }
src/java/org/jivesoftware/openfire/security/SecurityAuditProvider.java
View file @ dcea025c
...@@ -34,7 +34,7 @@ public interface SecurityAuditProvider { ...@@ -34,7 +34,7 @@ public interface SecurityAuditProvider {
* @param summary Short description of the event, similar to a subject. * @param summary Short description of the event, similar to a subject.
* @param details Detailed description of the event, can be null if not desired. * @param details Detailed description of the event, can be null if not desired.
*/ */
public void logEvent(String username, String summary, String details); void logEvent( String username, String summary, String details );
/** /**
* Retrieves security events that have occurred, filtered by the parameters passed. * Retrieves security events that have occurred, filtered by the parameters passed.
...@@ -51,7 +51,7 @@ public interface SecurityAuditProvider { ...@@ -51,7 +51,7 @@ public interface SecurityAuditProvider {
* @param endTime Most recent date of range of events to retrieve. Can be null for "now". * @param endTime Most recent date of range of events to retrieve. Can be null for "now".
* @return Array of security events. * @return Array of security events.
*/ */
public List<SecurityAuditEvent> getEvents(String username, Integer skipEvents, Integer numEvents, Date startTime, Date endTime); List<SecurityAuditEvent> getEvents( String username, Integer skipEvents, Integer numEvents, Date startTime, Date endTime );
/** /**
* Retrieves a specific event by ID. The provider is expected to create and fill out to * Retrieves a specific event by ID. The provider is expected to create and fill out to
...@@ -61,14 +61,14 @@ public interface SecurityAuditProvider { ...@@ -61,14 +61,14 @@ public interface SecurityAuditProvider {
* @return SecurityAuditEvent object with information from retrieved event. * @return SecurityAuditEvent object with information from retrieved event.
* @throws EventNotFoundException if event was not found. * @throws EventNotFoundException if event was not found.
*/ */
public SecurityAuditEvent getEvent(Integer msgID) throws EventNotFoundException; SecurityAuditEvent getEvent( Integer msgID ) throws EventNotFoundException;
/** /**
* Retrieves number of events recorded. * Retrieves number of events recorded.
* *
* @return Number of events that have been recorded. * @return Number of events that have been recorded.
*/ */
public Integer getEventCount(); Integer getEventCount();
/** /**
* Returns true if the provider logs can be read by Openfire for display from Openfire's * Returns true if the provider logs can be read by Openfire for display from Openfire's
...@@ -80,7 +80,7 @@ public interface SecurityAuditProvider { ...@@ -80,7 +80,7 @@ public interface SecurityAuditProvider {
* @see #getAuditURL() * @see #getAuditURL()
* @return True or false if the logs can be read remotely. * @return True or false if the logs can be read remotely.
*/ */
public boolean isWriteOnly(); boolean isWriteOnly();
/** /**
* Retrieves a URL that can be visited to read the logs audited by this provider. This * Retrieves a URL that can be visited to read the logs audited by this provider. This
...@@ -93,7 +93,7 @@ public interface SecurityAuditProvider { ...@@ -93,7 +93,7 @@ public interface SecurityAuditProvider {
* @see #isWriteOnly() * @see #isWriteOnly()
* @return String represented URL that can be visited to view the audit logs. * @return String represented URL that can be visited to view the audit logs.
*/ */
public String getAuditURL(); String getAuditURL();
/** /**
* Returns true if the provider should not send user change (create, edit, delete, etc) related * Returns true if the provider should not send user change (create, edit, delete, etc) related
...@@ -102,7 +102,7 @@ public interface SecurityAuditProvider { ...@@ -102,7 +102,7 @@ public interface SecurityAuditProvider {
* *
* @return True if we should block user related security audit events from being handled. * @return True if we should block user related security audit events from being handled.
*/ */
public boolean blockUserEvents(); boolean blockUserEvents();
/** /**
* Returns true if the provider should not send group change (create, edit, delete, etc) related * Returns true if the provider should not send group change (create, edit, delete, etc) related
...@@ -111,6 +111,6 @@ public interface SecurityAuditProvider { ...@@ -111,6 +111,6 @@ public interface SecurityAuditProvider {
* *
* @return True if we should block group related security audit events from being handled. * @return True if we should block group related security audit events from being handled.
*/ */
public boolean blockGroupEvents(); boolean blockGroupEvents();
} }
src/java/org/jivesoftware/openfire/session/ClientSession.java
View file @ dcea025c
...@@ -33,7 +33,7 @@ public interface ClientSession extends Session { ...@@ -33,7 +33,7 @@ public interface ClientSession extends Session {
* *
* @return the Privacy list that overrides the default privacy list. * @return the Privacy list that overrides the default privacy list.
*/ */
public PrivacyList getActiveList(); PrivacyList getActiveList();
/** /**
* Sets the Privacy list that overrides the default privacy list. This list affects * Sets the Privacy list that overrides the default privacy list. This list affects
...@@ -41,7 +41,7 @@ public interface ClientSession extends Session { ...@@ -41,7 +41,7 @@ public interface ClientSession extends Session {
* *
* @param activeList the Privacy list that overrides the default privacy list. * @param activeList the Privacy list that overrides the default privacy list.
*/ */
public void setActiveList(PrivacyList activeList); void setActiveList( PrivacyList activeList );
/** /**
* Returns the default Privacy list used for the session's user. This list is * Returns the default Privacy list used for the session's user. This list is
...@@ -49,7 +49,7 @@ public interface ClientSession extends Session { ...@@ -49,7 +49,7 @@ public interface ClientSession extends Session {
* *
* @return the default Privacy list used for the session's user. * @return the default Privacy list used for the session's user.
*/ */
public PrivacyList getDefaultList(); PrivacyList getDefaultList();
/** /**
* Sets the default Privacy list used for the session's user. This list is * Sets the default Privacy list used for the session's user. This list is
...@@ -57,7 +57,7 @@ public interface ClientSession extends Session { ...@@ -57,7 +57,7 @@ public interface ClientSession extends Session {
* *
* @param defaultList the default Privacy list used for the session's user. * @param defaultList the default Privacy list used for the session's user.
*/ */
public void setDefaultList(PrivacyList defaultList); void setDefaultList( PrivacyList defaultList );
/** /**
* Returns the username associated with this session. Use this information * Returns the username associated with this session. Use this information
...@@ -67,7 +67,7 @@ public interface ClientSession extends Session { ...@@ -67,7 +67,7 @@ public interface ClientSession extends Session {
* @throws UserNotFoundException if a user is not associated with a session * @throws UserNotFoundException if a user is not associated with a session
* (the session has not authenticated yet) * (the session has not authenticated yet)
*/ */
public String getUsername() throws UserNotFoundException; String getUsername() throws UserNotFoundException;
/** /**
* Returns true if the authetnicated user is an anonymous user or if * Returns true if the authetnicated user is an anonymous user or if
...@@ -88,7 +88,7 @@ public interface ClientSession extends Session { ...@@ -88,7 +88,7 @@ public interface ClientSession extends Session {
* *
* @return True if the session has already been initializsed * @return True if the session has already been initializsed
*/ */
public boolean isInitialized(); boolean isInitialized();
/** /**
* Sets the initialization state of the session. * Sets the initialization state of the session.
...@@ -96,7 +96,7 @@ public interface ClientSession extends Session { ...@@ -96,7 +96,7 @@ public interface ClientSession extends Session {
* @param isInit True if the session has been initialized * @param isInit True if the session has been initialized
* @see #isInitialized * @see #isInitialized
*/ */
public void setInitialized(boolean isInit); void setInitialized( boolean isInit );
/** /**
* Returns true if the offline messages of the user should be sent to the user when * Returns true if the offline messages of the user should be sent to the user when
...@@ -108,7 +108,7 @@ public interface ClientSession extends Session { ...@@ -108,7 +108,7 @@ public interface ClientSession extends Session {
* @return true if the offline messages of the user should be sent to the user when the user * @return true if the offline messages of the user should be sent to the user when the user
* becomes online. * becomes online.
*/ */
public boolean canFloodOfflineMessages(); boolean canFloodOfflineMessages();
/** /**
* Returns true if the user requested to not receive offline messages when sending * Returns true if the user requested to not receive offline messages when sending
...@@ -120,28 +120,28 @@ public interface ClientSession extends Session { ...@@ -120,28 +120,28 @@ public interface ClientSession extends Session {
* @return true if the user requested to not receive offline messages when sending * @return true if the user requested to not receive offline messages when sending
* an available presence. * an available presence.
*/ */
public boolean isOfflineFloodStopped(); boolean isOfflineFloodStopped();
/** /**
* Obtain the presence of this session. * Obtain the presence of this session.
* *
* @return The presence of this session or null if not authenticated * @return The presence of this session or null if not authenticated
*/ */
public Presence getPresence(); Presence getPresence();
/** /**
* Set the presence of this session * Set the presence of this session
* *
* @param presence The presence for the session * @param presence The presence for the session
*/ */
public void setPresence(Presence presence); void setPresence( Presence presence );
/** /**
* Increments the conflict by one and returns new number of conflicts detected on this session. * Increments the conflict by one and returns new number of conflicts detected on this session.
* *
* @return the new number of conflicts detected on this session. * @return the new number of conflicts detected on this session.
*/ */
public int incrementConflictCount(); int incrementConflictCount();
/** /**
* Indicates, whether message carbons are enabled. * Indicates, whether message carbons are enabled.
......
src/java/org/jivesoftware/openfire/session/ComponentSession.java
View file @ dcea025c
...@@ -26,7 +26,7 @@ import java.util.Collection; ...@@ -26,7 +26,7 @@ import java.util.Collection;
*/ */
public interface ComponentSession extends Session { public interface ComponentSession extends Session {
public ExternalComponent getExternalComponent(); ExternalComponent getExternalComponent();
/** /**
* The ExternalComponent acts as a proxy of the remote connected component. Any Packet that is * The ExternalComponent acts as a proxy of the remote connected component. Any Packet that is
...@@ -40,7 +40,7 @@ public interface ComponentSession extends Session { ...@@ -40,7 +40,7 @@ public interface ComponentSession extends Session {
* *
* @author Gaston Dombiak * @author Gaston Dombiak
*/ */
public interface ExternalComponent extends Component { interface ExternalComponent extends Component {
void setName(String name); void setName(String name);
String getType(); String getType();
......
src/java/org/jivesoftware/openfire/session/IncomingServerSession.java
View file @ dcea025c
...@@ -48,7 +48,7 @@ public interface IncomingServerSession extends ServerSession { ...@@ -48,7 +48,7 @@ public interface IncomingServerSession extends ServerSession {
* *
* @return domains, subdomains and virtual hosts that where validated. * @return domains, subdomains and virtual hosts that where validated.
*/ */
public Collection<String> getValidatedDomains(); Collection<String> getValidatedDomains();
/** /**
* Returns the domain or subdomain of the local server used by the remote server * Returns the domain or subdomain of the local server used by the remote server
...@@ -59,5 +59,5 @@ public interface IncomingServerSession extends ServerSession { ...@@ -59,5 +59,5 @@ public interface IncomingServerSession extends ServerSession {
* @return the domain or subdomain of the local server used by the remote server * @return the domain or subdomain of the local server used by the remote server
* when validating the session. * when validating the session.
*/ */
public String getLocalDomain(); String getLocalDomain();
} }
src/java/org/jivesoftware/openfire/session/Session.java
View file @ dcea025c
...@@ -41,12 +41,12 @@ public interface Session extends RoutableChannelHandler { ...@@ -41,12 +41,12 @@ public interface Session extends RoutableChannelHandler {
/** /**
* Version of the XMPP spec supported as MAJOR_VERSION.MINOR_VERSION (e.g. 1.0). * Version of the XMPP spec supported as MAJOR_VERSION.MINOR_VERSION (e.g. 1.0).
*/ */
public static final int MAJOR_VERSION = 1; int MAJOR_VERSION = 1;
public static final int MINOR_VERSION = 0; int MINOR_VERSION = 0;
public static final int STATUS_CLOSED = -1; int STATUS_CLOSED = -1;
public static final int STATUS_CONNECTED = 1; int STATUS_CONNECTED = 1;
public static final int STATUS_AUTHENTICATED = 3; int STATUS_AUTHENTICATED = 3;
/** /**
* Obtain the address of the user. The address is used by services like the core * Obtain the address of the user. The address is used by services like the core
...@@ -57,14 +57,14 @@ public interface Session extends RoutableChannelHandler { ...@@ -57,14 +57,14 @@ public interface Session extends RoutableChannelHandler {
* @return the address of the packet handler. * @return the address of the packet handler.
*/ */
@Override @Override
public JID getAddress(); JID getAddress();
/** /**
* Obtain the current status of this session. * Obtain the current status of this session.
* *
* @return The status code for this session * @return The status code for this session
*/ */
public int getStatus(); int getStatus();
/** /**
* Obtain the stream ID associated with this sesison. Stream ID's are generated by the server * Obtain the stream ID associated with this sesison. Stream ID's are generated by the server
...@@ -72,42 +72,42 @@ public interface Session extends RoutableChannelHandler { ...@@ -72,42 +72,42 @@ public interface Session extends RoutableChannelHandler {
* *
* @return This session's assigned stream ID * @return This session's assigned stream ID
*/ */
public StreamID getStreamID(); StreamID getStreamID();
/** /**
* Obtain the name of the server this session belongs to. * Obtain the name of the server this session belongs to.
* *
* @return the server name. * @return the server name.
*/ */
public String getServerName(); String getServerName();
/** /**
* Obtain the date the session was created. * Obtain the date the session was created.
* *
* @return the session's creation date. * @return the session's creation date.
*/ */
public Date getCreationDate(); Date getCreationDate();
/** /**
* Obtain the time the session last had activity. * Obtain the time the session last had activity.
* *
* @return The last time the session received activity. * @return The last time the session received activity.
*/ */
public Date getLastActiveDate(); Date getLastActiveDate();
/** /**
* Obtain the number of packets sent from the client to the server. * Obtain the number of packets sent from the client to the server.
* *
* @return The number of packets sent from the client to the server. * @return The number of packets sent from the client to the server.
*/ */
public long getNumClientPackets(); long getNumClientPackets();
/** /**
* Obtain the number of packets sent from the server to the client. * Obtain the number of packets sent from the server to the client.
* *
* @return The number of packets sent from the server to the client. * @return The number of packets sent from the server to the client.
*/ */
public long getNumServerPackets(); long getNumServerPackets();
/** /**
* Close this session including associated socket connection. The order of * Close this session including associated socket connection. The order of
...@@ -118,28 +118,28 @@ public interface Session extends RoutableChannelHandler { ...@@ -118,28 +118,28 @@ public interface Session extends RoutableChannelHandler {
* <li>Close the socket. * <li>Close the socket.
* </ul> * </ul>
*/ */
public void close(); void close();
/** /**
* Returns true if the connection/session is closed. * Returns true if the connection/session is closed.
* *
* @return true if the connection is closed. * @return true if the connection is closed.
*/ */
public boolean isClosed(); boolean isClosed();
/** /**
* Returns true if this connection is secure. * Returns true if this connection is secure.
* *
* @return true if the connection is secure (e.g. SSL/TLS) * @return true if the connection is secure (e.g. SSL/TLS)
*/ */
public boolean isSecure(); boolean isSecure();
/** /**
* Returns the peer certificates associated with this session, if any. * Returns the peer certificates associated with this session, if any.
* *
* @return certificates, possibly empty or null. * @return certificates, possibly empty or null.
*/ */
public Certificate[] getPeerCertificates(); Certificate[] getPeerCertificates();
/** /**
* Returns the IP address string in textual presentation. * Returns the IP address string in textual presentation.
...@@ -147,7 +147,7 @@ public interface Session extends RoutableChannelHandler { ...@@ -147,7 +147,7 @@ public interface Session extends RoutableChannelHandler {
* @return the raw IP address in a string format. * @return the raw IP address in a string format.
* @throws java.net.UnknownHostException if IP address of host could not be determined. * @throws java.net.UnknownHostException if IP address of host could not be determined.
*/ */
public String getHostAddress() throws UnknownHostException; String getHostAddress() throws UnknownHostException;
/** /**
* Gets the host name for this IP address. * Gets the host name for this IP address.
...@@ -175,10 +175,10 @@ public interface Session extends RoutableChannelHandler { ...@@ -175,10 +175,10 @@ public interface Session extends RoutableChannelHandler {
* @see java.net.InetAddress#getCanonicalHostName * @see java.net.InetAddress#getCanonicalHostName
* @see SecurityManager#checkConnect * @see SecurityManager#checkConnect
*/ */
public String getHostName() throws UnknownHostException; String getHostName() throws UnknownHostException;
@Override @Override
public abstract void process(Packet packet); void process( Packet packet );
/** /**
* Delivers raw text to this connection. This is a very low level way for sending * Delivers raw text to this connection. This is a very low level way for sending
...@@ -191,7 +191,7 @@ public interface Session extends RoutableChannelHandler { ...@@ -191,7 +191,7 @@ public interface Session extends RoutableChannelHandler {
* *
* @param text the XML stanzas represented kept in a String. * @param text the XML stanzas represented kept in a String.
*/ */
public void deliverRawText(String text); void deliverRawText( String text );
/** /**
* Verifies that the connection is still live. Typically this is done by * Verifies that the connection is still live. Typically this is done by
...@@ -201,14 +201,14 @@ public interface Session extends RoutableChannelHandler { ...@@ -201,14 +201,14 @@ public interface Session extends RoutableChannelHandler {
* *
* @return true if the socket remains valid, false otherwise. * @return true if the socket remains valid, false otherwise.
*/ */
public boolean validate(); boolean validate();
/** /**
* Returns the TLS cipher suite name, if any. * Returns the TLS cipher suite name, if any.
* Always returns a valid string, though the string may be "NONE" * Always returns a valid string, though the string may be "NONE"
* @return cipher suite name. * @return cipher suite name.
*/ */
public String getCipherSuiteName(); String getCipherSuiteName();
/** /**
* Returns the locale that is used for this session (e.g. {@link Locale#ENGLISH}). * Returns the locale that is used for this session (e.g. {@link Locale#ENGLISH}).
......
src/java/org/jivesoftware/openfire/stats/Statistic.java
View file @ dcea025c
...@@ -28,35 +28,35 @@ public interface Statistic { ...@@ -28,35 +28,35 @@ public interface Statistic {
* *
* @return the name of a stat. * @return the name of a stat.
*/ */
public String getName(); String getName();
/** /**
* Returns the type of a stat. * Returns the type of a stat.
* *
* @return the type of a stat. * @return the type of a stat.
*/ */
public Type getStatType(); Type getStatType();
/** /**
* Returns a description of the stat. * Returns a description of the stat.
* *
* @return a description of the stat. * @return a description of the stat.
*/ */
public String getDescription(); String getDescription();
/** /**
* Returns the units that relate to the stat. * Returns the units that relate to the stat.
* *
* @return the name of the units that relate to the stat. * @return the name of the units that relate to the stat.
*/ */
public String getUnits(); String getUnits();
/** /**
* Returns the current sample of data. * Returns the current sample of data.
* *
* @return a sample of the data. * @return a sample of the data.
*/ */
public double sample(); double sample();
/** /**
* Returns true if the sample value represents only the value of the cluster node * Returns true if the sample value represents only the value of the cluster node
...@@ -74,13 +74,13 @@ public interface Statistic { ...@@ -74,13 +74,13 @@ public interface Statistic {
* @return true if the sample value represents only the value of the cluster node * @return true if the sample value represents only the value of the cluster node
* or otherwise it represents the value of the entire cluster. * or otherwise it represents the value of the entire cluster.
*/ */
public boolean isPartialSample(); boolean isPartialSample();
/** /**
* The type of statistic. * The type of statistic.
*/ */
@SuppressWarnings({"UnnecessarySemicolon"}) // Support for QDox Parser @SuppressWarnings({"UnnecessarySemicolon"}) // Support for QDox Parser
public enum Type { enum Type {
/** /**
* The average rate over time. For example, the averave kb/s in bandwidth used for * The average rate over time. For example, the averave kb/s in bandwidth used for
......
src/java/org/jivesoftware/openfire/user/PresenceEventListener.java
View file @ dcea025c
...@@ -38,7 +38,7 @@ public interface PresenceEventListener { ...@@ -38,7 +38,7 @@ public interface PresenceEventListener {
* @param session the session that is now available. * @param session the session that is now available.
* @param presence the received available presence. * @param presence the received available presence.
*/ */
public void availableSession(ClientSession session, Presence presence); void availableSession( ClientSession session, Presence presence );
/** /**
* Notification message indicating that a session that was available is no longer * Notification message indicating that a session that was available is no longer
...@@ -49,7 +49,7 @@ public interface PresenceEventListener { ...@@ -49,7 +49,7 @@ public interface PresenceEventListener {
* @param session the session that is no longer available. * @param session the session that is no longer available.
* @param presence the received unavailable presence. * @param presence the received unavailable presence.
*/ */
public void unavailableSession(ClientSession session, Presence presence); void unavailableSession( ClientSession session, Presence presence );
/** /**
* Notification message indicating that an available session has changed its * Notification message indicating that an available session has changed its
...@@ -59,7 +59,7 @@ public interface PresenceEventListener { ...@@ -59,7 +59,7 @@ public interface PresenceEventListener {
* @param session the affected session. * @param session the affected session.
* @param presence the received available presence with the new information. * @param presence the received available presence with the new information.
*/ */
public void presenceChanged(ClientSession session, Presence presence); void presenceChanged( ClientSession session, Presence presence );
/** /**
* Notification message indicating that a user has successfully subscribed * Notification message indicating that a user has successfully subscribed
...@@ -68,7 +68,7 @@ public interface PresenceEventListener { ...@@ -68,7 +68,7 @@ public interface PresenceEventListener {
* @param subscriberJID the user that initiated the subscription. * @param subscriberJID the user that initiated the subscription.
* @param authorizerJID the user that authorized the subscription. * @param authorizerJID the user that authorized the subscription.
*/ */
public void subscribedToPresence(JID subscriberJID, JID authorizerJID); void subscribedToPresence( JID subscriberJID, JID authorizerJID );
/** /**
* Notification message indicating that a user has unsubscribed * Notification message indicating that a user has unsubscribed
...@@ -77,5 +77,5 @@ public interface PresenceEventListener { ...@@ -77,5 +77,5 @@ public interface PresenceEventListener {
* @param unsubscriberJID the user that initiated the unsubscribe request. * @param unsubscriberJID the user that initiated the unsubscribe request.
* @param recipientJID the recipient user of the unsubscribe request. * @param recipientJID the recipient user of the unsubscribe request.
*/ */
public void unsubscribedToPresence(JID unsubscriberJID, JID recipientJID); void unsubscribedToPresence( JID unsubscriberJID, JID recipientJID );
} }
src/java/org/jivesoftware/openfire/user/UserNameProvider.java
View file @ dcea025c
...@@ -32,5 +32,5 @@ public interface UserNameProvider { ...@@ -32,5 +32,5 @@ public interface UserNameProvider {
* @param entity JID of the entity to return its name. * @param entity JID of the entity to return its name.
* @return the name of the entity specified by the following JID. * @return the name of the entity specified by the following JID.
*/ */
abstract String getUserName(JID entity); String getUserName( JID entity );
} }
src/java/org/jivesoftware/openfire/user/UserProvider.java
View file @ dcea025c
...@@ -34,7 +34,7 @@ public interface UserProvider { ...@@ -34,7 +34,7 @@ public interface UserProvider {
* @return the User. * @return the User.
* @throws UserNotFoundException if the User could not be loaded. * @throws UserNotFoundException if the User could not be loaded.
*/ */
public User loadUser(String username) throws UserNotFoundException; User loadUser( String username ) throws UserNotFoundException;
/** /**
* Creates a new user. This method should throw an * Creates a new user. This method should throw an
...@@ -48,7 +48,7 @@ public interface UserProvider { ...@@ -48,7 +48,7 @@ public interface UserProvider {
* @return a new User. * @return a new User.
* @throws UserAlreadyExistsException if the username is already in use. * @throws UserAlreadyExistsException if the username is already in use.
*/ */
public User createUser(String username, String password, String name, String email) User createUser( String username, String password, String name, String email )
throws UserAlreadyExistsException; throws UserAlreadyExistsException;
/** /**
...@@ -58,14 +58,14 @@ public interface UserProvider { ...@@ -58,14 +58,14 @@ public interface UserProvider {
* *
* @param username the username to delete. * @param username the username to delete.
*/ */
public void deleteUser(String username); void deleteUser( String username );
/** /**
* Returns the number of users in the system. * Returns the number of users in the system.
* *
* @return the total number of users. * @return the total number of users.
*/ */
public int getUserCount(); int getUserCount();
/** /**
* Returns an unmodifiable Collections of all users in the system. The * Returns an unmodifiable Collections of all users in the system. The
...@@ -76,14 +76,14 @@ public interface UserProvider { ...@@ -76,14 +76,14 @@ public interface UserProvider {
* *
* @return an unmodifiable Collection of all users. * @return an unmodifiable Collection of all users.
*/ */
public Collection<User> getUsers(); Collection<User> getUsers();
/** /**
* Returns an unmodifiable Collection of usernames of all users in the system. * Returns an unmodifiable Collection of usernames of all users in the system.
* *
* @return an unmodifiable Collection of all usernames in the system. * @return an unmodifiable Collection of all usernames in the system.
*/ */
public Collection<String> getUsernames(); Collection<String> getUsernames();
/** /**
* Returns an unmodifiable Collections of users in the system within the * Returns an unmodifiable Collections of users in the system within the
...@@ -100,7 +100,7 @@ public interface UserProvider { ...@@ -100,7 +100,7 @@ public interface UserProvider {
* @param numResults the total number of results to return. * @param numResults the total number of results to return.
* @return an unmodifiable Collection of users within the specified range. * @return an unmodifiable Collection of users within the specified range.
*/ */
public Collection<User> getUsers(int startIndex, int numResults); Collection<User> getUsers( int startIndex, int numResults );
/** /**
* Sets the user's name. This method should throw an UnsupportedOperationException * Sets the user's name. This method should throw an UnsupportedOperationException
...@@ -110,7 +110,7 @@ public interface UserProvider { ...@@ -110,7 +110,7 @@ public interface UserProvider {
* @param name the name. * @param name the name.
* @throws UserNotFoundException if the user could not be found. * @throws UserNotFoundException if the user could not be found.
*/ */
public void setName(String username, String name) throws UserNotFoundException; void setName( String username, String name ) throws UserNotFoundException;
/** /**
* Sets the user's email address. This method should throw an * Sets the user's email address. This method should throw an
...@@ -121,7 +121,7 @@ public interface UserProvider { ...@@ -121,7 +121,7 @@ public interface UserProvider {
* @param email the email address. * @param email the email address.
* @throws UserNotFoundException if the user could not be found. * @throws UserNotFoundException if the user could not be found.
*/ */
public void setEmail(String username, String email) throws UserNotFoundException; void setEmail( String username, String email ) throws UserNotFoundException;
/** /**
* Sets the date the user was created. This method should throw an * Sets the date the user was created. This method should throw an
...@@ -132,7 +132,7 @@ public interface UserProvider { ...@@ -132,7 +132,7 @@ public interface UserProvider {
* @param creationDate the date the user was created. * @param creationDate the date the user was created.
* @throws UserNotFoundException if the user could not be found. * @throws UserNotFoundException if the user could not be found.
*/ */
public void setCreationDate(String username, Date creationDate) throws UserNotFoundException; void setCreationDate( String username, Date creationDate ) throws UserNotFoundException;
/** /**
* Sets the date the user was last modified. This method should throw an * Sets the date the user was last modified. This method should throw an
...@@ -143,7 +143,7 @@ public interface UserProvider { ...@@ -143,7 +143,7 @@ public interface UserProvider {
* @param modificationDate the date the user was last modified. * @param modificationDate the date the user was last modified.
* @throws UserNotFoundException if the user could not be found. * @throws UserNotFoundException if the user could not be found.
*/ */
public void setModificationDate(String username, Date modificationDate) void setModificationDate( String username, Date modificationDate )
throws UserNotFoundException; throws UserNotFoundException;
/** /**
...@@ -160,7 +160,7 @@ public interface UserProvider { ...@@ -160,7 +160,7 @@ public interface UserProvider {
* @throws UnsupportedOperationException if the provider does not * @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation). * support the operation (this is an optional operation).
*/ */
public Set<String> getSearchFields() throws UnsupportedOperationException; Set<String> getSearchFields() throws UnsupportedOperationException;
/** /**
* Searches for users based on a set of fields and a query string. The fields must * Searches for users based on a set of fields and a query string. The fields must
...@@ -177,7 +177,7 @@ public interface UserProvider { ...@@ -177,7 +177,7 @@ public interface UserProvider {
* @throws UnsupportedOperationException if the provider does not * @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation). * support the operation (this is an optional operation).
*/ */
public Collection<User> findUsers(Set<String> fields, String query) Collection<User> findUsers( Set<String> fields, String query )
throws UnsupportedOperationException; throws UnsupportedOperationException;
/** /**
...@@ -203,8 +203,8 @@ public interface UserProvider { ...@@ -203,8 +203,8 @@ public interface UserProvider {
* @throws UnsupportedOperationException if the provider does not * @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation). * support the operation (this is an optional operation).
*/ */
public Collection<User> findUsers(Set<String> fields, String query, int startIndex, Collection<User> findUsers( Set<String> fields, String query, int startIndex,
int numResults) throws UnsupportedOperationException; int numResults ) throws UnsupportedOperationException;
/** /**
* Returns true if this UserProvider is read-only. When read-only, * Returns true if this UserProvider is read-only. When read-only,
...@@ -212,20 +212,20 @@ public interface UserProvider { ...@@ -212,20 +212,20 @@ public interface UserProvider {
* *
* @return true if the user provider is read-only. * @return true if the user provider is read-only.
*/ */
public boolean isReadOnly(); boolean isReadOnly();
/** /**
* Returns true if this UserProvider requires a name to be set on User objects. * Returns true if this UserProvider requires a name to be set on User objects.
* *
* @return true if an name is required with this provider. * @return true if an name is required with this provider.
*/ */
public boolean isNameRequired(); boolean isNameRequired();
/** /**
* Returns true if this UserProvider requires an email address to be set on User objects. * Returns true if this UserProvider requires an email address to be set on User objects.
* *
* @return true if an email address is required with this provider. * @return true if an email address is required with this provider.
*/ */
public boolean isEmailRequired(); boolean isEmailRequired();
} }
\ No newline at end of file
src/java/org/jivesoftware/openfire/vcard/VCardListener.java
View file @ dcea025c
...@@ -32,7 +32,7 @@ public interface VCardListener { ...@@ -32,7 +32,7 @@ public interface VCardListener {
* @param username the username for which the vCard was created. * @param username the username for which the vCard was created.
* @param vCard the vcard created. * @param vCard the vcard created.
*/ */
public void vCardCreated(String username, Element vCard); void vCardCreated( String username, Element vCard );
/** /**
* A vCard was updated. * A vCard was updated.
...@@ -40,7 +40,7 @@ public interface VCardListener { ...@@ -40,7 +40,7 @@ public interface VCardListener {
* @param username the user for which the vCard was updated. * @param username the user for which the vCard was updated.
* @param vCard the vcard updated. * @param vCard the vcard updated.
*/ */
public void vCardUpdated(String username, Element vCard); void vCardUpdated( String username, Element vCard );
/** /**
* A vCard was deleted. * A vCard was deleted.
...@@ -48,5 +48,5 @@ public interface VCardListener { ...@@ -48,5 +48,5 @@ public interface VCardListener {
* @param username the user for which the vCard was deleted. * @param username the user for which the vCard was deleted.
* @param vCard the vcard deleted. * @param vCard the vcard deleted.
*/ */
public void vCardDeleted(String username, Element vCard); void vCardDeleted( String username, Element vCard );
} }
src/java/org/jivesoftware/util/Encryptor.java
View file @ dcea025c
...@@ -8,7 +8,7 @@ public interface Encryptor { ...@@ -8,7 +8,7 @@ public interface Encryptor {
* @param value The clear text attribute * @param value The clear text attribute
* @return The encrypted attribute, or null * @return The encrypted attribute, or null
*/ */
public abstract String encrypt(String value); String encrypt( String value );
/** /**
* Decrypt an encrypted String. * Decrypt an encrypted String.
...@@ -16,7 +16,7 @@ public interface Encryptor { ...@@ -16,7 +16,7 @@ public interface Encryptor {
* @param value The encrypted attribute in Base64 encoding * @param value The encrypted attribute in Base64 encoding
* @return The clear text attribute, or null * @return The clear text attribute, or null
*/ */
public abstract String decrypt(String value); String decrypt( String value );
/** /**
* Set the encryption key. This will apply the user-defined key, * Set the encryption key. This will apply the user-defined key,
...@@ -25,6 +25,6 @@ public interface Encryptor { ...@@ -25,6 +25,6 @@ public interface Encryptor {
* *
* @param key The encryption key * @param key The encryption key
*/ */
public abstract void setKey(String key); void setKey( String key );
} }
\ No newline at end of file
src/java/org/jivesoftware/util/HttpClientWithTimeoutFeedFetcher.java
View file @ dcea025c
...@@ -292,7 +292,7 @@ public class HttpClientWithTimeoutFeedFetcher extends AbstractFeedFetcher { ...@@ -292,7 +292,7 @@ public class HttpClientWithTimeoutFeedFetcher extends AbstractFeedFetcher {
} }
public interface CredentialSupplier { public interface CredentialSupplier {
public Credentials getCredentials(String realm, String host); Credentials getCredentials( String realm, String host );
} }
......
src/java/org/jivesoftware/util/PropertyEventListener.java
View file @ dcea025c
...@@ -34,7 +34,7 @@ public interface PropertyEventListener { ...@@ -34,7 +34,7 @@ public interface PropertyEventListener {
* @param property the name of the property. * @param property the name of the property.
* @param params event parameters. * @param params event parameters.
*/ */
public void propertySet(String property, Map<String, Object> params); void propertySet( String property, Map<String, Object> params );
/** /**
* A property was deleted. * A property was deleted.
...@@ -42,7 +42,7 @@ public interface PropertyEventListener { ...@@ -42,7 +42,7 @@ public interface PropertyEventListener {
* @param property the name of the property deleted. * @param property the name of the property deleted.
* @param params event parameters. * @param params event parameters.
*/ */
public void propertyDeleted(String property, Map<String, Object> params); void propertyDeleted( String property, Map<String, Object> params );
/** /**
* An XML property was set. The parameter map <tt>params</tt> will contain the * An XML property was set. The parameter map <tt>params</tt> will contain the
...@@ -51,7 +51,7 @@ public interface PropertyEventListener { ...@@ -51,7 +51,7 @@ public interface PropertyEventListener {
* @param property the name of the property. * @param property the name of the property.
* @param params event parameters. * @param params event parameters.
*/ */
public void xmlPropertySet(String property, Map<String, Object> params); void xmlPropertySet( String property, Map<String, Object> params );
/** /**
* An XML property was deleted. * An XML property was deleted.
...@@ -59,6 +59,6 @@ public interface PropertyEventListener { ...@@ -59,6 +59,6 @@ public interface PropertyEventListener {
* @param property the name of the property. * @param property the name of the property.
* @param params event parameters. * @param params event parameters.
*/ */
public void xmlPropertyDeleted(String property, Map<String, Object> params); void xmlPropertyDeleted( String property, Map<String, Object> params );
} }
\ No newline at end of file
src/java/org/jivesoftware/util/cache/Cacheable.java
View file @ dcea025c
...@@ -38,5 +38,5 @@ public interface Cacheable extends java.io.Serializable { ...@@ -38,5 +38,5 @@ public interface Cacheable extends java.io.Serializable {
* *
* @return the size of the Object in bytes. * @return the size of the Object in bytes.
*/ */
public int getCachedSize() throws CannotCalculateSizeException; int getCachedSize() throws CannotCalculateSizeException;
} }
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

Technounit-GROUP 2023