org.robotframework.remoteserver.RemoteServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jrobot-remote-server Show documentation
The newest version!
package org.robotframework.remoteserver;

import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import java.util.Map;
import org.robotframework.remoteserver.library.RemoteLibrary;

/**
 * Provides way of providing and managing {@link RemoteLibrary} that are used as Robot-framework remote libraries
 */
public interface RemoteServer {

    /**
     * Stops the remote server immediately.
     */
    void stop();

    /**
     * A non-blocking method for stopping the remote server that allows requests
     * to complete within the given timeout before shutting down the server. New
     * connections will not be accepted after calling this.
     *
     * @param timeoutMS the milliseconds to wait for existing request to complete
     *                  before stopping the server
     */
    void stop(int timeoutMS);

    /**
     * Starts the remote server. Add test libraries first before calling this.
     *
     * @throws Exception If server cannot be started
     */
    void start() throws Exception;

    /**
     * Gets a copy of the current library map. Keys in the map are the paths and
     * the values are {@link RemoteLibrary} wrappers of the libraries being
     * served.
     *
     * @return a copy of the current library map
     */
    Map getLibraryMap();

    /**
     * Removes the library mapped to the given path if the mapping exists.
     *
     * @param path path for the library whose mapping is to be removed
     * @return the previous library associated with the path, or null if there
     * was no mapping for the path.
     */
    RemoteLibrary removeLibrary(String path);

    /**
     * Map the given test library to the specified path. Paths must:
     * 
     * start with a /
     * contain only alphanumeric characters or any of these: / - . _ ~
     * not end in a /
     * not contain a repeating sequence of /s
     * 
     * Example: putLibrary("/myLib", new MyLibrary());
     *
     * @param path    path to map the test library to
     * @param library instance of the test library
     */
    void putLibrary(String path, RemoteLibrary library);

    /**
     * @param serializer Instance of {@link StdSerializer} that will be responsible for serialization
     * @param         Type that will be serialized
     */
     void addSerializer(StdSerializer serializer);

}