Methods
checkWriteAccess(nameOrJGroup)
checks for write access to a group according to app.properties
group.nameXX.writable must be true so that this function returns
Parameters:
Name | Type | Description |
---|---|---|
nameOrJGroup |
can be the name of a group or a java Group itself |
- Source:
Throws:
an error if group is not writable
connect()
try to connect a group
- Source:
Returns:
false if group is not found
count()
returns the total number of groupobjects in this group
- Source:
destroy()
try to destroy a group (if application may write in group).
all other instances of the group disconnect
- Source:
Returns:
false if group is not found
disconnect()
try to disconnect from a group
- Source:
Returns:
false if group is not found
get()
visible to scripting env: get a group, wrapped as a javascript helma.Group object.
the group must be defined in app.properties: group.nameXX =
and can then be accessed like this group.get("nameXX")
- Source:
Returns:
null if group is not defined or not connected
getConfig()
dumps the config of the jgroups stack to a string
- Source:
Returns:
string, false if group is not found
getConnection()
returns the connection identifier of the Group instance (localname + multicast-target)
- Source:
Returns:
string, false if group is not found
getContent()
dumps the keys of the group to a string
- Source:
Returns:
string, notice if group is not found
getFullConfig()
dumps the config of the jgroups stack including all properties to a string
- Source:
Returns:
string, false if group is not found
getFullContent()
dumps the keys and the content of the group to a string
- Source:
Returns:
string, notice if group is not found
isConnected()
returns true/false if the group is connected
- Source:
listMemberApps()
lists the members applications of this group (may be more than one per instance but also none)
- Source:
Returns:
array of strings, false if group is not found
listMembers()
list the members of this group (ie instances of Group, one helma server is one instance)
- Source:
Returns:
array of strings, false if group is not found
reconnect()
try to disconnect and connect again to a group
- Source:
Returns:
false if group is not found
reset()
try to reset a group (if application may write in group).
all instances of the group empty their cache.
- Source:
Returns:
false if group is not found
restart()
try to restart a group (if application may write in group).
all other instances of the group disconnect and reconnect - each app after a different pause
so that they don't all come up at the same moment
- Source:
Returns:
false if group is not found
size()
returns the total number of groupobjects in this group
- Source:
(inner) getJavaGroup()
get a java object Group for a groupname.
object is fetched regardless of connection status
- Source:
Returns:
null if group is not defined