SchedulerAssembler.java

/*
 * Copyright (c) 2010-2012, Paul Merlin. All Rights Reserved.
 * Copyright (c) 2012, Niclas Hedhman. All Rights Reserved.
 *
 * Licensed 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.qi4j.library.scheduler.bootstrap;

import org.qi4j.api.common.Visibility;
import org.qi4j.bootstrap.Assembler;
import org.qi4j.bootstrap.AssemblyException;
import org.qi4j.bootstrap.EntityDeclaration;
import org.qi4j.bootstrap.ModuleAssembly;
import org.qi4j.bootstrap.ServiceDeclaration;
import org.qi4j.bootstrap.ValueDeclaration;
import org.qi4j.library.scheduler.SchedulerConfiguration;
import org.qi4j.library.scheduler.SchedulerService;
import org.qi4j.library.scheduler.schedule.ScheduleFactory;
import org.qi4j.library.scheduler.schedule.Schedules;
import org.qi4j.library.scheduler.schedule.cron.CronScheduleEntity;
import org.qi4j.library.scheduler.schedule.cron.CronScheduleValue;
import org.qi4j.library.scheduler.schedule.once.OnceScheduleEntity;
import org.qi4j.library.scheduler.schedule.once.OnceScheduleValue;
import org.qi4j.library.scheduler.timeline.Timeline;
import org.qi4j.library.scheduler.timeline.TimelineForScheduleConcern;
import org.qi4j.library.scheduler.timeline.TimelineRecord;
import org.qi4j.library.scheduler.timeline.TimelineScheduleMixin;
import org.qi4j.library.scheduler.timeline.TimelineSchedulerServiceMixin;

import static org.qi4j.api.common.Visibility.module;

/**
 * Assembler for Scheduler.
 *
 * Use this Assembler to add the Scheduler service to your application.
 * This Assembler provide a fluent api to programmatically configure configuration defaults and
 * activate the Timeline service assembly that allow to browse in past and future Task runs.
 *
 * Here is a full example:
 * <pre>
 *      new SchedulerAssembler().
 *              visibleIn( Visibility.layer ).
 *              withConfigAssembly( configModuleAssembly ).
 *              withConfigVisibility( Visibility.application ).
 *              assemble( module );
 * </pre>
 */
public class SchedulerAssembler
    implements Assembler
{

    private Visibility visibility = module;
    private ModuleAssembly configAssembly;
    private Visibility configVisibility = Visibility.application;
    private boolean timeline;

    public SchedulerAssembler visibleIn( Visibility visibility )
    {
        this.visibility = visibility;
        return this;
    }

    /**
     * Set the ModuleAssembly to use for Configuration entities.
     *
     * @param configAssembly ModuleAssembly to use for Configuration entities
     *
     * @return SchedulerAssembler
     */
    public SchedulerAssembler withConfigAssembly( ModuleAssembly configAssembly )
    {
        this.configAssembly = configAssembly;
        return this;
    }

    /**
     * Set the configuration entity visibility.
     *
     * @param configVisibility SchedulerConfiguration visibility
     *
     * @return SchedulerAssembler
     */
    public SchedulerAssembler withConfigVisibility( Visibility configVisibility )
    {
        this.configVisibility = configVisibility;
        return this;
    }

    /**
     * Activate the assembly of Timeline related services.
     *
     * @return SchedulerAssembler
     */
    public SchedulerAssembler withTimeline()
    {
        timeline = true;
        return this;
    }

    @Override
    public void assemble( ModuleAssembly assembly )
        throws AssemblyException
    {
        assembly.services( ScheduleFactory.class );
        assembly.entities( Schedules.class );
        EntityDeclaration scheduleEntities = assembly.entities( CronScheduleEntity.class, OnceScheduleEntity.class );

        ValueDeclaration scheduleValues = assembly.values( CronScheduleValue.class, OnceScheduleValue.class );

        ServiceDeclaration schedulerDeclaration = assembly.services( SchedulerService.class )
            .visibleIn( visibility )
            .instantiateOnStartup();

        if( timeline )
        {
            scheduleEntities.withTypes( Timeline.class )
                .withMixins( TimelineScheduleMixin.class )
                .withConcerns( TimelineForScheduleConcern.class );

            scheduleValues.withTypes( Timeline.class )
                .withMixins( TimelineScheduleMixin.class )
                .withConcerns( TimelineForScheduleConcern.class );

            // Internal
            assembly.values( TimelineRecord.class );
            schedulerDeclaration.withTypes( Timeline.class ).withMixins( TimelineSchedulerServiceMixin.class );
        }

        if( configAssembly != null )
        {
            configAssembly.entities( SchedulerConfiguration.class ).visibleIn( configVisibility );
        }
    }
}