| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.sling.distribution.agent.impl; |
| |
| import org.apache.felix.scr.annotations.*; |
| import org.apache.jackrabbit.vault.packaging.Packaging; |
| import org.apache.sling.api.resource.ResourceResolverFactory; |
| import org.apache.sling.commons.osgi.PropertiesUtil; |
| import org.apache.sling.distribution.DistributionRequestType; |
| import org.apache.sling.distribution.agent.spi.DistributionAgent; |
| import org.apache.sling.distribution.component.impl.DistributionComponentConstants; |
| import org.apache.sling.distribution.component.impl.SettingsUtils; |
| import org.apache.sling.distribution.event.impl.DistributionEventFactory; |
| import org.apache.sling.distribution.log.impl.DefaultDistributionLog; |
| import org.apache.sling.distribution.monitor.impl.MonitoringDistributionQueueProvider; |
| import org.apache.sling.distribution.monitor.impl.SyncDistributionAgentMBean; |
| import org.apache.sling.distribution.monitor.impl.SyncDistributionAgentMBeanImpl; |
| import org.apache.sling.distribution.packaging.DistributionPackageBuilder; |
| import org.apache.sling.distribution.packaging.DistributionPackageExporter; |
| import org.apache.sling.distribution.packaging.DistributionPackageImporter; |
| import org.apache.sling.distribution.packaging.impl.exporter.RemoteDistributionPackageExporter; |
| import org.apache.sling.distribution.packaging.impl.importer.RemoteDistributionPackageImporter; |
| import org.apache.sling.distribution.queue.impl.DistributionQueueProvider; |
| import org.apache.sling.distribution.queue.impl.DistributionQueueDispatchingStrategy; |
| import org.apache.sling.distribution.queue.impl.ErrorQueueDispatchingStrategy; |
| import org.apache.sling.distribution.queue.impl.MultipleQueueDispatchingStrategy; |
| import org.apache.sling.distribution.queue.impl.jobhandling.JobHandlingDistributionQueueProvider; |
| import org.apache.sling.distribution.transport.DistributionTransportSecretProvider; |
| import org.apache.sling.distribution.transport.impl.HttpConfiguration; |
| import org.apache.sling.distribution.trigger.DistributionTrigger; |
| import org.apache.sling.event.jobs.JobManager; |
| import org.apache.sling.jcr.api.SlingRepository; |
| import org.apache.sling.settings.SlingSettingsService; |
| import org.osgi.framework.BundleContext; |
| |
| import java.util.*; |
| |
| /** |
| * An OSGi service factory for "synchronizing agents" that synchronize (pull and push) resources between remote instances. |
| * |
| * @see {@link DistributionAgent} |
| */ |
| @Component(metatype = true, |
| label = "Apache Sling Distribution Agent - Sync Agents Factory", |
| description = "OSGi configuration factory for syncing agents", |
| configurationFactory = true, |
| specVersion = "1.1", |
| policy = ConfigurationPolicy.REQUIRE |
| ) |
| @Reference(name = "triggers", referenceInterface = DistributionTrigger.class, |
| policy = ReferencePolicy.DYNAMIC, cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE, |
| bind = "bindDistributionTrigger", unbind = "unbindDistributionTrigger") |
| @Property(name = "webconsole.configurationFactory.nameHint", value = "Agent name: {name}") |
| public class SyncDistributionAgentFactory extends AbstractDistributionAgentFactory<SyncDistributionAgentMBean> { |
| |
| @Property(label = "Name", description = "The name of the agent.") |
| public static final String NAME = DistributionComponentConstants.PN_NAME; |
| |
| @Property(label = "Title", description = "The display friendly title of the agent.") |
| public static final String TITLE = "title"; |
| |
| @Property(label = "Details", description = "The display friendly details of the agent.") |
| public static final String DETAILS = "details"; |
| |
| @Property(boolValue = true, label = "Enabled", description = "Whether or not to start the distribution agent.") |
| private static final String ENABLED = "enabled"; |
| |
| |
| @Property(label = "Service Name", description = "The name of the service used to access the repository. " + |
| "If not set, the calling user ResourceResolver will be used") |
| private static final String SERVICE_NAME = "serviceName"; |
| |
| @Property(options = { |
| @PropertyOption(name = "debug", value = "debug"), @PropertyOption(name = "info", value = "info"), @PropertyOption(name = "warn", value = "warn"), |
| @PropertyOption(name = "error", value = "error")}, |
| value = "info", |
| label = "Log Level", description = "The log level recorded in the transient log accessible via http." |
| ) |
| public static final String LOG_LEVEL = AbstractDistributionAgentFactory.LOG_LEVEL; |
| |
| |
| @Property(boolValue = true, label = "Queue Processing Enabled", description = "Whether or not the distribution agent should process packages in the queues.") |
| private static final String QUEUE_PROCESSING_ENABLED = "queue.processing.enabled"; |
| |
| @Property(cardinality = 100, label = "Passive queues", description = "List of queues that should be disabled." + |
| "These queues will gather all the packages until they are removed explicitly.") |
| private static final String PASSIVE_QUEUES = "passiveQueues"; |
| |
| /** |
| * endpoints property |
| */ |
| @Property(cardinality = 100, label = "Exporter Endpoints", description = "List of endpoints from which packages are received (exported)") |
| private static final String EXPORTER_ENDPOINTS = "packageExporter.endpoints"; |
| |
| /** |
| * endpoints property |
| */ |
| @Property(cardinality = 100, label = "Importer Endpoints", description = "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://...") |
| private static final String IMPORTER_ENDPOINTS = "packageImporter.endpoints"; |
| |
| @Property(options = { |
| @PropertyOption(name = "none", value = "none"), @PropertyOption(name = "errorQueue", value = "errorQueue")}, |
| value = "none", |
| label = "Retry Strategy", description = "The strategy to apply after a certain number of failed retries." |
| ) |
| private static final String RETRY_STRATEGY = "retry.strategy"; |
| |
| @Property(intValue = 100, label = "Retry attempts", description = "The number of times to retry until the retry strategy is applied.") |
| private static final String RETRY_ATTEMPTS = "retry.attempts"; |
| |
| /** |
| * no. of items to poll property |
| */ |
| @Property(intValue = 100, label = "Pull Items", description = "Number of subsequent pull requests to make.") |
| private static final String PULL_ITEMS = "pull.items"; |
| |
| /** |
| * timeout for HTTP requests |
| */ |
| @Property(label = "HTTP connection timeout", intValue = 10, description = "The connection timeout for HTTP requests (in seconds).") |
| public static final String HTTP = "http.conn.timeout"; |
| |
| @Reference |
| private Packaging packaging; |
| |
| @Property(name = "requestAuthorizationStrategy.target", label = "Request Authorization Strategy", description = "The target reference for the DistributionRequestAuthorizationStrategy used to authorize the access to distribution process," + |
| "e.g. use target=(name=...) to bind to services by name.", value = SettingsUtils.COMPONENT_NAME_DEFAULT) |
| @Reference(name = "requestAuthorizationStrategy") |
| private DistributionRequestAuthorizationStrategy requestAuthorizationStrategy; |
| |
| |
| @Property(name = "transportSecretProvider.target", label = "Transport Secret Provider", description = "The target reference for the DistributionTransportSecretProvider used to obtain the credentials used for accessing the remote endpoints, " + |
| "e.g. use target=(name=...) to bind to services by name.", value = SettingsUtils.COMPONENT_NAME_DEFAULT) |
| @Reference(name = "transportSecretProvider") |
| private DistributionTransportSecretProvider transportSecretProvider; |
| |
| @Property(name = "packageBuilder.target", label = "Package Builder", description = "The target reference for the DistributionPackageBuilder used to create distribution packages, " + |
| "e.g. use target=(name=...) to bind to services by name.", value = SettingsUtils.COMPONENT_NAME_DEFAULT) |
| @Reference(name = "packageBuilder") |
| private DistributionPackageBuilder packageBuilder; |
| |
| @Property(value = DEFAULT_TRIGGER_TARGET, label = "Triggers", description = "The target reference for DistributionTrigger used to trigger distribution, " + |
| "e.g. use target=(name=...) to bind to services by name.") |
| public static final String TRIGGERS_TARGET = "triggers.target"; |
| |
| @Reference |
| private DistributionEventFactory distributionEventFactory; |
| |
| @Reference |
| private SlingSettingsService settingsService; |
| |
| @Reference |
| private JobManager jobManager; |
| |
| @Reference |
| private ResourceResolverFactory resourceResolverFactory; |
| |
| @Reference |
| private SlingRepository slingRepository; |
| |
| public SyncDistributionAgentFactory() { |
| super(SyncDistributionAgentMBean.class); |
| } |
| |
| @Activate |
| protected void activate(BundleContext context, Map<String, Object> config) { |
| super.activate(context, config); |
| } |
| |
| protected void bindDistributionTrigger(DistributionTrigger distributionTrigger, Map<String, Object> config) { |
| super.bindDistributionTrigger(distributionTrigger, config); |
| |
| } |
| |
| protected void unbindDistributionTrigger(DistributionTrigger distributionTrigger, Map<String, Object> config) { |
| super.unbindDistributionTrigger(distributionTrigger, config); |
| } |
| |
| @Deactivate |
| protected void deactivate(BundleContext context) { |
| super.deactivate(context); |
| } |
| |
| |
| @Override |
| protected SimpleDistributionAgent createAgent(String agentName, BundleContext context, Map<String, Object> config, DefaultDistributionLog distributionLog) { |
| String serviceName = SettingsUtils.removeEmptyEntry(PropertiesUtil.toString(config.get(SERVICE_NAME), null)); |
| boolean queueProcessingEnabled = PropertiesUtil.toBoolean(config.get(QUEUE_PROCESSING_ENABLED), true); |
| |
| String[] passiveQueues = PropertiesUtil.toStringArray(config.get(PASSIVE_QUEUES), new String[0]); |
| passiveQueues = SettingsUtils.removeEmptyEntries(passiveQueues, new String[0]); |
| |
| Object exporterEndpointsValue = config.get(EXPORTER_ENDPOINTS); |
| Object importerEndpointsValue = config.get(IMPORTER_ENDPOINTS); |
| |
| String[] exporterEndpoints = PropertiesUtil.toStringArray(exporterEndpointsValue, new String[0]); |
| exporterEndpoints = SettingsUtils.removeEmptyEntries(exporterEndpoints); |
| |
| Map<String, String> importerEndpointsMap = SettingsUtils.toUriMap(importerEndpointsValue); |
| |
| int pullItems = PropertiesUtil.toInteger(config.get(PULL_ITEMS), Integer.MAX_VALUE); |
| |
| DistributionQueueDispatchingStrategy exportQueueStrategy; |
| DistributionQueueDispatchingStrategy importQueueStrategy = null; |
| DistributionPackageImporter packageImporter; |
| Set<String> processingQueues = new HashSet<String>(); |
| |
| Set<String> queuesMap = new TreeSet<String>(); |
| queuesMap.addAll(importerEndpointsMap.keySet()); |
| queuesMap.addAll(Arrays.asList(passiveQueues)); |
| processingQueues.addAll(importerEndpointsMap.keySet()); |
| processingQueues.removeAll(Arrays.asList(passiveQueues)); |
| |
| String[] queueNames = queuesMap.toArray(new String[queuesMap.size()]); |
| exportQueueStrategy = new MultipleQueueDispatchingStrategy(queueNames); |
| |
| Integer timeout = PropertiesUtil.toInteger(HTTP, 10) * 1000; |
| HttpConfiguration httpConfiguration = new HttpConfiguration(timeout); |
| |
| packageImporter = new RemoteDistributionPackageImporter(distributionLog, transportSecretProvider, |
| importerEndpointsMap, httpConfiguration); |
| |
| DistributionPackageExporter packageExporter = new RemoteDistributionPackageExporter(distributionLog, packageBuilder, |
| transportSecretProvider, exporterEndpoints, pullItems, httpConfiguration); |
| DistributionQueueProvider queueProvider = new MonitoringDistributionQueueProvider(new JobHandlingDistributionQueueProvider(agentName, jobManager, context), context); |
| DistributionRequestType[] allowedRequests = new DistributionRequestType[]{DistributionRequestType.PULL}; |
| |
| String retryStrategy = SettingsUtils.removeEmptyEntry(PropertiesUtil.toString(config.get(RETRY_STRATEGY), null)); |
| int retryAttepts = PropertiesUtil.toInteger(config.get(RETRY_ATTEMPTS), 100); |
| |
| |
| if ("errorQueue".equals(retryStrategy)) { |
| importQueueStrategy = new ErrorQueueDispatchingStrategy(processingQueues.toArray(new String[processingQueues.size()])); |
| } |
| |
| |
| return new SimpleDistributionAgent(agentName, queueProcessingEnabled, processingQueues, |
| serviceName, packageImporter, packageExporter, requestAuthorizationStrategy, |
| queueProvider, exportQueueStrategy, importQueueStrategy, distributionEventFactory, resourceResolverFactory, slingRepository, |
| distributionLog, allowedRequests, null, retryAttepts); |
| |
| } |
| |
| @Override |
| protected SyncDistributionAgentMBean createMBeanAgent(DistributionAgent agent, Map<String, Object> osgiConfiguration) { |
| return new SyncDistributionAgentMBeanImpl(agent, osgiConfiguration); |
| } |
| |
| } |