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


public interface CollaboratorMBean

The CollaboratorMBean interface represents a collaborator - a trading partner who has joined a c-space.

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

Method Summary
 void disable()
          Disables this trading partner in the c-space.
 GlobalConversationMBean[] getActiveConversations()
          Gets GlobalConversationMBeans for all of the global conversations in which this trading partner is participating in the c-space.
 MessageMBean[] getAllMessages()
          Gets MessageMBeans for all of the outstanding business messages that this trading partner has sent in the c-space.
 CSpaceMBean getCSpace()
          Gets the CSpaceMBean for the c-space that this trading partner has joined.
 int getDroppedMessageCount()
          Gets the number of dropped business messages.
 java.util.Date getFirstFailedMessageTimeStamp()
          Gets the timestamp of the first failed business message.
 java.util.Date getLastFailedMessageTimeStamp()
          Gets the timestamp of the last failed business message.
 java.util.Date getLastSentMessageTimeStamp()
          Gets the timestamp of the last successfully sent business message.
 int getSentMessageCount()
          Gets the number of business messages that this trading partner has sent in the c-space.
 int getStatus()
          Gets the status of this trading partner in the c-space (enabled or disabled).
 java.lang.String getTradingPartnerName()
          Gets the name of this trading partner.
 java.util.Date lastSentInConversation(java.lang.String conversationId)
          Gets the time of the last business message that this trading partner sent in the specified conversation.
 void leaveCSpace(boolean keepSubscription)
          Removes this trading partner from the c-space.
 

Method Detail

getCSpace

public CSpaceMBean getCSpace()
Gets the CSpaceMBean for the c-space that this trading partner has joined.

Returns:
CSpaceMBean - C-space Mbean.

getTradingPartnerName

public java.lang.String getTradingPartnerName()
Gets the name of this trading partner.

Returns:
String - Trading partner name.

getActiveConversations

public GlobalConversationMBean[] getActiveConversations()
Gets GlobalConversationMBeans for all of the global conversations in which this trading partner is participating in the c-space.

Returns:
GlobalConversationMBean[] - Array of GlobalConversationMBeans.

lastSentInConversation

public java.util.Date lastSentInConversation(java.lang.String conversationId)
Gets the time of the last business message that this trading partner sent in the specified conversation.

Parameters:
conversationId - Conversation ID.
Returns:
Date - Time of the last business message sent.

leaveCSpace

public void leaveCSpace(boolean keepSubscription)
                 throws ManagementException
Removes this trading partner from the c-space.

Parameters:
keepSubscription - - If true, leave business message queues intact and continues receiving messages in the queues while away from the conversation. Note: This option is not supported in this release. - If false, discards business messages while away from the conversation.
Throws:
ManagementException - If an error occurred when leaving the c-space.

disable

public void disable()
             throws ManagementException
Disables this trading partner in the c-space.

getStatus

public int getStatus()
              throws B2BException
Gets the status of this trading partner in the c-space (enabled or disabled).

Returns:
int - ENABLED or DISABLED.

getAllMessages

public MessageMBean[] getAllMessages()
Gets MessageMBeans for all of the outstanding business messages that this trading partner has sent in the c-space.

Returns:
MessageMBean[] - Array of MessageMBeans.

getLastSentMessageTimeStamp

public java.util.Date getLastSentMessageTimeStamp()
Gets the timestamp of the last successfully sent business message.

Returns:
java.util.Date - Timestamp of the last successful message.

getFirstFailedMessageTimeStamp

public java.util.Date getFirstFailedMessageTimeStamp()
Gets the timestamp of the first failed business message.

Returns:
java.util.Date - Timestamp of the first failed business message

getLastFailedMessageTimeStamp

public java.util.Date getLastFailedMessageTimeStamp()
Gets the timestamp of the last failed business message.

Returns:
java.util.Date - Timestamp of the last failed business message.

getSentMessageCount

public int getSentMessageCount()
Gets the number of business messages that this trading partner has sent in the c-space.

Returns:
int - Number of sent business messages.

getDroppedMessageCount

public int getDroppedMessageCount()
Gets the number of dropped business messages.

Returns:
int - Number of dropped business messages.