baseexecprotocol.java

来自「cqME :java framework for TCK test.」· Java 代码 · 共 107 行

/*
 * $Id$
 *
 * Copyright 1996-2007 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 *
 * This program 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
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 *
 */

package com.sun.tck.j2me.execution.baseclient;

import com.sun.javatest.Status;
import java.io.IOException;

/**
 *
 * This interface contains the methods required for the basic test execution.
 */
public interface BaseExecProtocol {
    /**
     * Requests next command from the server. The methods blocks until request
     * from the server is received.
     *
     * @param agentID Agent ID
     * @return request object.
     * @throws IllegalStateException
     *             if the method is invoked prior registration or registration
     *             is expired.
     * @throws IOException
     *             if a problem happens during request transmission.
     */
    public ExecutionRequest[] getNextRequests(String agentID) throws IOException;

    /**
     * Sends log data associated with the given execution request on the server.
     *
     *
     * @param request request, which generated the log.
     * @param logName name of the log.
     * @param data
     *            data being sent
     * @throws IllegalStateException
     *             if sendStatus has been invoked for the given request, the
     *             method is invoked prior registration or registration is
     *             expired.
     * @throws IOException
     *             if a problem happens during request transmission.
     */
    public void sendLog(ExecutionRequest request, String logName, String data) throws IOException;

    /**
     * Sends final status of the request execution. When the method is invoked,
     * the log data for the given request can not be sent.
     *
     *
     * @param request request, which generates the status.
     * @param status status, being sent
     * @throws IllegalStateException
     *             if the method is invoked prior registration or registration
     *             is expired.
     * @throws IOException
     *             if a problem happens during request transmission.
     */
    public void recordStatus(ExecutionRequest request, Status status) throws IOException;

    /**
     * Sets the name of the service on the JavaTest side. This service
     * should be recipient of the messages.  This method is invoked
     * prior invocation of other methods.
     */
    public void setServiceName(String name) throws IllegalArgumentException;

    /**
     * Flushes the communication. This method should send all buffered
     * messages.
     */
    public void flush() throws IOException;
    
    /**
     * Starts the service.
     */
    public void start();

    /**
     * Stops the service.
     */
    public void stop();
}