com.anrisoftware.sscontrol.httpd.phpmyadmin.PhpmyadminService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sscontrol-httpd-phpmyadmin Show documentation
Web software for administration of MySQL over the Web. - http://www.phpmyadmin.net
The newest version!
/*
 * Copyright 2014-2015 Erwin Müller 
 *
 * This file is part of sscontrol-httpd-phpmyadmin.
 *
 * sscontrol-httpd-phpmyadmin is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * sscontrol-httpd-phpmyadmin 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 Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with sscontrol-httpd-phpmyadmin. If not, see .
 */
package com.anrisoftware.sscontrol.httpd.phpmyadmin;

import com.anrisoftware.sscontrol.httpd.webservice.WebService;

/**
 * phpMyAdmin service.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface PhpmyadminService extends WebService {

    /**
     * Returns the administrator user name.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             admin "root", password: "rootpass"
     *         }
     *     }
     * }
     * 
     *
     * @return the administrator user {@link String} name.
     */
    String getAdminUser();

    /**
     * Returns the administrator user password.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             admin "root", password: "rootpass"
     *         }
     *     }
     * }
     * 
     *
     * @return the administrator user {@link String} password.
     */
    String getAdminPassword();

    /**
     * Returns the control user name.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             control "phpmyadmin", password: "somepass", database: "phpmyadmin"
     *         }
     *     }
     * }
     * 
     *
     * @return the control user {@link String} name.
     */
    String getControlUser();

    /**
     * Returns the control user password.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             control "phpmyadmin", password: "somepass", database: "phpmyadmin"
     *         }
     *     }
     * }
     * 
     *
     * @return the control user {@link String} password.
     */
    String getControlPassword();

    /**
     * Returns the control user database name.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             control "phpmyadmin", password: "somepass", database: "phpmyadmin"
     *         }
     *     }
     * }
     * 
     *
     * @return the control user database {@link String} name.
     */
    String getControlDatabase();

    /**
     * Returns the database server.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             server "127.0.0.1", port: 3306
     *         }
     *     }
     * }
     * 
     *
     * @return the database {@link String} server.
     */
    String getServer();

    /**
     * Returns the database server port.
     * 
     *
     * 
     * httpd {
     *     domain "phpadmin.test1.com", address: "192.168.0.50", {
     *         setup "phpmyadmin", alias: "phpmyadmin", {
     *             server "127.0.0.1", port: 3306
     *         }
     *     }
     * }
     * 
     *
     * @return the database server {@link Integer} port or {@code null}.
     */
    Integer getServerPort();

}