001/*
002 * This file is part of the Keycloak Moodle authenticator
003 * Copyright (C) 2024 Michael N. Lipp
004 *
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published
007 * by the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
013 * License for more details.
014 *
015 * You should have received a copy of the GNU Lesser General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.keycloak.moodleauth.moodle.service;
020
021import java.io.IOException;
022
023/**
024 * Represents the client side of a connection to a moodle server.
025 */
026public interface MoodleService {
027
028    /**
029     * Attempts to establish a connection to the server.
030     *
031     * @param website the website
032     * @param username the username
033     * @param password the password
034     * @return true, if successful
035     * @throws IOException Signals that an I/O exception has occurred.
036     */
037    @SuppressWarnings("PMD.UseVarargs")
038    MoodleClient connect(String website, String username, Password password)
039            throws IOException, MoodleAuthFailedException;
040}