com.anrisoftware.sscontrol.httpd.yourls.YourlsService Maven / Gradle / Ivy

Go to download

/*
 * Copyright 2015 Erwin Müller 
 *
 * This file is part of sscontrol-httpd-yourls.
 *
 * sscontrol-httpd-yourls 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-yourls 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-yourls. If not, see .
 */
package com.anrisoftware.sscontrol.httpd.yourls;

import java.net.URI;
import java.util.List;
import java.util.Map;

import com.anrisoftware.sscontrol.core.overridemode.OverrideMode;
import com.anrisoftware.sscontrol.httpd.webservice.WebService;

/**
 * Yourls service.
 *
 * @see 
     * {["php": 1, "yourls": 1]}
     *


     *
     *      * setup "yourls", {
     *     debug "php", level: 1
     *     debug "yourls", level: 1
     * }
     * 
     *
     * @return the {@link Map} of the debug levels or {@code null}.
     */
    Map debugLogging(String key);

    /**
     * Returns the database properties.
     *
     * 
     * {@code database} the database name;
     * {@code user} the database user name;
     * {@code password} the user password;
     * {@code host} the database host;
     * {@code port} the database host port;
     * {@code prefix} the table prefix;
     * {@code driver} the table prefix;
     * 
     *
     *      * setup "yourls", {
     *     database "yourlsdb", user: "user", password: "userpass", host: "localhost"
     * }
     * 
     *
     * @return the {@link Map} of the database properties or {@code null}.
     */
    Map getDatabase();

    /**
     * Returns the override mode.
     *
     *      * setup "yourls", {
     *     override mode: update
     * }
     * 
     *
     * @return the override {@link OverrideMode} mode or {@code null}.
     */
    OverrideMode getOverrideMode();

    /**
     * Returns the backup target.
     *
     *      * setup "yourls", {
     *     backup target: "/var/backups"
     * }
     * 
     *
     * @return the backup {@link URI} target or {@code null}.
     */
    URI getBackupTarget();

    /**
     * Returns that the site is open for public access.
     *
     *      * setup "yourls", {
     *     access Access.open
     * }
     * 
     *
     * @return the access {@link Access} mode or {@code null}.
     */
    Access getSiteAccess();

    /**
     * Returns that the statistics are open for public access.
     *
     *      * setup "yourls", {
     *     access stats: Access.open
     * }
     * 
     *
     * @return the access {@link Access} mode or {@code null}.
     */
    Access getStatsAccess();

    /**
     * Returns that the API is open for public access.
     *
     *      * setup "yourls", {
     *     access api: Access.open
     * }
     * 
     *
     * @return the access {@link Access} mode or {@code null}.
     */
    Access getApiAccess();

    /**
     * Returns the timezone GMT offset.
     *
     *      * setup "yourls", {
     *     gmt offset: 1
     * }
     * 
     *
     * @return the timezone {@link Integer} offset or {@code null}.
     */
    Integer getGmtOffset();

    /**
     * Returns that the URLs are unique.
     *
     *      * setup "yourls", {
     *     unique urls: yes
     * }
     * 
     *
     * @return {@code true} if the URLs should be unique, or {@code null}.
     */
    Boolean getUniqueUrls();

    /**
     * Returns the convert mode.
     *
     *      * setup "yourls", {
     *     convert mode: Convert.base36
     * }
     * 
     *
     * @return the convert {@link Convert} mode or {@code null}.
     */
    Convert getUrlConvertMode();

    /**
     * Returns the reserved URL keywords.
     *
     *      * setup "yourls", {
     *     reserved "porn, sex"
     * }
     * 
     *
     * @return the {@link List} of reserved {@link String} words or
     *         {@code null.}
     */
    List getReserved();

    /**
     * Returns the language.
     *
     *      * setup "yourls", {
     *     language "de_DE"
     * }
     * 
     *
     * @return the language {@link String} name or {@code null}.
     */
    String getLanguage();

    /**
     * Returns the users that have access to the site.
     *
     *      * setup "yourls", {
     *     user "admin", password: "mypass"
     *     user "foo", password: "foopass"
     *     user "bar", password: "barpass"
     * }
     * 
     *
     * @return the {@link Map} users or {@code null}.
     */
    Map getUsers();

    /**
     * Returns the site URL.
     *
     *      * setup "yourls", {
     *     site "http://yoursite.com"
     * }
     * 
     *
     * @return the site {@link String} URL or {@code null}.
     */
    String getSite();

}