jahiasiteusermanagerservice.java

java 写的一个新闻发布系统

//
//                                   ____.
//                       __/\ ______|    |__/\.     _______
//            __   .____|    |       \   |    +----+       \
//    _______|  /--|    |    |    -   \  _    |    :    -   \_________
//   \\______: :---|    :    :           |    :    |         \________>
//           |__\---\_____________:______:    :____|____:_____\
//                                      /_____|
//
//                 . . . i n   j a h i a   w e   t r u s t . . .
//

package org.jahia.services.usermanager;

import java.util.*;
import org.jahia.services.JahiaService;
import org.jahia.services.usermanager.JahiaUser;
import org.jahia.exceptions.JahiaException;

import org.jahia.data.JahiaDOMObject;


/**
 * Manage users memberhip in a multi site context
 *
 * @author  Khue Ng
 */
public abstract class JahiaSiteUserManagerService extends JahiaService
{


    //-------------------------------------------------------------------------
    /**
     * Create a new membership for a user on a gived site
     *
     * @param int siteID, the site identifier
     * @param JahiaUser user, the user to add as member
 	 * @author NK
     */
    public abstract boolean addMember (int siteID, JahiaUser user) throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Remove a user's membership from a site, doesn't delete the user
     *
     * @param int siteID, the site identifier
     * @param JahiaUser user  reference on the user to be removed from the site.
	 * @author NK
	 */
    public abstract boolean removeMember (int siteID, JahiaUser user) throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Remove a user's membership from all sites, doesn't delete the user
     *
     * @param JahiaUser user, the user to be removed from the site.
	 * @author  Khue Ng
     */
    public abstract boolean removeMember (JahiaUser user) throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Remove all users of a site ( only the membership, not the user )
     *
     * @param int siteID, the identifier of the site.
	 * @author  Khue Ng
     */
    public abstract boolean removeMembers (int siteID) throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * This method returns an hashtable of username/usr_id couples of members of the requested site
     * 
     * @param int siteID, the site identifier
     * @return Return an Hashtable of username/usrid couples members of this site.
	 * @author  Khue Ng
     */
    public abstract Hashtable getMembersMap (int siteID) throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * This method returns the list of all members of this site.
     *
     * @param int siteID, the site identifier
     * @return Vector of members of this site.
	 * @author  Khue Ng
     */
    public abstract Vector getMembers (int siteID) throws JahiaException ;


    //-------------------------------------------------------------------------
    /**
     * Check if a user has or not access on a site.
     *
     * @param int siteID, the site identifier
     * @param String username, the site identifier
     * @return Return the user if not null.
	 * @author  Khue Ng
     */
    public abstract JahiaUser getMember (int siteID, String username) throws JahiaException;


    //--------------------------------------------------------------------------
	/**
	 * return a DOM document of all users membership of a site
	 *
	 * @param int the site id
	 *
	 * @return JahiaDOMObject a DOM representation of this object
	 *
	 * @author NK
	 */
	public abstract JahiaDOMObject getUserMembershipsAsDOM( int siteID )
	throws JahiaException;


    //--------------------------------------------------------------------------
	/**
	 * return a DOM document of external users ( from other site ) 
	 * that have membership access on this site
	 *
	 * @param int the site id
	 *
	 * @return JahiaDOMObject a DOM representation of this object
	 *
	 * @author NK
	 */
	public abstract JahiaDOMObject getAuthExternalUsersAsDOM( int siteID )
	throws JahiaException;


}