org.glassfish.internal.embedded.admin.EmbeddedAdminContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of internal-api Show documentation

There is a newer version: 8.0.0-JDK17-M9

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.internal.embedded.admin;

import org.glassfish.internal.embedded.EmbeddedContainer;
import org.glassfish.internal.embedded.Port;
import org.jvnet.hk2.annotations.Contract;


/**
 * Container for administrative tasks.
 */
@Contract
public interface EmbeddedAdminContainer extends EmbeddedContainer {


    /**
     * Executes synchronously a command
     *
     * @param commandName command name as typed by asadmin users
     * @param params command parameters
     * @return an command excecution to follow command's execution
     */
    public CommandExecution execute(String commandName, CommandParameters params);

    /**
     * Make the server listen to administrative requests (CLI, REST) on
     * the passed port.
     *
     * @param port an initialized port
     */
    public void bind(Port port);

}