com.jivesoftware.forum.proxy
Class QueryManagerProxy

java.lang.Object
  com.jivesoftware.forum.proxy.QueryManagerProxy

All Implemented Interfaces:

QueryManager

public class QueryManagerProxy
extends java.lang.Object
implements QueryManager

A protection proxy for the QueryManager. 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:

QueryManager, Permissions, UnauthorizedException

Constructor Summary

QueryManagerProxy(QueryManager queryManager, AuthToken auth, Permissions permissions)
Creates a new QueryManagerProxy object.

Method Summary

Query	createQuery() Creates a query object to search through all forums.
Query	createQuery(Forum[] forums) Creates a query object to search through the specified array of forums.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryManagerProxy

public QueryManagerProxy(QueryManager queryManager,
                         AuthToken auth,
                         Permissions permissions)

Creates a new QueryManagerProxy object.

Parameters:

queryManager - the queryManager to protect by proxy

auth - the user's authorization token

permissions - the permissions to use with this proxy

Method Detail

createQuery

public Query createQuery()

Description copied from interface: QueryManager

Creates a query object to search through all forums. Note: only forums that the user calling this method has read access for will be included in the search.

Specified by:

createQuery in interface QueryManager

Returns:

a Query object that can be used to search all visible and searchable forums.

createQuery

public Query createQuery(Forum[] forums)

Description copied from interface: QueryManager

Creates a query object to search through the specified array of forums. Note: only the forums that the user calling this method has read access for will be included in the search.

Specified by:

createQuery in interface QueryManager

Parameters:

forums - the forums to search.

Returns:

a Query object that can be used to search the specified forums.