Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Jive Forums API (5.5.8) Developer Javadocs
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.jivesoftware.forum.proxy
Class WatchManagerProxy

java.lang.Object
  extended by com.jivesoftware.forum.proxy.WatchManagerProxy
All Implemented Interfaces:
WatchManager
public class WatchManagerProxy
extends java.lang.Object
implements WatchManager

A protection proxy for the WatchManager class. A proxy has a set of permissions that are specified at creation time of the proxy. Subsequently, those permissions are use to restrict access to protected methods. If a user does not have the right to execute a particular method, an UnauthorizedException is thrown.

See Also:
Permissions, UnauthorizedException

Constructor Summary
WatchManagerProxy(WatchManager manager, AuthToken authToken, Permissions permissions)
          Creates a new WatchManagerProxy object.
 
Method Summary
 Watch createWatch(User user, Forum forum)
          Create a watch on a forum for the specified user.
 Watch createWatch(User user, ForumCategory category)
          Create a watch on a category for the specified user.
 Watch createWatch(User user, ForumThread thread)
          Create a watch on a thread for the specified user.
 Watch createWatch(User user, User watchedUser)
          Create a watch on a user for the specified user.
 void deleteWatch(Watch watch)
          Delete the specified watch.
 void deleteWatches(User user)
          Deletes all watches that a user has.
 java.util.Iterator getAllWatches(User user, int objectType)
          Returns an iterator for all objects of a particular type that a user is watching.
 int getDeleteDays()
          Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
 java.util.Iterator getRecursiveForumWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns all the Forum objects the user is watching under the category and its subcategories.
 java.util.Iterator getRecursiveThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 java.util.Iterator getThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 int getTotalWatchCount(User user, int objectType)
          Returns a count of all watches that a user has of a particular type.
 Watch getWatch(User user, Forum forum)
          Returns a watch on a particular forum, or null if there isn't a watch.
 Watch getWatch(User user, ForumCategory category)
          Returns a watch on a particular category, or null if there isn't a watch.
 Watch getWatch(User user, ForumThread thread)
          Returns a watch on a particular thread, or null if there isn't a watch.
 Watch getWatch(User user, User watchedUser)
          Returns a watch on a particular thread, or null if there isn't a watch.
 int getWatchCount(User user, Forum forum)
          Return the count of all thread watches in a particular forum for the given user.
 int getWatchCount(User user, ForumCategory category)
          Return the count of all forum watches in a particular category for the given user.
 java.util.Iterator getWatchers(int objectType, long objectID)
          Returns all the Users watching the specified object.
 java.util.Iterator getWatches(User user, Forum forum)
          Returns an Iterator for all the thread objects a user is watching in a forum.
 java.util.Iterator getWatches(User user, ForumCategory category)
          Returns an Iterator for all the forum objects a user is watching in a category.
 java.util.Iterator getWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the Forums watched by the User under the given Category.
 java.util.Iterator getWatches(User user, Forum forum, int startIndex, int numResults)
          Returns all the ForumThreads watched by the User under the given Forum.
 Watch[] getWatchList(User user, int objectType)
          Returns an array of Watch objects for a particular object type that the given user is watching.
 boolean isWatched(User user, Forum forum)
          Returns true if the user is watching the specified forum.
 boolean isWatched(User user, ForumCategory category)
          Returns true if the user is watching the specified category.
 boolean isWatched(User user, ForumThread thread)
          Returns true if the user is watching the specified thread.
 boolean isWatched(User user, User watchedUser)
          Returns true if the user is watching the specified user.
 void setDeleteDays(int deleteDays)
          Sets the number of days that a watched object can remain inactive before watches on that object are deleted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WatchManagerProxy

public WatchManagerProxy(WatchManager manager,
                         AuthToken authToken,
                         Permissions permissions)
Creates a new WatchManagerProxy object.

Parameters:
manager - the watchmanager to protect by proxy.
authToken - the user's authorization token.
permissions - the permissions to use with this proxy.
Method Detail

setDeleteDays

public void setDeleteDays(int deleteDays)
                   throws UnauthorizedException
Description copied from interface: WatchManager
Sets the number of days that a watched object can remain inactive before watches on that object are deleted.

Specified by:
setDeleteDays in interface WatchManager
Parameters:
deleteDays - the number days a watch can be inactive before being automatically deleted.
Throws:
UnauthorizedException - if not a system admin.

getDeleteDays

public int getDeleteDays()
Description copied from interface: WatchManager
Returns the number of days that a watched object can remain inactive before watches on that object are deleted.

