| java.lang.Object
 org.apache.roller.config.PingConfig
| PingConfig | | public class PingConfig (Code) | | Thin wrapper around RollerConfig and RollerRuntimeConfig for centralizing access to the many configurable
settings for pings.
author:
Anil Gangolli |
| Method Summary | |
| public static boolean | getDisablePingUsage()
Determine whether the configuration disables ping usage (configuration of auto pings and sending of manual
pings). | | public static boolean | getDisallowCustomTargets()
Determine whether the configuration disallows custom ping targets. | | public static boolean | getLogPingsOnly()
Get the logs only setting. | | public static int | getMaxPingAttempts()
Get the maximum number of ping attempts that should be made for each ping queue entry before we give up. | | public static int | getQueueProcessingIntervalMins()
Get the ping queue processing interval in minutes. | | public static boolean | getSuspendPingProcessing()
Determine whether ping processing is suspended. | | public static Set | getVariantOptions(String pingTargetUrl)
Get the set of variant options configured for the given ping target url. | | public static void | initializeCommonTargets()
Initialize the common ping targets from the configuration properties. | | public static void | initializePingVariants()
Initialize known ping variants from the configuration. |
| MAX_PING_ATTEMPTS_PROP | | final static String MAX_PING_ATTEMPTS_PROP(Code) | | |
| getDisablePingUsage | | public static boolean getDisablePingUsage()(Code) | | Determine whether the configuration disables ping usage (configuration of auto pings and sending of manual
pings). If this is true, all auto ping configus are removed at startup, the Weblog:Pings UI and the associated
actions are disabled.
the configured (or default) value of the enable ping usage setting. |
| getDisallowCustomTargets | | public static boolean getDisallowCustomTargets()(Code) | | Determine whether the configuration disallows custom ping targets. If this is true, users are not allowed to
create or edit custom ping targets, and any auto ping configs that use them are ignored.
the configured (or default) value of the "disallow custom targets" setting. |
| getLogPingsOnly | | public static boolean getLogPingsOnly()(Code) | | Get the logs only setting. Get configuration value determining whether pings are to be logged only (not sent).
This configuration setting is used for development and debugging.
the configured (or default) value of the logs only setting. |
| getMaxPingAttempts | | public static int getMaxPingAttempts()(Code) | | Get the maximum number of ping attempts that should be made for each ping queue entry before we give up. If we
get apparently transient failures while trying to perform the ping, the entry is requeued for processing on later
passes through the queue until this number of attempts has been reached.
the configured (or default) maximum number of ping attempts |
| getQueueProcessingIntervalMins | | public static int getQueueProcessingIntervalMins()(Code) | | Get the ping queue processing interval in minutes.
the configured (or default) queue processing interval in minutes. |
| getSuspendPingProcessing | | public static boolean getSuspendPingProcessing()(Code) | | Determine whether ping processing is suspended. If this is true, new auto ping requests are not
queued, any existing queued requests are not processed, and sending a manual ping results in a message saying
pings have been disabled.
the configured (or default) value of the suspend ping processing setting. |
| getVariantOptions | | public static Set getVariantOptions(String pingTargetUrl)(Code) | | Get the set of variant options configured for the given ping target url.
Parameters:
pingTargetUrl - the set of variant options configured for the given ping target url, orthe empty set if there are no variants configured. |
| initializeCommonTargets | | public static void initializeCommonTargets() throws RollerException(Code) | | Initialize the common ping targets from the configuration properties. If the current list of common ping targets
is empty, and the PINGS_INITIAL_COMMON_TARGETS_PROP property is present in the configuration then,
this method will use that value to initialize the common targets. This is called on each server startup.
Note: this is expected to be called during initialization with transaction demarcation being handled by the
caller.
See Also: org.apache.roller.ui.core.RollerContext.contextInitialized(javax.servlet.ServletContextEvent) |
| initializePingVariants | | public static void initializePingVariants()(Code) | | Initialize known ping variants from the configuration.
|
|
|