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

public interface EnablerSessionMBean

The EnablerSessionMBean interface represents a c-enabler session.

Author:

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

Method Summary

ConversationMBean[]	getActiveConversations() Gets ConversationMBeans for all of the active conversations in this c-enabler session.
java.util.Date	getActiveSince() Gets the start time for this c-enabler session.
java.lang.String	getCertificateFieldName() Gets the field name of the c-hub certificate.
java.lang.String	getCertificateFieldValue() Gets the field value of the c-hub certificate.
java.lang.String	getCertificateLocation() Gets the location of the certificate associated with this c-enabler session.
int	getConversationsInitiated() Gets the number of conversations initiated by this c-enabler session.
java.lang.String	getCSpaceName() Gets the name of the c-space associated with this c-enabler session.
EnablerMBean	getEnabler() Gets the MBean of the c-enabler associated with this c-enabler session.
java.lang.String	getEnablerUrl() Gets the URL of the c-enabler associated with this c-enabler session.
java.lang.String	getHubUrl() Gets the URL of the c-hub associated with this c-enabler session.
java.lang.String	getHubUser() Gets the user name of the c-hub's user.
java.lang.String	getName() Gets the name of this c-enabler session.
int	getNumMsgsPublished() Gets the number of messages published in this c-enabler session.
int	getNumMsgsReceived() Gets the number of messages received in this c-enabler session.
java.lang.String	getPrivateKeyLocation() Gets the location of the private key associated with this c-enabler session.
java.lang.String	getProxyHost() Gets the proxy host for the c-hub.
java.lang.String	getProxyPort() Gets the proxy port for the c-hub.
int	getRegisteredConversations() Gets the number of registered conversations for this c-enabler session.
java.lang.String	getServerCertificateFieldName() Gets the field name of the c-hub server certificate.
java.lang.String	getServerCertificateFieldValue() Gets the field value of the c-hub server certificate.
java.lang.String	getTradingPartnerName() Gets the trading partner name associated with this c-enabler session.
void	shutDown(boolean keepSubscription) Shuts down the c-enabler session and, optionally, leaves the c-space.

Method Detail

getActiveSince

public java.util.Date getActiveSince()

Gets the start time for this c-enabler session.

Returns:

Date - Time when this c-enabler session was started.

getNumMsgsPublished

public int getNumMsgsPublished()

Gets the number of messages published in this c-enabler session.

Returns:

int - Number of messages published.

getNumMsgsReceived

public int getNumMsgsReceived()

Gets the number of messages received in this c-enabler session.

Returns:

int - Number of messages received.

getName

public java.lang.String getName()

Gets the name of this c-enabler session.

Returns:

String - C-enabler session name.

getEnabler

public EnablerMBean getEnabler()

Gets the MBean of the c-enabler associated with this c-enabler session.

Returns:

EnablerMBean - C-enabler MBean.

getCSpaceName

public java.lang.String getCSpaceName()

Gets the name of the c-space associated with this c-enabler session.

Returns:

String - Name of the c-space.

getHubUrl

public java.lang.String getHubUrl()

Gets the URL of the c-hub associated with this c-enabler session.

Returns:

String - C-hub URL.

getEnablerUrl

public java.lang.String getEnablerUrl()

Gets the URL of the c-enabler associated with this c-enabler session.

Returns:

String - C-enabler URL.

getTradingPartnerName

public java.lang.String getTradingPartnerName()

Gets the trading partner name associated with this c-enabler session.

Returns:

String - Name of the trading partner for this c-enabler session, or null if no trading partner is defined.

getCertificateLocation

public java.lang.String getCertificateLocation()

Gets the location of the certificate associated with this c-enabler session.

Returns:

String - Location of the certificate, or null if no certificate is defined.

getPrivateKeyLocation

public java.lang.String getPrivateKeyLocation()

Gets the location of the private key associated with this c-enabler session.

Returns:

String - Location of the private key, or null if no private key is defined.

getCertificateFieldName

public java.lang.String getCertificateFieldName()

Gets the field name of the c-hub certificate.

Returns:

String - Certificate field name.

getCertificateFieldValue

public java.lang.String getCertificateFieldValue()

Gets the field value of the c-hub certificate.

Returns:

String - Certificate field value.

getServerCertificateFieldName

public java.lang.String getServerCertificateFieldName()

Gets the field name of the c-hub server certificate.

Returns:

String - Server certificate field name.

getServerCertificateFieldValue

public java.lang.String getServerCertificateFieldValue()

Gets the field value of the c-hub server certificate.

Returns:

String - Server certificate field value.

getProxyHost

public java.lang.String getProxyHost()

Gets the proxy host for the c-hub.

Returns:

String - Proxy host.

getProxyPort

public java.lang.String getProxyPort()

Gets the proxy port for the c-hub.

Returns:

String - Proxy port.

getHubUser

public java.lang.String getHubUser()

Gets the user name of the c-hub's user.

Returns:

String - C-hub user name.

getConversationsInitiated

public int getConversationsInitiated()

Gets the number of conversations initiated by this c-enabler session.

Returns:

int - Number of conversations initiated.

getRegisteredConversations

public int getRegisteredConversations()

Gets the number of registered conversations for this c-enabler session.

Returns:

int - Number of registered conversations.

getActiveConversations

public ConversationMBean[] getActiveConversations()

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

Returns:

ConversationMBean[] - Array of ConversationMBeans for active conversations.

shutDown

public void shutDown(boolean keepSubscription)
              throws ManagementException,
                     B2BException

Shuts down the c-enabler session and, optionally, leaves the c-space.

Parameters:

keepSubscription - - If true, keeps the subscription to conversations in which this c-enabler session 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 session. All of the relevant messages in the conversation started through this session are discarded and the collaborator leaves the c-space.

Throws:

ManagementException - If conversation shutdown fails.

B2BException - If an error occurred.