com.bea.b2b.management.enabler.runtime
Interface EnablerMBean

public interface EnablerMBean

The EnablerMBean interface represents a c-enabler.

Author:

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

Method Summary

ConversationMBean[]	getActiveConversations() Gets ConversationMBeans for all of the active conversations for this c-enabler.
EnablerSessionMBean[]	getActiveSessions() Gets EnablerSessionMBeans for all of the active sessions in this c-enabler.
java.util.Date	getActiveSince() Gets the start time for this c-enabler.
java.lang.String	getName() Gets the name of this c-enabler.
int	getNumMsgsPublished() Gets the number of messages published by this c-enabler.
int	getNumMsgsReceived() Gets the number of messages received by this c-enabler.
int	getNumTotalConversations() Gets the total number of conversations in which this c-enabler participated since it started.
int	getNumTotalSessions() Gets the total number of sessions started by this c-enabler.
java.lang.String[]	getSessionNames() Gets the names of all of the sessions specified in the configuration file.
void	shutDown(boolean keepSubscription) Shuts down the c-enabler.
EnablerSessionMBean	startEnablerSession(java.lang.String sessionName) Gets or starts a c-enabler session for the specified session name.

Method Detail

getName

public java.lang.String getName()

Gets the name of this c-enabler.

Returns:

String - C-enabler name.

getActiveSince

public java.util.Date getActiveSince()

Gets the start time for this c-enabler.

Returns:

Date - Time when this c-enabler was started.

getNumMsgsPublished

public int getNumMsgsPublished()

Gets the number of messages published by this c-enabler.

Returns:

int - Number of messages published.

getNumMsgsReceived

public int getNumMsgsReceived()

Gets the number of messages received by this c-enabler.

Returns:

int - Number of messages received.

getNumTotalConversations

public int getNumTotalConversations()

Gets the total number of conversations in which this c-enabler participated since it started.

Returns:

int - Number of conversations.

getNumTotalSessions

public int getNumTotalSessions()

Gets the total number of sessions started by this c-enabler.

Returns:

int - Number of sessions.

getActiveSessions

public EnablerSessionMBean[] getActiveSessions()

Gets EnablerSessionMBeans for all of the active sessions in this c-enabler.

Returns:

EnablerSessionMBean[] - Array of EnablerSessionMBeans for active sessions.

getSessionNames

public java.lang.String[] getSessionNames()

Gets the names of all of the sessions specified in the configuration file.

Returns:

String[] - Session names.

startEnablerSession

public EnablerSessionMBean startEnablerSession(java.lang.String sessionName)
                                        throws ManagementException

Gets or starts a c-enabler session for the specified session name. This method creates a c-enabler session if one with the specified name does not already exist.

Parameters:

sessionName - Name of the session in the c-enabler configuration file.

Returns:

EnablerSession - C-enabler session.

Throws:

ManagementException - If an error occurred during c-enabler initialization.

getActiveConversations

public ConversationMBean[] getActiveConversations()

Gets ConversationMBeans for all of the active conversations for this c-enabler.

Returns:

ConversationMBean[] - Array of ConversationMBeans for active conversations.

shutDown

public void shutDown(boolean keepSubscription)
              throws ManagementException,
                     B2BException

Shuts down the c-enabler. All of the active sessions for this c-enabler are also shut down.

Parameters:

keepSubscription - - If true, keeps the subscription to conversations in which this c-enabler was participating. Pertinent messages are stored in message queues for later retrieval using deferred pull. The trading partner does not leave the c-space. - If false (the default), explictly shuts down the c-enabler. All of the relevant messages in the conversation started through this c-enabler are discarded and the trading partner leaves the c-space.

Throws:

ManagementException - If shutdown failed.

B2BException - If an error occurred.