Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSMainAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.rss.RSSActionSupport
          extended by com.jivesoftware.forum.action.rss.RSSMainAction
All Implemented Interfaces:
AuthTokenAware, UserAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class RSSMainAction
extends RSSActionSupport
implements UserAware

A simple action which assists with the page which lists all RSS feeds available.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.base.action.rss.RSSActionSupport
DATE_FORMAT, DEFAULT_NUM_ITEMS, DISABLED, request, response
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
RSSMainAction()
           
 
Method Summary
 java.lang.String execute()
          Checks to see if RSS feeds are disabled.
 AuthToken getAnonymousAuthToken()
           
 java.util.Iterator getCategories()
           
 java.lang.String getFeed()
           
 ForumFactory getForumFactory()
           
 User getPageUser()
          Returns null always -- subclasses should override this is they wish to provide access to the page user.
static java.lang.String pad(int num, java.lang.String padding)
           
 void setFeed(java.lang.String feed)
           
 void setUser(User user)
           
 
Methods inherited from class com.jivesoftware.base.action.rss.RSSActionSupport
executeRSS, getAuthToken, getDateFormat, getDefaultBaseURL, getFeedTitle, getNumItems, getPassword, getUsername, rssFeedsEnabled, setAuthToken, setNumItems, setPassword, setServletRequest, setServletResponse, setUsername
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RSSMainAction

public RSSMainAction()
Method Detail

getFeed

public java.lang.String getFeed()

setFeed

public void setFeed(java.lang.String feed)

getAnonymousAuthToken

public AuthToken getAnonymousAuthToken()

getForumFactory

public ForumFactory getForumFactory()

getCategories

public java.util.Iterator getCategories()

setUser

public void setUser(User user)
Specified by:
setUser in interface UserAware

getPageUser

public User getPageUser()
Description copied from class: RSSActionSupport
Returns null always -- subclasses should override this is they wish to provide access to the page user.

Overrides:
getPageUser in class RSSActionSupport

execute

public java.lang.String execute()
                         throws java.lang.Exception
Description copied from class: RSSActionSupport
Checks to see if RSS feeds are disabled. If so, RSSActionSupport.DISABLED is returned. Otherwise, RSSActionSupport.executeRSS() is returned.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class RSSActionSupport
Returns:
the return code for this action's execution.
Throws:
java.lang.Exception

pad

public static java.lang.String pad(int num,
                                   java.lang.String padding)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.