Specified by:
getDeleteDays in interface WatchManager
Returns:
the number of days a watched object can be inactive before watches on it are deleted.

createWatch

public Watch createWatch(User user,
                         User watchedUser)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Create a watch on a user for the specified user.

Specified by:
createWatch in interface WatchManager
Parameters:
user - the user to set the watch for.
watchedUser - the user to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

public Watch createWatch(User user,
                         ForumThread thread)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Create a watch on a thread for the specified user.

Specified by:
createWatch in interface WatchManager
Parameters:
user - the user to set the watch for.
thread - the thread to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

public Watch createWatch(User user,
                         Forum forum)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Create a watch on a forum for the specified user.

Specified by:
createWatch in interface WatchManager
Parameters:
user - the user to set the watch for.
forum - the forum to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

public Watch createWatch(User user,
                         ForumCategory category)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Create a watch on a category for the specified user.

Specified by:
createWatch in interface WatchManager
Parameters:
user - the user to set the watch for.
category - the category to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

getTotalWatchCount

public int getTotalWatchCount(User user,
                              int objectType)
                       throws UnauthorizedException
Description copied from interface: WatchManager
Returns a count of all watches that a user has of a particular type. Valid object types are:

Specified by:
getTotalWatchCount in interface WatchManager
Parameters:
user - the user to get the watch count for.
objectType - the object type to get a watch count for.
Returns:
the total number of watches that a user has of type objectType.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatchList

public Watch[] getWatchList(User user,
                            int objectType)
Description copied from interface: WatchManager
Returns an array of Watch objects for a particular object type that the given user is watching. Valid objectType's are:

Specified by:
getWatchList in interface WatchManager
Parameters:
user - the user to retrieve watches for
objectType - the object type.
Returns:
the user's watch list corresponding to an object type.

getAllWatches

public java.util.Iterator getAllWatches(User user,
                                        int objectType)
                                 throws UnauthorizedException
Description copied from interface: WatchManager
Returns an iterator for all objects of a particular type that a user is watching. Valid objecttypes are:

Specified by:
getAllWatches in interface WatchManager
Parameters:
user - the user.
objectType - the object type.
Returns:
an iterator for all objects of type objectType that a user is watching.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatchCount

public int getWatchCount(User user,
                         Forum forum)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Return the count of all thread watches in a particular forum for the given user.

Specified by:
getWatchCount in interface WatchManager
Parameters:
user - the user to return the watch count for.
Returns:
the count of thread watches for a user in a given forum.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatchCount

public int getWatchCount(User user,
                         ForumCategory category)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Return the count of all forum watches in a particular category for the given user.

Specified by:
getWatchCount in interface WatchManager
Parameters:
user - the user to return the watch count for.
category - the category to return the watch count for.
Returns:
the count of forum watches for a user in a given category.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatches

public java.util.Iterator getWatches(User user,
                                     Forum forum)
                              throws UnauthorizedException
Description copied from interface: WatchManager
Returns an Iterator for all the thread objects a user is watching in a forum.

Specified by:
getWatches in interface WatchManager
Parameters:
user - the user.
forum - the forum.
Returns:
an iterator for all the threads a user is watching in a forum.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatches

public java.util.Iterator getWatches(User user,
                                     ForumCategory category)
                              throws UnauthorizedException
Description copied from interface: WatchManager
Returns an Iterator for all the forum objects a user is watching in a category.

Specified by:
getWatches in interface WatchManager
Parameters:
user - the user.
category - the category.
Returns:
an iterator for all the forums a user is watching in a category.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

public Watch getWatch(User user,
                      User watchedUser)
               throws UnauthorizedException
Description copied from interface: WatchManager
Returns a watch on a particular thread, or null if there isn't a watch.

Specified by:
getWatch in interface WatchManager
Parameters:
user - the user with the watch.
watchedUser - the user being watched.
Returns:
the Watch or null if the watchedUser isn't being watched by the user.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

public Watch getWatch(User user,
                      ForumThread thread)
               throws UnauthorizedException
Description copied from interface: WatchManager
Returns a watch on a particular thread, or null if there isn't a watch.

Specified by:
getWatch in interface WatchManager
Parameters:
user - the user with the watch.
thread - the thread being watched.
Returns:
the Watch or null if the thread isn't being watched by the user.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

public Watch getWatch(User user,
                      Forum forum)
               throws UnauthorizedException
Description copied from interface: WatchManager
Returns a watch on a particular forum, or null if there isn't a watch.

