org.jboss.ha.singleton
Interface HASingletonProfileActivatorMBean

All Known Implementing Classes:
HASingletonProfileActivator, HASingletonProfileManager

public interface HASingletonProfileActivatorMBean

StandardMBean interface for HASingletonProfileActivator.

Version:
$Revision: 85945 $
Author:
Brian Stansberry

Method Summary
 void activateProfile()
          Tells the ProfileService to activate the profile.
 String getProfileDomain()
          Gets the value that should be used for the domain portion of the singleton @{link Profile}'s ProfileKey.
 String getProfileName()
          Gets the value that should be used for the name portion of the singleton @{link Profile}'s ProfileKey.
 String getProfileServer()
          Gets the value that should be used for the server portion of the singleton @{link Profile}'s ProfileKey.
 boolean isActivated()
          Gets whether this object has activated its profile.
 void releaseProfile()
          Tells the ProfileService to release the profile.
 

Method Detail

getProfileDomain

String getProfileDomain()
Gets the value that should be used for the domain portion of the singleton @{link Profile}'s ProfileKey.

Returns:
the domain, or null if not set

getProfileServer

String getProfileServer()
Gets the value that should be used for the server portion of the singleton @{link Profile}'s ProfileKey.

Returns:
the server, or null if not set

getProfileName

String getProfileName()
Gets the value that should be used for the name portion of the singleton @{link Profile}'s ProfileKey.

Returns:
the name, or #DEFAULT_PROFILE_NAME if not set

isActivated

boolean isActivated()
Gets whether this object has activated its profile.

Returns:
true if activateProfile() has successfully completed and releaseProfile() has not been called; false otherwise.

activateProfile

void activateProfile()
                     throws Exception
Tells the ProfileService to activate the profile. Called by the HASingletonController when we become the singleton master.

Throws:
Exception

releaseProfile

void releaseProfile()
                    throws Exception
Tells the ProfileService to release the profile. Called by the HASingletonController when we are no longer the singleton master.

Throws:
Exception


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.