| java.lang.Object
 org.jivesoftware.openfire.plugin.BroadcastPlugin
| BroadcastPlugin | | public class BroadcastPlugin implements Plugin,Component,PropertyEventListener(Code) | | Broadcast service plugin. It accepts messages and broadcasts them out to
groups of connected users. The address all@[serviceName].[server] is
reserved for sending a broadcast message to all connected users. Otherwise,
broadcast messages can be sent to groups of users by using addresses
in the form [group]@[serviceName].[server].
author:
Matt Tucker |
| Constructor Summary | |
| public | BroadcastPlugin()
Constructs a new broadcast plugin. |
| BroadcastPlugin | | public BroadcastPlugin()(Code) | | Constructs a new broadcast plugin.
|
| destroyPlugin | | public void destroyPlugin()(Code) | | |
| getGlobalAllowedUsers | | public Collection<JID> getGlobalAllowedUsers()(Code) | | Returns a collection of the addresses of users allowed to send broadcast
messages. If no users are defined, anyone can send broadcast messages to
all users. Additional users may also be allowed to send broadcast messages
to specific groups depending on the group settings.
the users allowed to send broadcast messages. |
| getServiceName | | public String getServiceName()(Code) | | Returns the service name of this component, which is "broadcast" by default.
the service name of this component. |
| isGroupMembersAllowed | | public boolean isGroupMembersAllowed()(Code) | | Returns true if normal group members are allowed to send broadcast messages
to groups they belong to. Otherwise, only group administrators can send
broadcast messages to groups. Global allowed users can also send messages to
groups.
true if group members are allowed to broadcast messages; otherwise onlygroup admins are allowed. |
| isGroupPermissionsDisabled | | public boolean isGroupPermissionsDisabled()(Code) | | Returns true if all permission checking on sending messages to groups is disabled
(enabled by default). When disabled, any user in the system can send a message to
a group.
true if group permission checking is disabled. |
| propertyDeleted | | public void propertyDeleted(String property, Map params)(Code) | | |
| setGlobalAllowedUsers | | public void setGlobalAllowedUsers(Collection<String> allowedUsers)(Code) | | Sets the collection of addresses of users allowed to send broadcast
messages. If the collection is empty, anyone can send broadcast messages.
Additional users may also be allowed to send broadcast messages to
specific groups depending on the group settings.
Parameters:
allowedUsers - collection of users allowed to send broadcast messagesto all users. |
| setGroupMembersAllowed | | public void setGroupMembersAllowed(boolean allowed)(Code) | | Sets whether normal group members are allowed to send broadcast messages
to groups they belong to. Otherwise, only group administrators can send
broadcast messages to groups. Global allowed users can also send messages to
groups.
Parameters:
allowed - true if group members are allowed to broadcast messages; otherwise onlygroup admins are allowed. |
| setGroupPermissionsDisabled | | public void setGroupPermissionsDisabled(boolean disableGroupPermissions)(Code) | | Enables or disables permission checking when sending messages to a group. When
disabled, any user in the system can send a message to a group.
Parameters:
disableGroupPermissions - true if group permission checking should be disabled. |
| setServiceName | | public void setServiceName(String serviceName)(Code) | | Sets the service name of this component, which is "broadcast" by default.
Parameters:
serviceName - the service name of this component. |
| shutdown | | public void shutdown()(Code) | | |
| start | | public void start()(Code) | | |
| xmlPropertyDeleted | | public void xmlPropertyDeleted(String property, Map params)(Code) | | |
| xmlPropertySet | | public void xmlPropertySet(String property, Map params)(Code) | | |
|
|