org.apache.sling.distribution.monitor.impl

Class ForwardDistributionAgentMBeanImpl

java.lang.Object

org.apache.sling.distribution.monitor.impl.ForwardDistributionAgentMBeanImpl

All Implemented Interfaces:

ForwardDistributionAgentMBean

public final class ForwardDistributionAgentMBeanImpl
extends Object
implements ForwardDistributionAgentMBean

The ForwardDistributionAgent MBean implementation, based on the OSGi configuration.

Constructor Summary

Constructors

Constructor and Description
ForwardDistributionAgentMBeanImpl(DistributionAgent agent, Map<String,Object> osgiConfiguration)

Method Summary

Modifier and Type	Method and Description
String	getAllowedRoots() If set the agent will allow only distribution requests under the specified roots.
String	getDetails() The display friendly details of the agent.
String	getLogLevel() The log level recorded in the transient log accessible via http.
String	getName() The name of the agent.
String	getPackageImporterEndpoints() List of endpoints to which packages are sent (imported).
String	getPassiveQueues() List of queues that should be disabled.These queues will gather all the packages until they are removed explicitly.
String	getPriorityQueues() List of priority queues that should used for specific paths.The selector format is {queuePrefix}[|{mainQueueMatcher}]={pathMatcher}, e.g.
String	getQueueProvider() The queue provider implementation.
int	getRetryAttempts() The number of times to retry until the retry strategy is applied.
String	getRetryStrategy() The strategy to apply after a certain number of failed retries.
String	getServiceName() The name of the service used to access the repository.
String	getStatus() The distribution agent status, usually one of: paused idle running blocked
String	getTitle() The display friendly title of the agent.
boolean	isAsyncDelivery() Whether or not to use a separate delivery queue to maximize transport throughput when queue has more than 100 items
boolean	isEnabled() Whether or not to start the distribution agent.
boolean	isQueueProcessingEnabled() Whether or not the distribution agent should process packages in the queues.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForwardDistributionAgentMBeanImpl

public ForwardDistributionAgentMBeanImpl(DistributionAgent agent,
                                         Map<String,Object> osgiConfiguration)

Method Detail

getName

public String getName()

Description copied from interface: ForwardDistributionAgentMBean

The name of the agent.

Specified by:

getName in interface ForwardDistributionAgentMBean

Returns:

the Name

getTitle

public String getTitle()

Description copied from interface: ForwardDistributionAgentMBean

The display friendly title of the agent.

Specified by:

getTitle in interface ForwardDistributionAgentMBean

Returns:

the Title

getDetails

public String getDetails()

Description copied from interface: ForwardDistributionAgentMBean

The display friendly details of the agent.

Specified by:

getDetails in interface ForwardDistributionAgentMBean

Returns:

the Details

isEnabled

public boolean isEnabled()

Description copied from interface: ForwardDistributionAgentMBean

Whether or not to start the distribution agent.

Specified by:

isEnabled in interface ForwardDistributionAgentMBean

Returns:

the Enabled

getServiceName

public String getServiceName()

Description copied from interface: ForwardDistributionAgentMBean

The name of the service used to access the repository.

Specified by:

getServiceName in interface ForwardDistributionAgentMBean

Returns:

the Service Name

getLogLevel

public String getLogLevel()

Description copied from interface: ForwardDistributionAgentMBean

The log level recorded in the transient log accessible via http.

Specified by:

getLogLevel in interface ForwardDistributionAgentMBean

Returns:

the Log Level

getAllowedRoots

public String getAllowedRoots()

Description copied from interface: ForwardDistributionAgentMBean

If set the agent will allow only distribution requests under the specified roots.

Specified by:

getAllowedRoots in interface ForwardDistributionAgentMBean

Returns:

the Allowed roots

isQueueProcessingEnabled

public boolean isQueueProcessingEnabled()

Description copied from interface: ForwardDistributionAgentMBean

Whether or not the distribution agent should process packages in the queues.

Specified by:

isQueueProcessingEnabled in interface ForwardDistributionAgentMBean

Returns:

the Queue Processing Enabled

getPackageImporterEndpoints

public String getPackageImporterEndpoints()

Description copied from interface: ForwardDistributionAgentMBean

List of endpoints to which packages are sent (imported). The list can be given as a map in case a queue should be configured for each endpoint, e.g. queueName=http://...

Specified by:

getPackageImporterEndpoints in interface ForwardDistributionAgentMBean

Returns:

the Importer Endpoints

getPassiveQueues

public String getPassiveQueues()

Description copied from interface: ForwardDistributionAgentMBean

List of queues that should be disabled.These queues will gather all the packages until they are removed explicitly.

Specified by:

getPassiveQueues in interface ForwardDistributionAgentMBean

Returns:

the Passive queues

getPriorityQueues

public String getPriorityQueues()

Description copied from interface: ForwardDistributionAgentMBean

List of priority queues that should used for specific paths.The selector format is {queuePrefix}[|{mainQueueMatcher}]={pathMatcher}, e.g. french=/content/fr.*

Specified by:

getPriorityQueues in interface ForwardDistributionAgentMBean

Returns:

the Priority queues

getRetryStrategy

public String getRetryStrategy()

Description copied from interface: ForwardDistributionAgentMBean

The strategy to apply after a certain number of failed retries.

Specified by:

getRetryStrategy in interface ForwardDistributionAgentMBean

Returns:

the Retry Strategy

getRetryAttempts

public int getRetryAttempts()

Description copied from interface: ForwardDistributionAgentMBean

The number of times to retry until the retry strategy is applied.

Specified by:

getRetryAttempts in interface ForwardDistributionAgentMBean

Returns:

the Retry attempts

getQueueProvider

public String getQueueProvider()

Description copied from interface: ForwardDistributionAgentMBean

The queue provider implementation.

Specified by:

getQueueProvider in interface ForwardDistributionAgentMBean

Returns:

the Queue provider

isAsyncDelivery

public boolean isAsyncDelivery()

Description copied from interface: ForwardDistributionAgentMBean

Whether or not to use a separate delivery queue to maximize transport throughput when queue has more than 100 items

Specified by:

isAsyncDelivery in interface ForwardDistributionAgentMBean

Returns:

the Async delivery

getStatus

public String getStatus()

Description copied from interface: ForwardDistributionAgentMBean

The distribution agent status, usually one of: paused idle running blocked

Specified by:

getStatus in interface ForwardDistributionAgentMBean

Returns:

the distribution agent status

See Also:

DistributionAgentState