| java.lang.Object
 org.jivesoftware.openfire.plugin.PresencePlugin
| PresencePlugin | | public class PresencePlugin implements Plugin,Component(Code) | | Plugin that includes a servlet that provides information about users' and components'
presence in the server. For security reasons, the XMPP spec does not allow anyone to see
the presence of any user. Only the users that are subscribed to the presence of other
users may see their presences.
However, in order to make the servlet more useful it is possible to configure this plugin
so that anyone or only the users that are subscribed to a user presence may see the presence
of other users.
Currently, the servlet provides presence information in two formats: 1) In XML format
and 2) using images.
The presence plugin is also a component so that it can probe presences of other components.
The new component will use presence as the subdomain subdomain.
author:
Gaston Dombiak |
| destroyPlugin | | public void destroyPlugin()(Code) | | |
| getPresence | | public Presence getPresence(String sender, String jid) throws UserNotFoundException(Code) | | Returns the presence of the requested user or null if the user is offline. If
presences are not public then the user presence will be returned if and only if the sender
of the request is subscribed to the user presence.
Parameters:
sender - the bare JID of the user making the request.
Parameters:
jid - the bare JID of the entity whose presence is being probed. the presence of the requested user.
throws:
UserNotFoundException - If presences are not public and the sender is null or thesender cannot probe the presence of the requested user. Or if the requested userdoes not exist in the local server. |
| getUnavailableStatus | | public String getUnavailableStatus()(Code) | | Returns the status message for the unavailable presence. This setting allows
a different string to be used for the status on this presence which is
"Unavailable" by default.
the status message for the unavailable presence. |
| isPresencePublic | | public boolean isPresencePublic()(Code) | | Returns true if anyone is allowed to see the presence of other users. False means that
only the users that are subscribed to a user presence will be able to get information
about the user. By default, presence information is not publicly available.
true if anyone is allowed to see the presence of other users. |
| setPresencePublic | | public void setPresencePublic(boolean presencesPublic)(Code) | | Sets if anyone is allowed to see the presence of other users. A false value means that
only the users that are subscribed to a user presence will be able to get information
about the user. By default, presence information is not publicly available.
Parameters:
presencesPublic - if anyone is allowed to see the presence of other users. |
| setUnavailableStatus | | public void setUnavailableStatus(String statusMessage)(Code) | | Sets the status message for the unavailable presence. This setting allows
a different string to be used for the status on this presence which is
"Unavailable" by default.
Parameters:
statusMessage - the status message for the unavailable presence. |
| shutdown | | public void shutdown()(Code) | | |
| start | | public void start()(Code) | | |
|
|