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;
022import java.util.Map;
023import org.jdrupes.keycloak.moodleauth.moodle.model.MoodleSiteInfo;
024import org.jdrupes.keycloak.moodleauth.moodle.model.MoodleUser;
025
026/**
027 * Represents the client side of a connection to a moodle server.
028 */
029public interface MoodleClient extends AutoCloseable {
030
031    @Override
032    void close();
033
034    /**
035     * Invoke some function. Allows the invocation of functions that
036     * haven't been typed yet.
037     *
038     * @param wsfunction the function
039     * @param params the parameters
040     * @return the result
041     */
042    Object invoke(String wsfunction, Map<String, Object> params)
043            throws IOException;
044
045    /**
046     * The authenticated moodle user.
047     *
048     * @return the moodle user
049     */
050    MoodleUser moodleUser();
051
052    /**
053     * The site info (includes information about the user)
054     *
055     * @return the moodle site info
056     */
057    MoodleSiteInfo siteInfo();
058
059}