// Confsys - a conferencing system
//
// Copyright (C) 1996 by Jef Poskanzer <jef@mail.acme.com>.  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE.
//
// Visit the ACME Labs Java page for up-to-date versions of this and other
// fine Java utilities: http://www.acme.com/java/

package Acme.Conf;

import java.util.*;

/// A conferencing system.
// <P>
// A conferencing system is made up of a list of conference groups and
// a list of users.
// There's also a designated list of administrators who are authorized to
// perform maintenance functions.
// <P>
// The abstract classes - Confsys Confgroup Conference Topic Response User
// Conflist Session - define the basic API for the conferencing system.
// This API is then implemented in both client and server versions, with the
// client-side implementation mirroring the server side via secure RPC.
// <P>
// <A HREF="/resources/classes/Acme/Conf/Confsys.java">Fetch the software.</A><BR>
// <A HREF="/resources/classes/Acme.tar.gz">Fetch the entire Acme package.</A>
// <P>
// @see Confgroup
// @see User

public abstract class Confsys
    {

    /// An Enumeration of the Confgroups.
    public abstract Enumeration getConfgroups();
    
    /// An Enumeration of the Users.
    public abstract Enumeration getUsers();
    
    /// Find a user by userid.
    // @return null if no such user exists.
    public abstract User findUser( String userid );
    
    /// Check whether a user is an administrator.
    public abstract boolean isAdmin( User user );


    /// Add a new conference group to the system.
    // The conference group starts out with no conferences in it.
    // <P>
    // Only an administrator may do this.
    public abstract Confgroup addConfgroup( Session session, String name, User manager );

    /// Remove a conference group from the system.
    // The conferences it contains may continue to exist in other
    // conference groups.
    // <P>
    // Only an administrator may do this.
    public abstract void rmConfgroup( Session session, Confgroup confgroup );

    /// Add a new user to the system.
    // <P>
    // Only an administrator may do this.
    public abstract User addUser( Session session, String userid, String realName );

    /// Remove a user from the system.
    // <P>
    // Only an administrator may do this.
    public abstract void rmUser( Session session, User user );

    }