|
GemFire 6.6 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gemstone.gemfire.cache.RequiredRoles
public class RequiredRoles
Provides information on presence or absence of a Region
's
required roles. Configuration of required roles is accomplished using the
Region
's MembershipAttributes
.
A Role
may be present in the
distributed system even if it the Role
is not present in the
Region
membership. This would occur if none of the members
filling that Role
currently have a Cache
or the
specific Region
created. In this case the Role
is
considered to be absent for that Region
.
Role
Constructor Summary | |
---|---|
RequiredRoles()
|
Method Summary | |
---|---|
static Set<Role> |
checkForRequiredRoles(Region<?,?> region)
Returns a set of any currently missing required roles for the specified region. |
static boolean |
isRoleInRegionMembership(Region<?,?> region,
Role role)
Returns true if the Role
is currently present in the Region membership. |
static Set<Role> |
waitForRequiredRoles(Region<?,?> region,
long timeout)
Returns a set of any currently missing required roles for the specified region. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RequiredRoles()
Method Detail |
---|
public static Set<Role> checkForRequiredRoles(Region<?,?> region)
region
- the region to check for missing required roles
IllegalStateException
- if region is not configured with required rolespublic static Set<Role> waitForRequiredRoles(Region<?,?> region, long timeout) throws InterruptedException
region
- the region to check for missing required rolestimeout
- milliseconds to wait for any missing required roles
NullPointerException
- if region is null
InterruptedException
- if thread is interrupted while waiting
IllegalStateException
- if region is not configured with required rolespublic static boolean isRoleInRegionMembership(Region<?,?> region, Role role)
Role
is currently present in the Region
membership. This returns true
only if one or more members filling this role actually have the region
currently created. The role may be present in the distributed system even
if the role is not present in the region membership.
region
- the region whose membership will be searchedrole
- the role to check for
|
GemFire 6.6 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |