com.bea.b2b.management.hub.runtime
Interface CSpaceMBean


public interface CSpaceMBean

The CSpaceMBean interface represents a collaboration space (c-space).

Author:
Copyright © 2000 BEA Systems, Inc. All Rights Reserved.

Method Summary
 void disable()
          Disables this c-space so that new conversations and participants can no longer join this c-space during normal WLC operations.
 void enable()
          Enables this c-space so that new conversations and participants can join this c-space during normal WLC operations.
 CollaboratorMBean[] getActiveCollaborators()
          Gets CollaboratorMBeans for all of the active trading partners in this c-space.
 GlobalConversationMBean[] getActiveConversations()
          Gets GlobalConversationMBeans for all of the active conversations in this c-space.
 HubMBean getHub()
          Gets the HubMBean of the c-hub to which this c-space belongs.
 java.lang.String getName()
          Gets the name of this c-space.
 int getState()
          Gets the state of the c-space (active or inactive).
 boolean isActive()
          Determines whether this c-space is active (true) or not (false).
 boolean isEnabled()
          Determines whether this c-space is enabled (true) or not (false).
 boolean isShutDown()
          Determines whether this c-space has been shut down or not.
 void shutDown(java.lang.Integer mode)
          Shuts down this c-space with the specified shutdown mode.
 

Method Detail

getName

public java.lang.String getName()
Gets the name of this c-space.

Returns:
String - C-space name.

getActiveCollaborators

public CollaboratorMBean[] getActiveCollaborators()
Gets CollaboratorMBeans for all of the active trading partners in this c-space.

Returns:
CollaboratorMBean[] - Array of CollaboratorMBeans for active trading partners.

getHub

public HubMBean getHub()
Gets the HubMBean of the c-hub to which this c-space belongs.

Returns:
HubMBean - C-hub MBean.

getState

public int getState()
Gets the state of the c-space (active or inactive).

Returns:
int - (1) if the CSpace is inactive, or (2) if the CSpace is active.

getActiveConversations

public GlobalConversationMBean[] getActiveConversations()
Gets GlobalConversationMBeans for all of the active conversations in this c-space.

Returns:
GlobalConversationMBean[] - Array of GlobalConversationMBeans for active conversations.

isActive

public boolean isActive()
Determines whether this c-space is active (true) or not (false).

Returns:
boolean true if the C-Space is active, or false if not.

shutDown

public void shutDown(java.lang.Integer mode)
              throws ManagementException
Shuts down this c-space with the specified shutdown mode.

Parameters:
mode - Mode for the shutdown. One of the following values:

ShutdownMode.KILL - Forces trading partners to leave this c-spaces. Rejects all new messages. Discards all messages in trading partner queues.

ShutdownMode.NOW (reserved for future use)

ShutdownMode.NORMAL (reserved for future use)

ShutdownMode.QUIESCE (reserved for future use)

Throws:
ManagementException - If an error occurred during shutdown.

isShutDown

public boolean isShutDown()
Determines whether this c-space has been shut down or not. Returns true only after the shutdown completes. A c-space shutdown does not persist across c-hub startups.

Returns:
boolean - True if this c-space has been shut down, or false if not.

enable

public void enable()
            throws ManagementException
Enables this c-space so that new conversations and participants can join this c-space during normal WLC operations. This state is persisted to the c-hub repository and survives restarts of the c-hub. Enabling an already enabled c-space has no effect.

Throws:
ManagementException - If an error occurred when enabling this c-sace.

disable

public void disable()
             throws ManagementException
Disables this c-space so that new conversations and participants can no longer join this c-space during normal WLC operations. This state is persisted to the c-hub repository and survives restarts of the c-hub. Disabling an already disabled c-space has no effect.

Throws:
ManagementException - If an error occurred when disabling this c-space.

isEnabled

public boolean isEnabled()
                  throws ManagementException
Determines whether this c-space is enabled (true) or not (false).

Returns:
boolean - True if this c-space is enabled, or false if not.
Throws:
ManagementException - If an error occurred while attempting to determine whether this c-space is enabled.