|
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.webservices.server.WSUtil
public final class WSUtil
Utilities for working with webservices
Method Summary | |
---|---|
static void |
cleanup()
Cleans up thread locals |
static Announcement |
convert(Announcement announcement)
|
static Forum |
convert(Forum forum)
Converts a Forum object to a webservice Forum object. |
static ForumCategory |
convert(ForumCategory category)
Converts a ForumCategory object to a webservice ForumCategory object. |
static ForumMessage |
convert(ForumMessage message)
Converts a ForumMessage object to a webservice ForumMessage object. |
static ForumThread |
convert(ForumThread thread)
Converts a ForumThread object to a webservice ForumThread object. |
static ForumThread |
convert(ForumThread thread,
boolean reduceData)
Converts a ForumThread object to a webservice ForumThread object
and allows forum name, unfilteredSubject, and unfilteredBody to be set to null to reduce response size. |
static Group |
convert(Group group)
Converts a Group to a webservices Group object. |
static java.util.Locale |
convert(Locale l)
Converts a webservices locale object to java locale object |
static Locale |
convert(java.util.Locale l)
Converts a java locale to a locale we can use for webservices |
static PrivateMessage |
convert(PrivateMessage privateMessage)
|
static PrivateMessageFolder |
convert(PrivateMessageFolder privateMessageFolder)
|
static ResultFilter |
convert(ResultFilter filter)
Converts a webservice ResultFilter object to a ResultFilter . |
static User |
convert(User user)
Converts a User to a webservices User . |
static Watch |
convert(Watch watch)
Converts a Watch to a webservices Watch object. |
static AuthToken |
getAuthToken()
Returns the current thread's AuthToken . |
static ForumFactory |
getForumFactory()
Creates a forum factory using the AuthToken from the current Thread. |
static void |
setAuthToken(AuthToken token)
Used to set the authtoken on a thread local variable. |
static void |
setForumFactory(ForumFactory factory)
For internal testing purposes only! |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Forum convert(Forum forum)
Forum
object to a webservice Forum
object.
forum
- forum object.
public static ForumCategory convert(ForumCategory category)
ForumCategory
object to a webservice ForumCategory
object.
category
- category object.
public static ForumThread convert(ForumThread thread)
ForumThread
object to a webservice ForumThread
object.
thread
- thread object.
public static ForumThread convert(ForumThread thread, boolean reduceData)
ForumThread
object to a webservice ForumThread
object
and allows forum name, unfilteredSubject, and unfilteredBody to be set to null to reduce response size.
thread
- thread object.reduceData
- set forum name, unfiltered subject and unfiltered body to null.
public static ForumMessage convert(ForumMessage message)
ForumMessage
object to a webservice ForumMessage
object.
message
- message object.
public static User convert(User user)
User
to a webservices User
.
user
- user to convert.
public static Group convert(Group group)
Group
to a webservices Group
object.
group
- Group to convert to a webservices object.
public static Watch convert(Watch watch)
Watch
to a webservices Watch
object.
watch
- Watch to convert to a webservices watch object.
public static ResultFilter convert(ResultFilter filter)
ResultFilter
object to a ResultFilter
.
filter
- Webservices ResultFilter to convert.
public static PrivateMessage convert(PrivateMessage privateMessage)
public static PrivateMessageFolder convert(PrivateMessageFolder privateMessageFolder)
public static Announcement convert(Announcement announcement)
public static AuthToken getAuthToken()
AuthToken
.
AuthToken
.public static ForumFactory getForumFactory()
AuthToken
from the current Thread.
public static java.util.Locale convert(Locale l)
l
- webservices locale object
public static Locale convert(java.util.Locale l)
l
- The java locale object
public static void setAuthToken(AuthToken token)
token
- auth token to set on a thread local variablepublic static void cleanup()
public static void setForumFactory(ForumFactory factory)
factory
- Test forum factory
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |