contrib/jcr-commands/src/java/org/apache/jackrabbit/command/mixin/AddMixin.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  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.jackrabbit.command.mixin;

import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jackrabbit.command.CommandHelper;

/**
 * Add a mixin to the given <code>Node</code>
 */
public class AddMixin implements Command {
    /** logger */
    private static Log log = LogFactory.getLog(AddMixin.class);

    // ---------------------------- < keys >
    /** node path */
    private String pathKey = "path";

    /** mixin name */
    private String mixinKey = "mixin";

    /**
     * @return Returns the mixinNameKey.
     */
    public String getMixinKey() {
        return mixinKey;
    }

    /**
     * @param mixinNameKey
     *        The mixinNameKey to set.
     */
    public void setMixinKey(String mixinNameKey) {
        this.mixinKey = mixinNameKey;
    }

    /**
     * @return Returns the pathKey.
     */
    public String getPathKey() {
        return pathKey;
    }

    /**
     * @param pathKey
     *        The pathKey to set.
     */
    public void setPathKey(String pathKey) {
        this.pathKey = pathKey;
    }

    /**
     * {@inheritDoc}
     */
    public boolean execute(Context ctx) throws Exception {
        String path = (String) ctx.get(this.pathKey);
        String mixin = (String) ctx.get(this.mixinKey);
        if (log.isDebugEnabled()) {
            log.debug("adding mixin " + mixin + " to node " + path);
        }
        CommandHelper.getNode(ctx, path).addMixin(mixin);
        return false;
    }
}