|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.proxy.RenderManagerProxy
public class RenderManagerProxy
A protection proxy for the RenderManager. 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.
Permissions
,
UnauthorizedException
Field Summary | |
---|---|
protected AuthToken |
authToken
|
protected RenderManager |
manager
|
protected long |
objectType
|
protected Permissions |
permissions
|
Constructor Summary | |
---|---|
protected |
RenderManagerProxy()
|
|
RenderManagerProxy(RenderManager manager,
long objectType,
Permissions permissions)
|
Method Summary | |
---|---|
void |
addFilterRenderTypes(java.lang.String filterName,
java.util.List renderTypes)
Adds a set of render types for the given filter. |
void |
addRenderFilter(java.lang.String className)
Installs a new class into the list of render filters for the system. |
void |
copyGlobalFilters()
Copy all global filters to the current context. |
long |
getFilterRenderTypes(java.lang.String filterName)
Returns the bitset render types installed for the filter at the given index. |
java.util.Map |
getInheritedRenderFilters()
Retrieve the map of render filters -> renderTypes searching up the tree to the global level if no render filters are defined at the current/parent(s) level. |
AuthToken |
getProxyAuthToken()
|
Permissions |
getProxyPermissions()
|
RenderFilter |
getRenderFilter(java.lang.String filterName)
Return the render filter with the specified name |
int |
getRenderFilterCount()
Returns the count of currently installed render filters. |
RenderFilter[] |
getRenderFilters()
Returns an array of RenderFilter objects that list all the currently configured render filters. |
RenderManager |
getUnproxiedObject()
|
boolean |
isAdmin()
|
void |
removeAllFilters()
Removes all filters from the current context. |
void |
removeFilterRenderTypes(java.lang.String filterName,
java.util.List renderTypes)
Removes a set of render types from the given filter. |
void |
removeRenderFilter(java.lang.String filterName)
Removes the specified filter from the list of currently configured filters. |
java.lang.String |
render(java.lang.Object source,
RenderType renderType,
RenderStrategy strategy,
java.lang.String string)
Applies filters to the specified string. |
java.lang.String |
render(java.lang.Object source,
RenderType RenderType,
java.lang.String string)
Applies filters to the specified string. |
void |
save()
Saves all filters to the persistent store. |
void |
setObjectType(long objectType)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected RenderManager manager
protected long objectType
protected AuthToken authToken
protected Permissions permissions
Constructor Detail |
---|
protected RenderManagerProxy()
public RenderManagerProxy(RenderManager manager, long objectType, Permissions permissions)
Method Detail |
---|
public void setObjectType(long objectType)
public java.lang.String render(java.lang.Object source, RenderType RenderType, java.lang.String string)
RenderManager
renderType
will be used to generate the list of filter to apply to the passed in string.
The RenderStrategy.RENDER_ALL
render stategy will be used.
render
in interface RenderManager
source
- the source object for which we're rendering a string for.RenderType
- the render type to use to determine which filters to apply.string
- the string to render.
RenderType
public java.lang.String render(java.lang.Object source, RenderType renderType, RenderStrategy strategy, java.lang.String string)
RenderManager
renderType
will be used to the proper list of filters to apply to the passed in string.
render
in interface RenderManager
source
- the source object for which we're rendering a string for.renderType
- the render type to use to determine which filters to apply.strategy
- the render strategy to use to render the string.string
- the string to render.
RenderType
public RenderFilter[] getRenderFilters() throws UnauthorizedException
RenderManager
getRenderFilters
in interface RenderManager
UnauthorizedException
- if not a system administator.public void addRenderFilter(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException, java.lang.IllegalArgumentException
RenderManager
addRenderFilter
in interface RenderManager
className
- the fully qualified name of the class to add to the list of available
render filters in the system.
UnauthorizedException
- if not a system administator.
java.lang.ClassNotFoundException
- if the class could not be loaded.
java.lang.IllegalArgumentException
public int getRenderFilterCount() throws UnauthorizedException
RenderManager
getRenderFilterCount
in interface RenderManager
UnauthorizedException
- if not an administator.public RenderFilter getRenderFilter(java.lang.String filterName) throws UnauthorizedException, java.lang.IndexOutOfBoundsException
RenderManager
getRenderFilter
in interface RenderManager
filterName
- the name of the filter to return
UnauthorizedException
- if not an administator.
java.lang.IndexOutOfBoundsException
public void removeRenderFilter(java.lang.String filterName) throws UnauthorizedException
RenderManager
removeRenderFilter
in interface RenderManager
filterName
- the name of the filter to remove.
UnauthorizedException
- if not an administator.public long getFilterRenderTypes(java.lang.String filterName) throws UnauthorizedException
RenderManager
getFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.
UnauthorizedException
- if not an administator.public void addFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes) throws UnauthorizedException
RenderManager
addFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.renderTypes
- a list of render types to add.
UnauthorizedException
- if not an administator.public void removeFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes) throws UnauthorizedException
RenderManager
removeFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.renderTypes
- a list of render types to remove.
UnauthorizedException
- if not an administator.public void save() throws UnauthorizedException
RenderManager
Warning: Calling this method will expire all pertinent caches so that cache consistency is maintained.
save
in interface RenderManager
UnauthorizedException
- if not a system administator.public boolean isAdmin()
public void copyGlobalFilters() throws java.lang.IllegalStateException, UnauthorizedException
RenderManager
copyGlobalFilters
in interface RenderManager
java.lang.IllegalStateException
- if the current context already has 1 or more filters configured
UnauthorizedException
- if not an adminpublic void removeAllFilters() throws UnauthorizedException
RenderManager
removeAllFilters
in interface RenderManager
UnauthorizedException
- if not an adminpublic java.util.Map getInheritedRenderFilters()
RenderManager
getInheritedRenderFilters
in interface RenderManager
public AuthToken getProxyAuthToken()
public Permissions getProxyPermissions()
public RenderManager getUnproxiedObject()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |