ForgetCommand.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2013, 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.narayana.osgi.jta.command;

import org.apache.karaf.shell.api.action.Action;
import org.apache.karaf.shell.api.action.Argument;
import org.apache.karaf.shell.api.action.Command;
import org.apache.karaf.shell.api.action.lifecycle.Reference;
import org.apache.karaf.shell.api.action.lifecycle.Service;
import org.jboss.narayana.osgi.jta.ObjStoreBrowserService;

/**
 * @author <a href="mailto:zfeng@redhat.com">Amos Feng</a>
 */

@Command(scope = "narayana", name = "forget", description = "Move the specified heuristic participant back to the prepared list")
@Service
public class ForgetCommand implements Action {

    @Reference
    private ObjStoreBrowserService osb;

    @Argument(index = 0, name = "idx", description = "The participant idx", required = true, multiValued = false)
    Integer idx;

    @Override
    public Object execute() throws Exception {
        osb.forget(idx);
        return null;
    }
}