Specified by:
getWatch in interface WatchManager
Parameters:
user - the user with the watch.
forum - the forum being watched.
Returns:
the Watch or null if the forum isn't being watched by the user..
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

public Watch getWatch(User user,
                      ForumCategory category)
               throws UnauthorizedException
Description copied from interface: WatchManager
Returns a watch on a particular category, or null if there isn't a watch.

Specified by:
getWatch in interface WatchManager
Parameters:
user - the user with the watch.
category - the category being watched.
Returns:
the Watch or null if the category isn't being watched by the user..
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

public boolean isWatched(User user,
                         ForumCategory category)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Returns true if the user is watching the specified category.

Specified by:
isWatched in interface WatchManager
Parameters:
user - the User watching the object.
category - the category to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

public boolean isWatched(User user,
                         Forum forum)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Returns true if the user is watching the specified forum.

Specified by:
isWatched in interface WatchManager
Parameters:
user - the User watching the object.
forum - the forum to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

public boolean isWatched(User user,
                         ForumThread thread)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Returns true if the user is watching the specified thread.

Specified by:
isWatched in interface WatchManager
Parameters:
user - the User watching the object.
thread - the thread to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

public boolean isWatched(User user,
                         User watchedUser)
                  throws UnauthorizedException
Description copied from interface: WatchManager
Returns true if the user is watching the specified user.

Specified by:
isWatched in interface WatchManager
Parameters:
user - the User watching the object.
watchedUser - the user to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

deleteWatches

public void deleteWatches(User user)
                   throws UnauthorizedException
Description copied from interface: WatchManager
Deletes all watches that a user has.

Specified by:
deleteWatches in interface WatchManager
Parameters:
user - the user.
Throws:
UnauthorizedException

deleteWatch

public void deleteWatch(Watch watch)
                 throws UnauthorizedException
Description copied from interface: WatchManager
Delete the specified watch.

Specified by:
deleteWatch in interface WatchManager
Parameters:
watch - the watch to delete.
Throws:
UnauthorizedException - if not a system admin or the user owning the watch.

getWatchers

public java.util.Iterator getWatchers(int objectType,
                                      long objectID)
                               throws UnauthorizedException
Description copied from interface: WatchManager
Returns all the Users watching the specified object.

Specified by:
getWatchers in interface WatchManager
Parameters:
objectType - the type of the object from JiveConstants.
objectID - the ID of the object.
Returns:
Iterator of Users.
Throws:
UnauthorizedException - if not a system admin

getWatches

public java.util.Iterator getWatches(User user,
                                     Forum forum,
                                     int startIndex,
                                     int numResults)
Description copied from interface: WatchManager
Returns all the ForumThreads watched by the User under the given Forum.

Specified by:
getWatches in interface WatchManager
Parameters:
user - the user.
forum - the forum to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by the user.

getWatches

public java.util.Iterator getWatches(User user,
                                     ForumCategory category,
                                     int startIndex,
                                     int numResults)
Description copied from interface: WatchManager
Returns the Forums watched by the User under the given Category. This method does not recurse SubCategories. For recursive watches, use getRecursiveForumWatches.

Specified by:
getWatches in interface WatchManager
Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return
Returns:
the Forum objects watched by the user.

getRecursiveForumWatches

public java.util.Iterator getRecursiveForumWatches(User user,
                                                   ForumCategory category,
                                                   int startIndex,
                                                   int numResults)
Description copied from interface: WatchManager
Returns all the Forum objects the user is watching under the category and its subcategories. Recurses on subcategories.

Specified by:
getRecursiveForumWatches in interface WatchManager
Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the Forum objects watched by this user.

getThreadWatches

public java.util.Iterator getThreadWatches(User user,
                                           ForumCategory category,
                                           int startIndex,
                                           int numResults)
Description copied from interface: WatchManager
Returns the ForumThread objects the user is watching under the provided ForumCategory. Does not recurse to subcategories, only the Forums directly in the provided ForumCategory.

Specified by:
getThreadWatches in interface WatchManager
Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by this user.

getRecursiveThreadWatches

public java.util.Iterator getRecursiveThreadWatches(User user,
                                                    ForumCategory category,
                                                    int startIndex,
                                                    int numResults)
Description copied from interface: WatchManager
Returns the ForumThread objects the user is watching under the provided ForumCategory. Recurses through Subcategories and Forums.

Specified by:
getRecursiveThreadWatches in interface WatchManager
Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by this user.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Jive Forums Project Page
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2006 Jive Software.