Author: agilliland
Date: Wed Apr 12 16:08:45 2006
New Revision: 393644
URL: http://svn.apache.org/viewcvs?rev=393644&view=rev
Log:
code reformatting.
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/UserManager.java
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/UserManager.java
URL:
http://svn.apache.org/viewcvs/incubator/roller/branches/roller-newbackend/src/org/roller/model/UserManager.java?rev=393644&r1=393643&r2=393644&view=diff
==============================================================================
---
incubator/roller/branches/roller-newbackend/src/org/roller/model/UserManager.java
(original)
+++
incubator/roller/branches/roller-newbackend/src/org/roller/model/UserManager.java
Wed Apr 12 16:08:45 2006
@@ -4,147 +4,86 @@
import java.io.Serializable;
import java.util.List;
import java.util.Map;
-
import org.roller.RollerException;
import org.roller.pojos.WeblogTemplate;
import org.roller.pojos.PermissionsData;
-import org.roller.pojos.RoleData;
import org.roller.pojos.UserData;
import org.roller.pojos.WebsiteData;
/**
- * Manages storage, retrieval, and querying of user, website, and page data.
- *
- * @author David M Johnson
- */
-/**
- * @author dave
+ * Manages users, weblogs, permissions, and weblog pages.
*/
public interface UserManager extends Serializable {
- /**
- * Get user by name
- * @param name Username of user
- */
- //public UserData getUserByName(String name);
- /**
- * Get all users or a website.
- * @param website Get all users of this website (or null for all)
- * @returns List of UserData objects.
- */
- public List getUsers(WebsiteData website, Boolean enabled)
- throws RollerException;
/**
- * Get all websites of which user is a member
- * @param user Get all websites for this user (or null for all)
- * @param enabled Get all with this enabled state (or null or all)
- * @param active Get all with this active state (or null or all)
- * @returns List of WebsiteData objects.
+ * Add new user object to Roller. User will be given the global editor
role,
+ * unless it's the first user, who will get the global admin role.
+ *
+ * @param user User object to be added, initialized with name, password,
etc.
+ * @throws RollerException
*/
- public List getWebsites(UserData user, Boolean enabled, Boolean active)
- throws RollerException;
-
-
- public void storePermissions(PermissionsData perms) throws RollerException;
-
-
- public void removePermissions(PermissionsData perms) throws
RollerException;
-
+ public void addUser(UserData user) throws RollerException;
- /**
- * Get pending permissions for user
- * @param user User (not null)
- * @returns List of PermissionsData objects.
- */
- public List getPendingPermissions(UserData user) throws RollerException;
/**
- * Get pending permissions for website
- * @param website Website (not null)
- * @returns List of PermissionsData objects.
+ * Store user.
*/
- public List getPendingPermissions(WebsiteData user) throws RollerException;
+ public void storeUser(UserData data) throws RollerException;
- /**
- * Get permissions of user in website
- * @param website Website (not null)
- * @param user User (not null)
- * @return PermissionsData object
- */
- public PermissionsData getPermissions(
- WebsiteData website, UserData user) throws RollerException;
- /**
- * Get all permissions in website
- * @param website Website (not null)
- * @return PermissionsData object
- */
- public List getAllPermissions(
- WebsiteData website) throws RollerException;
+ public void removeUser(UserData user) throws RollerException;
- /**
- * Get all permissions of user
- * @param user User (not null)
- * @return PermissionsData object
- */
- public List getAllPermissions(
- UserData user) throws RollerException;
- public PermissionsData retrievePermissions(String inviteId)
- throws RollerException;
+ public UserData retrieveUser(String id)throws RollerException;
- /**
- * Invite user to join a website with specific permissions
- * @param website Website to be joined (persistent instance)
- * @param user User to be invited (persistent instance)
- * @param perms Permissions mask (see statics in PermissionsData)
- * @return New PermissionsData object, with pending=true
- */
- public PermissionsData inviteUser(
- WebsiteData website, UserData user, short perms) throws
RollerException;
- /**
- * Retire user from a website
- * @param website Website to be retired from (persistent instance)
- * @param user User to be retired (persistent instance)
+ /**
+ * Get user object by user name (only enabled users)
*/
- public void retireUser(
- WebsiteData website, UserData user) throws RollerException;
-
-
- public void removeUser(UserData user) throws RollerException;
+ public UserData getUser(String userName) throws RollerException;
- /** Release any resources used */
- public void release();
+ /**
+ * Get user object by user name, optionally include dis-enabled users
+ */
+ public UserData getUser(String userName, Boolean enabled) throws
RollerException;
- //--------------------------------------------------------------- UserData
- /** Get all enabled users */
+ /**
+ * Get all enabled users
+ */
public List getUsers() throws RollerException;
+
/**
* Get all users, optionally include dis-enabled users.
+ *
* @param enabled True for enabled only, false for disabled only, null for
all
*/
public List getUsers(Boolean enabled) throws RollerException;
- /** Get user object by user name (only enabled users) */
- public UserData getUser( String userName ) throws RollerException;
- /** Get user object by user name, optionally include dis-enabled users */
- public UserData getUser( String userName, Boolean enabled ) throws
RollerException;
+ /**
+ * Get all users or a website.
+ *
+ * @param website Get all users of this website (or null for all)
+ * @returns List of UserData objects.
+ */
+ public List getUsers(WebsiteData website, Boolean enabled) throws
RollerException;
/**
- * Add new user object to Roller. User will be given the global editor
role,
- * unless it's the first user, who will get the global admin role.
- * @param user User object to be added, initialized with name, password,
etc.
- * @throws RollerException
+ * Returns users whose usernames or email addresses start with a string.
+ * @param startsWith String to match userNames and emailAddresses against
+ * @param offset Offset into results (for paging)
+ * @param length Max to return (for paging)
+ * @param enabled True for only enalbed, false for disabled, null for
all
+ * @return List of (up to length) users that match startsWith string
*/
- public void addUser(UserData user) throws RollerException;
+ public List getUsersStartingWith(String startsWith,
+ int offset, int length, Boolean enabled) throws RollerException;
public void createWebsite(WebsiteData newWebsite) throws RollerException;
@@ -152,6 +91,7 @@
/**
* Create a fresh new website.
+ *
* @param ud User creating website
* @param pages Pages to be used in theme (TODO: elim. this
redundancy)
* @param handle Handle of new website
@@ -174,52 +114,119 @@
String locale,
String timeZone) throws RollerException;
- public UserData retrieveUser(String id)throws RollerException;
+
/**
- * Store user.
+ * Store website
*/
- public void storeUser( UserData data ) throws RollerException;
+ public void storeWebsite(WebsiteData data) throws RollerException;
+
+ public void removeWebsite(WebsiteData website) throws RollerException;
+
+
+ public WebsiteData retrieveWebsite(String id) throws RollerException;
- //------------------------------------------------------------ WebsiteData
/**
* Get website specified by handle (or null if enabled website not found).
+ *
* @param handle Handle of website
*/
- public WebsiteData getWebsiteByHandle(String handle)
- throws RollerException;
+ public WebsiteData getWebsiteByHandle(String handle) throws
RollerException;
+
/**
* Get website specified by handle with option to return only enabled
websites.
+ *
* @param handle Handle of website
*/
- public WebsiteData getWebsiteByHandle(String handle, Boolean enabled)
- throws RollerException;
+ public WebsiteData getWebsiteByHandle(String handle, Boolean enabled)
throws RollerException;
+
- public WebsiteData retrieveWebsite(String id) throws RollerException;
/**
- * Store website
+ * Get all websites of which user is a member
+ *
+ * @param user Get all websites for this user (or null for all)
+ * @param enabled Get all with this enabled state (or null or all)
+ * @param active Get all with this active state (or null or all)
+ * @returns List of WebsiteData objects.
*/
- public void storeWebsite(WebsiteData data) throws RollerException;
+ public List getWebsites(UserData user, Boolean enabled, Boolean active)
throws RollerException;
- //---------------------------------------------------------------
WeblogTemplate
- /** Get user's page by name */
- public WeblogTemplate getPageByName(WebsiteData w, String p) throws
RollerException;
+ public void storePermissions(PermissionsData perms) throws RollerException;
- /** Get user's page by link */
- public WeblogTemplate getPageByLink(WebsiteData w, String p) throws
RollerException;
+ public void removePermissions(PermissionsData perms) throws
RollerException;
- /** Get users pages */
- public List getPages(WebsiteData w) throws RollerException;
+
+ public PermissionsData retrievePermissions(String id) throws
RollerException;
/**
- * Get page by ID
+ * Get pending permissions for user
+ *
+ * @param user User (not null)
+ * @returns List of PermissionsData objects.
*/
- public WeblogTemplate retrievePage(String id) throws RollerException;
+ public List getPendingPermissions(UserData user) throws RollerException;
+
+
+ /**
+ * Get pending permissions for website
+ *
+ * @param website Website (not null)
+ * @returns List of PermissionsData objects.
+ */
+ public List getPendingPermissions(WebsiteData user) throws RollerException;
+
+
+ /**
+ * Get permissions of user in website
+ *
+ * @param website Website (not null)
+ * @param user User (not null)
+ * @return PermissionsData object
+ */
+ public PermissionsData getPermissions(WebsiteData website, UserData user)
throws RollerException;
+
+
+ /**
+ * Get all permissions in website
+ *
+ * @param website Website (not null)
+ * @return PermissionsData object
+ */
+ public List getAllPermissions(WebsiteData website) throws RollerException;
+
+
+ /**
+ * Get all permissions of user
+ *
+ * @param user User (not null)
+ * @return PermissionsData object
+ */
+ public List getAllPermissions(UserData user) throws RollerException;
+
+
+ /**
+ * Invite user to join a website with specific permissions
+ *
+ * @param website Website to be joined (persistent instance)
+ * @param user User to be invited (persistent instance)
+ * @param perms Permissions mask (see statics in PermissionsData)
+ * @return New PermissionsData object, with pending=true
+ */
+ public PermissionsData inviteUser(WebsiteData website, UserData user,
short perms) throws RollerException;
+
+
+ /**
+ * Retire user from a website
+ *
+ * @param website Website to be retired from (persistent instance)
+ * @param user User to be retired (persistent instance)
+ */
+ public void retireUser(WebsiteData website, UserData user) throws
RollerException;
/**
@@ -234,24 +241,32 @@
public void removePage(WeblogTemplate page) throws RollerException;
- public void removeWebsite(WebsiteData website) throws RollerException;
+ /**
+ * Get page by ID
+ */
+ public WeblogTemplate retrievePage(String id) throws RollerException;
- /**
- * Remove contents of website.
+ /**
+ * Get user's page by name
*/
- //public void removeWebsiteContents(WebsiteData data) throws
RollerException;
+ public WeblogTemplate getPageByName(WebsiteData w, String p) throws
RollerException;
- /**
- * Returns users whose usernames or email addresses start with a string.
- * @param startsWith String to match userNames and emailAddresses against
- * @param offset Offset into results (for paging)
- * @param length Max to return (for paging)
- * @param enabled True for only enalbed, false for disabled, null for
all
- * @return List of (up to length) users that match startsWith string
+
+ /**
+ * Get user's page by link
*/
- public List getUsersStartingWith(String startsWith,
- int offset, int length, Boolean enabled) throws RollerException;
+ public WeblogTemplate getPageByLink(WebsiteData w, String p) throws
RollerException;
+
+
+ /**
+ * Get users pages
+ */
+ public List getPages(WebsiteData w) throws RollerException;
+
+
+ public void release();
+
}
