com.anrisoftware.sscontrol.hosts.api.HostsService Maven / Gradle / Ivy

Go to download

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

Sets the hosts configuration file.

There is a newer version: 1.0-alpha-4

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

import java.util.Collection;
import java.util.List;

import com.anrisoftware.sscontrol.core.api.Service;
import com.anrisoftware.sscontrol.hosts.host.Host;

/**
 * Hosts service.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface HostsService extends Service {

    /**
     * Returns the hosts service name.
     */
    @Override
    String getName();

    /**
     * Returns the host entries.
     * 
     * @return a {@link List} of {@link Host} entries.
     */
    List getHosts();

    /**
     * Adds all hosts from the specified collection in front of the current
     * hosts.
     * 
     * @param hosts
     *            the {@link Collection}.
     */
    void addHostsHead(Collection hosts);

}