com.anrisoftware.sscontrol.scripts.localuser.LocalUserAddFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sscontrol-scripts-unix Show documentation
Collection of Unix scripts.
The newest version!
/*
 * Copyright 2014-2015 Erwin Müller 
 *
 * This file is part of sscontrol-scripts-unix.
 *
 * sscontrol-scripts-unix 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-scripts-unix 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-scripts-unix. If not, see .
 */
package com.anrisoftware.sscontrol.scripts.localuser;

import java.util.List;
import java.util.Map;

import com.anrisoftware.globalpom.exec.runcommands.RunCommands;
import com.anrisoftware.globalpom.threads.api.Threads;

/**
 * Factory to create to add local group.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface LocalUserAddFactory {

    /**
     * Create to add local group.
     *
     * @param args
     *            the {@link Map} arguments:
     *            
     *            {@code runCommands} optionally, set to the
     *            {@link RunCommands} to record the command.
     *
     *            
{@code command} the group add command, for example
     *            {@code "/usr/sbin/useradd".}
     *
     *            
{@code usersFile} the path to the users file, for example
     *            {@code "/etc/passwd".}
     *
     *            
{@code userId} the user ID, for example {@code "100".}
     *
     *            
{@code userName} the user name, for example
     *            {@code "test".}
     *
     *            
{@code groupName} optionally, the user group name, for
     *            example {@code "test".}
     *
     *            
{@code systemUser} optionally, set to {@code true} to add
     *            a new system user.
     *
     *            
{@code groups} optionally, {@link List} of the local user
     *            groups, for example {@code "[foo, bar]".}
     *
     *            
{@code shell} optionally, set to the login shell.
     *
     *            
{@code homeDir} optionally, set to the home directories.
     *            
     *
     * @param parent
     *            the {@link Object} parent script.
     *
     * @param threads
     *            the {@link Threads} pool.
     *
     * @return the {@link LocalUserAdd}.
     */
    LocalUserAdd create(Map args, Object parent, Threads threads);
}