[geeklog-cvs] geeklog-2/lib/A_and_A/common AAServiceInteface.class.php,NONE,1.1

[geeklog-cvs-admin at lists.geeklog.net]

Update of /usr/cvs/geeklog/geeklog-2/lib/A_and_A/common
In directory internal.geeklog.net:/tmp/cvs-serv28324

Added Files:
	AAServiceInteface.class.php 
Log Message:
This is not a true PHP5 interface.  Moved it to common folder since client and server classes implement it.

--- NEW FILE: AAServiceInteface.class.php ---
<?php

/* Reminder: always indent with 4 spaces (no tabs). */
/**
* Enterprise Authentication & Authorization Service (A&A)
*
* The license for this software is yet to be determined.  In the meantime,
* all rights are reserved.  Use of this software is not permitted without
* the expressed written consent of Tony Bibbs
*
* @author Tony Bibbs <tony at geeklog.net>
* @copyright Tony Bibbs 2003
* @version $Id: AAServiceInteface.class.php,v 1.1 2003/07/11 20:12:10 tony Exp $
*
*/

/**
* The A&A service interface
*/
require_once 'A_and_A/common/AAServiceInterface.class.php'

/**
* This class defines the A&A service interface.
*
* @author Tony Bibbs <tony at geeklog.net>
* @package net.geeklog.enterprise.aa.common
*
*/
interface AAServiceInterface {
    /**
    * Authenticates a user against the service
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to authenticate against
    * @param string $userName User to authenticate
    * @param string $userPass Password to use
    *
    */
    public function authenticate($appId, $userName, $userPass)
    {
    }
    
    /**
    * Changes a user's password
    *
    * @author Tony Bibbs tony at geeklog.net
    * @access public
    * @param string $appId Application to operate against
    * @param string $userName User to change password for
    * @param string $userPass Old password
    * @param string $newPass New password
    *
    */
    public function changePassword($appId, $userName, $userPass, $newPass)
    {
    }
    
    /**
    * Allows an administrator to change another user's password
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to operate against
    * @param string $adminUserName Admin who is performing password change
    * @param string $adminPass Password for the admin
    * @param string $userName User to change password for
    * @param string $newPass New password for given user
    *
    */
    public function changePasswordByAdmin($appId, $adminUserName, $adminPass, $userName, $newPass)
    {
    }
    
    /**
    * Allows an admin to reset a user's password
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to operate against
    * @param string $adminUserName Admin who is performing the password reset
    * @param string $adminPass Password for admin
    * @param string $userName User to reset password for
    *
    */
    public function resetPassword($appId, $adminUserName, $adminPass, $userName)
    {
    }
    
    /**
    * Gets the application privileges for a given user
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to get privileges from
    * @param string $adminUserName Admin's username
    * @param string $adminPass Password for admin
    * @param string $userName User to get application privileges for
    *
    */
    public function getUserPrivilges($appId, $adminUserName, $adminPass, $userName)
    {
    }
    
    /**
    * Gets the security groups a user belongs to
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to operate against
    * @param string $adminUserName The admin's username
    * @param string $adminPass The admin's password
    * @param string $userName User to get security groups for
    *
    */
    public function getUserGroups($appId, $adminUserName, $adminPass, $userName)
    {
    }
    
    /**
    * Sets application privileges for the specified user
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to operate against
    * @param string $adminUserName Administrator's username
    * @param string $adminPass Password for the administrator
    * @param string $userName User to set application privileges for
    * @param array $privArray Array of privileges
    *
    */
    public function setUserPrivileges($appId, $adminUserName, $adminPass, $userName, $privArray)
    {
    }
    
    /**
    * Retrieves all existing privileges for a given application
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to get privileges for
    * @param string $adminUserName Username for the administrator
    * @param string $adminPass Administrator's password
    * @param boolean $doAuthentication Indicates if we should authenticate the administrator first
    *
    */
    public function listAppPrivileges($appId, $adminUserName, $adminPass, $doAuthentication)
    {
    }
    
    /**
    * Retrieves all existing security groups for a given application
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to get security groups for
    * @param string $adminUserName Username for the administrator
    * @param string $adminPass Administrator's password
    *
    */
    public function listAppGroups($appId, $adminUserName, $adminPass)
    {
    }
    
    /**
    * Gets the privileges for a given user and application
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId ID to operate against
    * @param string $userName User to get privileges for
    *
    */
    public function getPrivileges($appId, $userName)
    {
    }
    
    /**
    * Gets the security groups for a given user and application
    *
    * @author Tony Bibbs <tony at geeklog.net>
    * @access public
    * @param string $appId Application to operate against
    * @param string $userName User to get security groups for.
    *
    */
    public function getGroups($appId, $userName)
    {
    }
}

?>