/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2015, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.as.controller;

import java.util.Collection;
import java.util.Set;

import org.jboss.as.controller.capability.RuntimeCapability;
import org.jboss.as.controller.registry.Resource;
import org.jboss.dmr.ModelNode;

/**
 * An handler for an 'add' operation that does nothing in the
 * {@link org.jboss.as.controller.OperationContext.Stage#RUNTIME runtime stage} but put the process in
 * reload-required state. It does nothing at all in the runtime stage during boot.
 * <p>
 * Use case for this handler is for resources that only represent configuration data of their parent.
 * During boot in the runtime stage the parent reads the child model and configures its services
 * accordingly. Thereafter any change to the child model should put the process in reload-required.
 * <p>
 * The {@link org.jboss.as.controller.RestartParentResourceAddHandler} performs a similar function, but
 * allows restart of the parent resource.
 *
 * @see org.jboss.as.controller.RestartParentResourceAddHandler
 *
 * @author Brian Stansberry
 */
public class ReloadRequiredAddStepHandler extends AbstractAddStepHandler {

    public ReloadRequiredAddStepHandler(AttributeDefinition... attributes) {
        super(attributes);
    }

    public ReloadRequiredAddStepHandler(Collection<AttributeDefinition> attributes) {
        super(attributes);
    }
    public ReloadRequiredAddStepHandler(RuntimeCapability capability, AttributeDefinition... attributes) {
        super(capability, attributes);
    }

    public ReloadRequiredAddStepHandler(Set<RuntimeCapability> capabilities, Collection<AttributeDefinition> attributes) {
        super(capabilities, attributes);
    }

    public ReloadRequiredAddStepHandler(Parameters parameters) {
        super(parameters);
    }

    @Override
    protected boolean requiresRuntime(OperationContext context) {
        return !context.isBooting() && super.requiresRuntime(context);
    }

    @Override
    protected void performRuntime(OperationContext context, ModelNode operation, Resource resource) {
        context.reloadRequired();
    }

    @Override
    protected void rollbackRuntime(OperationContext context, ModelNode operation, Resource resource) {
        context.revertReloadRequired();
    }
}