com.sun.enterprise.ee.cms.impl.common

Interface GMSContext

All Known Implementing Classes:

GMSContextBase, GMSContextImpl

public interface GMSContext

Provides contextual information about all useful GMS artifacts. These are GMS objects that are tied to a particular group identity and thus scoped to provide information within the group's context. There can be as many GMSContext objects as there are groups within a single JVM process.

Version:

$Revision$

Author:

Shreedhar Ganapathy Date: Jan 12, 2004

Method Summary

Modifier and Type	Method and Description
boolean	addToSuspectList(String token)
void	announceGroupShutdown(String groupName, com.sun.enterprise.ee.cms.core.GMSConstants.shutdownState shutdownState)
void	announceGroupStartup(String groupName, com.sun.enterprise.ee.cms.core.GMSConstants.groupStartupState startupState, List<String> memberTokens)
void	assumeGroupLeadership() lets this instance become a group leader explicitly Typically this can be employed by an administrative member to become a group leader prior to shutting down a group of members simultaneously.
AliveAndReadyViewWindow	getAliveAndReadyViewWindow()
com.sun.enterprise.ee.cms.core.AliveAndReadyView	getCurrentAliveAndReadyView()
com.sun.enterprise.ee.cms.core.DistributedStateCache	getDistributedStateCache()
GMSMonitor	getGMSMonitor()
com.sun.enterprise.ee.cms.spi.GroupCommunicationProvider	getGroupCommunicationProvider()
com.sun.enterprise.ee.cms.core.GroupHandle	getGroupHandle() returns Group handle
String	getGroupName() returns the name of the group this context represents.
Map<String,com.sun.enterprise.ee.cms.core.RejoinSubevent>	getInstanceRejoins()
com.sun.enterprise.ee.cms.core.GroupManagementService.MemberType	getMemberType()
com.sun.enterprise.ee.cms.core.AliveAndReadyView	getPreviousAliveAndReadyView()
Router	getRouter() returns the router
String	getServerIdentityToken() returns the serverIdentityToken pertaining to the process that owns this GMS instance
ShutdownHelper	getShutdownHelper()
long	getStartTime()
List<String>	getSuspectList()
ViewWindow	getViewWindow()
boolean	isGroupBeingShutdown(String groupName)
boolean	isGroupStartup()
boolean	isGroupStartupComplete()
boolean	isShuttingDown()
boolean	isSuspected(String token)
boolean	isWatchdog()
void	join()
void	leave(com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType shutdownType)
void	removeFromSuspectList(String token)
void	setGroupStartup(boolean value)
void	setGroupStartupJoinMembers(Set<String> members)
boolean	setGroupStartupState(String member, com.sun.enterprise.ee.cms.spi.MemberStates state)

Method Detail

getServerIdentityToken

String getServerIdentityToken()

returns the serverIdentityToken pertaining to the process that owns this GMS instance

Returns:

java.lang.String

getGroupName

String getGroupName()

returns the name of the group this context represents.

Returns:

the name of the group.

getGroupHandle

com.sun.enterprise.ee.cms.core.GroupHandle getGroupHandle()

returns Group handle

Returns:

Group handle

getRouter

Router getRouter()

returns the router

Returns:

router

getViewWindow

ViewWindow getViewWindow()

getDistributedStateCache

com.sun.enterprise.ee.cms.core.DistributedStateCache getDistributedStateCache()

getGMSMonitor

GMSMonitor getGMSMonitor()

join

void join()
   throws com.sun.enterprise.ee.cms.core.GMSException

Throws:

com.sun.enterprise.ee.cms.core.GMSException

leave

void leave(com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType shutdownType)

isShuttingDown

boolean isShuttingDown()

getStartTime

long getStartTime()

announceGroupStartup

void announceGroupStartup(String groupName,
                          com.sun.enterprise.ee.cms.core.GMSConstants.groupStartupState startupState,
                          List<String> memberTokens)

announceGroupShutdown

void announceGroupShutdown(String groupName,
                           com.sun.enterprise.ee.cms.core.GMSConstants.shutdownState shutdownState)

addToSuspectList

boolean addToSuspectList(String token)

removeFromSuspectList

void removeFromSuspectList(String token)

isSuspected

boolean isSuspected(String token)

getSuspectList

List<String> getSuspectList()

getShutdownHelper

ShutdownHelper getShutdownHelper()

getGroupCommunicationProvider

com.sun.enterprise.ee.cms.spi.GroupCommunicationProvider getGroupCommunicationProvider()

assumeGroupLeadership

void assumeGroupLeadership()

lets this instance become a group leader explicitly Typically this can be employed by an administrative member to become a group leader prior to shutting down a group of members simultaneously. For underlying Group Communication Providers who don't support the feature of a explicit leader role assumption, the implementation of this method would be a no-op.

isGroupBeingShutdown

boolean isGroupBeingShutdown(String groupName)

isGroupStartup

boolean isGroupStartup()

setGroupStartup

void setGroupStartup(boolean value)

getMemberType

com.sun.enterprise.ee.cms.core.GroupManagementService.MemberType getMemberType()

isWatchdog

boolean isWatchdog()

getPreviousAliveAndReadyView

com.sun.enterprise.ee.cms.core.AliveAndReadyView getPreviousAliveAndReadyView()

getCurrentAliveAndReadyView

com.sun.enterprise.ee.cms.core.AliveAndReadyView getCurrentAliveAndReadyView()

getInstanceRejoins

Map<String,com.sun.enterprise.ee.cms.core.RejoinSubevent> getInstanceRejoins()

getAliveAndReadyViewWindow

AliveAndReadyViewWindow getAliveAndReadyViewWindow()

setGroupStartupJoinMembers

void setGroupStartupJoinMembers(Set<String> members)

isGroupStartupComplete

boolean isGroupStartupComplete()

setGroupStartupState

boolean setGroupStartupState(String member,
                             com.sun.enterprise.ee.cms.spi.MemberStates state)