|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV NEXT | FRAMES NO FRAMES |
StringUtils.chop(String, int)
and then adds an ellipsis if the input is greater than the maxWidth.
PollableRunnable
interface.EmailToken
to the set.
ChatSession
associated with a 1-to-1 converstation.
GroupChatSession
identified by the room name.
Address
to a String.
ContentTag
to the list of tags to filter on.
Permissions.SYSTEM_ADMIN
access to any wrapped
action.QueryCacheKey.getIDKey()
.
null
The result of
this method is determined as follows:
If b1
and b2
are both TRUE or
neither b1
nor b2
is TRUE,
return false
.
null
The result of
this method is determined as follows:
If b1
and b2
are both TRUE or
neither b1
nor b2
is TRUE,
return true
.
null
.
null
The result of
this method is determined as follows:
If o1
and o2
are the same object
according to the ==
operator, return
true
.
AuthTokenAware
and UserAware
interfaces.InputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Base64#InputStream
will read data from another
InputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Base64#InputStream
in DECODE mode.
Base64#InputStream
in
either ENCODE or DECODE mode.
OutputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Base64#OutputStream
will write data to another
OutputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Base64#OutputStream
in ENCODE mode.
Base64#OutputStream
in
either ENCODE or DECODE mode.
EmailAction
using the properties which have been set before calling
this method.
QueryCacheKey.getIDKey()
method returned the same idkey as that
stored in this filter instance.ServiceLocator
you can cast a service to this interface to enable/modify
caching settings.URL
.
URL
, if one is available.
Message
is one which the system can do something useful with.
URL
.
User
has entered user id information
for the IM Service this instance represents and if forums is configured
to publish presence for the IM service this instance represents.
URL
.
CategoryListener
interface.
CategoryListener
interface.
CategoryListener
interface.
CategoryListener
interface.
EmailBatch
representing new messages.
InboundMessage
objects representing new messages.
InboundMessage
objects representing new messages.
EmailMonitor
to check an email account.GroupChatSession
XMPPConnection
held by forums to publish server status (configured chat
rooms, current occupancy, etc.)
HttpServletResponse
which will optionally compress
data written to the response.OutputStream
.Forum
object to a webservice Forum
object.
ForumCategory
object to a webservice ForumCategory
object.
ForumThread
object to a webservice ForumThread
object.
ForumThread
object to a webservice ForumThread
object
and allows forum name, unfilteredSubject, and unfilteredBody to be set to null to reduce response size.
ForumMessage
object to a webservice ForumMessage
object.
User
to a webservices User
.
Group
to a webservices Group
object.
Watch
to a webservices Watch
object.
ResultFilter
object to a ResultFilter
.
Attachment
it is associated with.
src
to dst
.
JiveContentObject
s.
CronTimer
.Date
parameter relative to the current time.
EmailTokenManager
which associates random numbers with user ids
and stores them in the database.EmailIntegrationProvider
which can respond to watch notification email replies.ForumCategory.deleteForum(Forum)
method should now be used
instead of this method.
RSSActionSupport.execute()
method - indicates that RSS feeds are disabled.
JivePropertyEvent
to all of the JivePropertyListener
listeners
that are registered with this event dispatcher.
Action.INPUT
always.
Action.INPUT
always.
Action.INPUT
.
Action.INPUT
always.
ProfileFieldOption
objects for a profile field.
EmailAction
instances.EmailManager
Message
object in order to provide data used by the system to execute actions
based on incoming email.EmailParser
which relies on the presence of a
special token in the email subject which contains data used for user authentication an message routing when reading
replies to watch notification email replies.EmailTokenManager
to read incoming mail tokens.
List
of email addresses contained in the supplied string.
EmailToken
s are used by the EmailTokenManager
to represent the temporary
token ids associated with user watch notification emails.EmailTokenSet
s are used by the EmailTokenManager
to hold the EmailToken
s
associated with a specific user.AdminPageBean
instance from the request.
AdminPageBean
instance from the request.
Action.SUCCESS
always.
Action.SUCCESS
view, or
the Action.ERROR
view if the page user wasn't logged in
(double logout perhaps?)
Action.SUCCESS
if the announcement was deleted successfully or
ForumActionSupport.UNAUTHORIZED
if the user can not delete the announcement.
Action.SUCCESS
if the announcement was expired successfully or
ForumActionSupport.UNAUTHORIZED
if the user can not expired the announcement.
Action.SUCCESS
, or
JiveActionSupport.UNAUTHORIZED
if the user isn't authorized to change the password.
Action.SUCCESS
always.
Action.SUCCESS
always.
Action.LOGIN
if the user is not logged in, Action.ERROR
if the user has already
voted on the poll and ForumActionSupport.UNAUTHORIZED
if the user has no permission to the poll.
Action.SUCCESS
.
RenderTarget.TARGET_HTML
.
RenderTarget.TARGET_NO_MARKUP
.
RenderTarget.TARGET_PLAIN_EMAIL
.
RenderTarget.TARGET_PLAIN_TEXT
.
Action.SUCCESS
by default.
RenderTarget.TARGET_WYSIWYG_EDITOR
.
true
if the specified URL
points to a
resource that currently exists; returns false
otherwise.
SimpleDateFormat
, but faster and thread-safe.ForumMessageNotFoundException
AttachmentException
ForumCategoryNotFoundException
ForumNotFoundException
GroupNotFoundException
JiveRuntimeException
ForumMessageNotFoundException
MessageRejectedException
NameAlreadyExistsException
ForumThreadNotFoundException
UnauthorizedException
UserNotFoundException
FlashInterceptor
.Flash
to implement a flash scope.TimeFormat.MEDIUM
.
DateFormat
pattern for the specified Locale
Date
object and returns a formatted String.
Date
object to return a date and time using the global locale.
ForumListener
interface.
Forum
ForumFactory
ForumListener
interface.
ForumMessage
ForumListener
interface.
ForumListener
interface.
AdminAuthInterceptor
which can return a UserManager
for use by
actions in the admin console.ForumThread
EmailActionBuilder
which can build EmailAction
instances for any email message where
calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message)
return true.
EmailAction
which represents the response to the supplied InboundMessage
.
PollPostAction.ACTIVE_NOW
or PollPostAction.ACTIVE_LATER
.
AddressBookService
AttachmentManagerService
Iterator
of AttachmentData
.
AuthToken
.
AdminPageBean
instance.
Date
StatusLevelManager
that delegate to a StatusLevelCalculator
ForumCategory
for which this instance holds open email alert settings.
Iterator
of RoomInfo
instances
describing the current chat room activity on the XMPP server.
ChatSession
associated with a 1-to-1 chat.
ForumsChatSettings
instance.
parent
at index index
.
parentKey
at index index
.
parent
.
parentKey
.
Collection
of String objects.
ResultFilter
.
ContentService
.
CronTimer
instance used to schedule this task.
SearchManager.isBusy()
returns true).
ProfileSearchManager.isBusy()
returns true).
AdminCacheInfo.SMALL_PRESET
, AdminCacheInfo.MEDIUM_PRESET
,
AdminCacheInfo.LARGE_PRESET
, or AdminCacheInfo.CUSTOM_PRESET
.
InputStream
for the binary contents of the
attachment.
Types
that Date information is stored in.
IPInterceptor.getEmailBody(java.util.Locale)
KeywordInterceptor.getEmailBody(java.util.Locale)
UserInterceptor.getEmailBodyTemplate(java.util.Locale)
List
containine all the email addresses that
will be notified of an open question.
GatewayInterceptor.isStoreEmailAsProp()
is
true.
IPInterceptor.getEmailSubject(java.util.Locale)
KeywordInterceptor.getEmailSubject(java.util.Locale)
UserInterceptor.getEmailSubject(java.util.Locale)
locales
for the given template name.
RSSAnnouncements.DEFAULT_DATE_FORMAT
.
PollPostAction.ENDS_NEVER
, PollPostAction.ENDS_RELATIVE
or PollPostAction.ENDS_LATER
.
PollPostAction.EXPIRES_NEVER
, PollPostAction.EXPIRES_RELATIVE
or PollPostAction.EXPIRES_LATER
.
GatewayExporter
object associated with this Gateway
instance.
CompressingStreamFactory
instance associated to the given content encoding.
URL
, not
including any protocol, hostname authentication, directory path,
anchor, or query.
TagFilter
interface.
Forum
for which this instance holds open email alert settings.
Forum
by its id.
Forum
by its ID.
ForumCategory
by its id.
ForumCategory
by its id
ForumCategoryService
.
AuthToken
from the current Thread.
ForumMessage
by its id.
ForumMessage
by its ID.
ForumMessageService
.
Forum
or ForumCategory
(whichever is non null) for
which this instance holds open email alert settings.
ForumService
.
ForumThread
by its id.
ForumThread
by its ID.
ForumThreadService
.
Group
by its ID.
Group
by its name.
MultiUserChat
associated with this session.
GroupChatSession
associated with the room.
GroupService
Iterator
of strings.
GatewayImporter
object associated with this Gateway
instance.
child
in parent
or
-1 if child
is not a child of parent
.
childKey
in parentKey
or
-1 if childKey
is not a child of parentKey
.
BanManager
interface.
ThemeManager
interface.
Avatar
interface.
BanManager
interface.
StatusLevel
interface.
ChatManager
,
creating it if necessary.
ChatSettingsManager
,
creating it if necessary.
IntrospectiveUser
.
IntrospectiveUser
.
QueryCacheKey
s with the corresponding id key.
URL
points to.
Locale
used by Jive.
locales
where this property is set.
locales
where this property is set.
Question.State.open
open before triggering an alert.
Message
has a mimetype matching the pattern multipart/*, all parts will be looped
through in search of attachment data.
SearchAction.getHighlightedText(QueryResult)
instead
Part
and returns its body text.
ResultFilter
ResultFilter
SearchAction.getHighlightedText(QueryResult)
instead
JiveContentObject
s that a tag must be associated with to be
included in the result set.
URL
, not
including any protocol, hostname authentication, directory path,
anchor, or query.
GatewayInterceptor.isStoreNameAsProp()
is
true.
CronTimer
will
fire, after the given time.
JiveConstants.FORUM
).
JiveConstants
specifiying what type
of object to act on.
ProfileFieldOption
objects for this profile field.
child
, or null if there is no parent.
child
ForumMessage.
child
ForumMessage.
childKey
, or -1 if there is no parent.
EmailParser
initilized with the supplied InboundMessage
.
URL
.
URL
without the last file
extension.
SearchManager.isBusy()
returns
true).
ProfileSearchManager.isBusy()
returns true).
PermissionService
URL
; the returned string should be considered acceptable
for users to read.
PluginManager
that can be used for acquiring
plugin instances.
PluginMonitor
instance.
PrivateMessageService
ProfileFieldManager
interface.
ProfileManager
interface.
ProfileSearchManager
interface.
ProfileService
Collection
of String values.
QueryCacheStrategyFactory
defining a type of
QueryCacheStrategy
to use, or -1 if no strategy is needed.
Iterator
of recent messages
Iterator
of recent questions asked.
ResourceBundle.getBundle(String,Locale)
instead.
Forum
s which were searched by the query, even if no forumID was specified.
RSSAnnouncements.DEFAULT_DATE_FORMAT
.
URL
, then
all of the text starting at the last dot is returned, including
the dot.
SystemPropertiesService
Map
where the key is the
name of tag and the value is the number of times the tag has been used in this forum.
Map
where the key is the
name of tag and the value is the number of times the tag has been used in this forum
filtered by the TagResultFilter.
Map
where the key is the
name of tag and the value is the number of times the tag has been used in this community.
Map
where the key is the
name of tag and the value is the number of times the tag has been used in this community
filtered by the TagResultFilter.
ContentTag
s to filter on.
TimeZone
used by Jive.
cronExpression
of this CronTimer
will be resolved.
EmailTokenManager
instance for reading and creating message tokens.
Pattern
which matches tokens created by this token manager.
Pattern
which can be used to detect the presence of email tokens.
Pattern
which matches any email token generated
by this EmailTokenManager instance.
SearchManager.isBusy()
returns true).
ProfileSearchManager.isBusy()
returns true).
ProfileField.Type
of this profile field.
ProfileField.Type
of this profile field.
MUCUser
by their nickname.
UserManager
using the supplied AuthToken
.
WatchService
GraphicsUtils
class defines common image/graphical related utility functions.true
if the specified String
is not
null
and has a length greater than zero.
true
if the specified array is not null
and contains a non-null element.
child
message has a parent message.
child
message has a parent message.
true
if the specified String
is not
null
and has a length greater than zero when string has
been trimmed.
HTTPPageViewsReport
class.QueryCacheKey.getIDKey()
.Attachment
).InboundMessage
for IMAP protocol.ConditionalInterceptor.BEFORE
.
ForumsChatSettings
.
ActionInvocation.invoke()
based on the type - it will be called either before or after
the main logic of this interceptor is called.
JiveObjectLoader.loadObjects()
if the action implements the
JiveObjectLoader
interface.
ForumActionSupport.UNAUTHORIZED
if action execution results in an unauthorized
exception.
true
if the specified String
is not
null
and is true
URL
is valid.
Iterator
of all EmailToken
s in the set, sorted by timestamp.
ActionContextCleanUp
which can be called recursively without prematurely
cleaning up the action context.JiveCompressionFilter
environment, including
configuration and runtime statistics.JiveCompressionFilter
.PellMultiPartRequest
class.JiveObjectLoader
interface.Map
interface to add support for getting child property
names or a Collection
of all property names.Thread
and (@link Message} objects.
Message
data.DiskFileItem
class which allows for monitoring of the upload
as it progresses.DiskFileItemFactory
this class creates MonitoredDiskFileItem
to allow for monitoring of file uploads.OutputStreamListener
.MultiIterator
class which assumes that items in the iterators
are DbForumMessages.TextFilter
which handles newline to br conversions.PostAction.isNewMessageModerated
variable.
NewMessagesReport
class.null
as its detail message.
URL
whose parts have the exact values that
are specified.
>= desiredCapacity
and
very close to desiredCapacity
(within 11% if
desiredCapacity >= 1000
).
null
as its detail message.
NNTPPageViewsReport
class.Fragmenter
implementation which does not fragment the text.null
if the specified string is empty or
null
.
null
if the specified object is null
or if its toString()
representation is empty.
OpenQuestionMonitor
in determining when and how to send email alerts.Message
and uses it to populate all the properties
exposed by this object.
Message
and uses it to populate all the properties
exposed by this object.
EmailParser.parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.
EmailParserImpl.parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.
Date
Runnable
class which adds the ability for a runnable
to be monitored much like a progress meter.InboundMessage
for POP3 protocol.ProductCheck
.QueryCache
to retrieve query data.Base64.InputStream.read()
repeatedly until the end of stream
is reached or len bytes are read.
Base64.InputStream.read()
repeatedly until the end of stream
is reached or len bytes are read.
RegistrationManager
EmailToken
from the set.
ChatSession
associated with the participant.
GroupChatSession
associated with the room.
RenderStrategy
and RenderTarget
specified by the given render context.
Runnable.run()
method which sets this
task's running status to true then calls the abstract method AbstractPollableRunnable.doRun()
.
EmailMonitorException
and property string.
IMService
instance for the supplied service name.
HttpServletRequest
and HttpServletResponse
.PollPostAction.ACTIVE_NOW
or PollPostAction.ACTIVE_LATER
.
AuthToken
of the user to act as.
AdminPageBean
instance.
AdminPageBean
instance.
CronClusterUpdateTask
class.
IPInterceptor.setEmailBody(String, java.util.Locale)
KeywordInterceptor.setEmailBody(String, java.util.Locale)
UserInterceptor.setEmailBodyTemplate(String, java.util.Locale)
GatewayInterceptor.isStoreEmailAsProp()
is
true.
IPInterceptor.setEmailSubject(String, java.util.Locale)
KeywordInterceptor.setEmailSubject(String, java.util.Locale)
UserInterceptor.setEmailSubject(String, java.util.Locale)
RSSAnnouncements.DEFAULT_DATE_FORMAT
.
PollPostAction.ENDS_NEVER
, PollPostAction.ENDS_RELATIVE
or PollPostAction.ENDS_LATER
.
PollPostAction.EXPIRES_NEVER
, PollPostAction.EXPIRES_RELATIVE
or PollPostAction.EXPIRES_LATER
.
Forum
ForumFactory
jiveHome
directory.
Question.State.open
open before triggering an alert.
ForumMessage
Iterator
of attachments found in the incoming message.
JiveContentObject
s that a tag must be associated with to be
included in the result set.
GatewayInterceptor.isStoreNameAsProp()
is
true.
ProfileFieldOption
objects for this profile field.
ForumsChatSettings
for this installation.
RSSAnnouncements.DEFAULT_DATE_FORMAT
.
ContentTag
s to filter on.
ForumThread
cronExpression
of this CronTimer
will be resolved.
ProfileField.Type
of this profile field.
XMPPConnection
for this session.
StatusLevel
class.StatusLevelManager
StatusLevelManager
when attempting to acquire or perform an operation on
a status level that does not exist.TagQueryCacheObject
's.ThemeManager
.ThreadListener
interface.
ThreadListener
interface.
ThreadListener
interface.
ThreadListener
interface.
ThreadListener
interface.
ThreadTTLReport
class.TopForumsReport
class.setSubject(String)
or
setBody(String)
.
UniqueHTTPVisitorsReport
class.UniqueNNTPVisitorsReport
class.ForumMessage
UploadInfo
object in the session (using the attribute key 'uploadInfo') with the current state of the upload.URLFileSystem
class handles some of the most common
functionallity when working with URLs.UserCreationReport
class.UserManager
ProfileField
.WebUtils
class is a utility class for some of the most
mundane procedures in the WebChat client and in servlet programming.Base64.OutputStream.write(int)
repeatedly until len
bytes are written.
Base64.OutputStream.write(int)
repeatedly until len
bytes are written.
|
Jive Forums Project Page | |||||||||
PREV NEXT | FRAMES NO FRAMES |