Commit 6dae4879 authored by Daniel Henninger's avatar Daniel Henninger Committed by dhenninger

Added a couple of javadocs.

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/trunk@9917 b35dd754-fafc-0310-a699-88a17e54d16e
parent 4e9a9445
...@@ -16,6 +16,9 @@ import java.sql.*; ...@@ -16,6 +16,9 @@ import java.sql.*;
import java.util.Date; import java.util.Date;
/** /**
* The DefaultLockOutProvider works with the jiveUserFlag table to maintain a list of disabled/locked out
* accounts., and as the name implies, is the default LockOutProvider implementation.
*
* @author Daniel Henninger * @author Daniel Henninger
*/ */
public class DefaultLockOutProvider implements LockOutProvider { public class DefaultLockOutProvider implements LockOutProvider {
......
...@@ -17,6 +17,19 @@ import java.util.Map; ...@@ -17,6 +17,19 @@ import java.util.Map;
import java.util.Date; import java.util.Date;
/** /**
* The LockOutManager managers the LockOutProvider configured for this server, caches knowledge of
* whether accounts are disabled or enabled, and providers a single point of entry for handling
* locked/disabled accounts.
*
* The provider can be specified in <tt>openfire.xml</tt> by adding:
* ...
* <provider>
* <lockout>
* <className>my.lock.out.provider</className>
* </lockout>
* </provider>
* ...
*
* @author Daniel Henninger * @author Daniel Henninger
*/ */
public class LockOutManager { public class LockOutManager {
...@@ -51,6 +64,9 @@ public class LockOutManager { ...@@ -51,6 +64,9 @@ public class LockOutManager {
private Cache<String,LockOutFlag> lockOutCache; private Cache<String,LockOutFlag> lockOutCache;
private static LockOutProvider provider = null; private static LockOutProvider provider = null;
/**
* Constructs a LockOutManager, setting up it's cache, propery listener, and setting up the provider.
*/
private LockOutManager() { private LockOutManager() {
// Initialize the lockout cache. // Initialize the lockout cache.
lockOutCache = CacheFactory.createCache("Locked Out Accounts"); lockOutCache = CacheFactory.createCache("Locked Out Accounts");
...@@ -81,6 +97,10 @@ public class LockOutManager { ...@@ -81,6 +97,10 @@ public class LockOutManager {
PropertyEventDispatcher.addListener(propListener); PropertyEventDispatcher.addListener(propListener);
} }
/**
* Initializes the server's lock out provider, based on configuration and defaults to
* DefaultLockOutProvider if the specified provider is not valid or not specified.
*/
private static void initProvider() { private static void initProvider() {
String className = JiveGlobals.getXMLProperty("provider.lockout.className", String className = JiveGlobals.getXMLProperty("provider.lockout.className",
"org.jivesoftware.openfire.lockout.DefaultLockOutProvider"); "org.jivesoftware.openfire.lockout.DefaultLockOutProvider");
......
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