com.anrisoftware.sscontrol.mail.postfix.linux.AuthConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sscontrol-mail-postfix Show documentation

Installs Postfix mail server. - http://www.postfix.org/

There is a newer version: 1.0-alpha-4

Show newest version

/*
 * Copyright 2013-2014 Erwin Müller 
 *
 * This file is part of sscontrol-mail-postfix.
 *
 * sscontrol-mail-postfix 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-mail-postfix 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-mail-postfix. If not, see .
 */
package com.anrisoftware.sscontrol.mail.postfix.linux;

import com.anrisoftware.sscontrol.mail.postfix.script.linux.BasePostfixScript;

/**
 * Authentication configuration for users.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface AuthConfig {

    /**
     * Returns the profile name of the authentication.
     * 
     * @return the profile {@link String} name.
     */
    String getProfile();

    /**
     * Returns the storage name.
     * 
     * @return the storage {@link String} name.
     */
    String getStorageName();

    /**
     * Returns the authentication name.
     * 
     * @return the authentication {@link String} name.
     */
    String getAuthName();

    /**
     * Sets the parent script with the properties.
     * 
     * @param script
     *            the {@link BasePostfixScript}.
     */
    void setScript(BasePostfixScript script);

    /**
     * Returns the parent script with the properties.
     * 
     * @return the {@link BasePostfixScript}.
     */
    BasePostfixScript getScript();

    /**
     * Creates the configuration.
     */
    void deployAuth();

}