EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.sessions.coordination.broadcast.BroadcastRemoteConnection

Modifier and Type	Field and Description
protected String	displayString
protected Object[]	info
protected Object[]	infoExt
protected RemoteCommandManager	rcm
protected String	state
public static final String	STATE_ACTIVE
public static final String	STATE_CLOSED
public static final String	STATE_CLOSING
protected String	topicName

Access	Constructor and Description
protected	BroadcastRemoteConnection(RemoteCommandManager rcm)

Method Summary

Modifier and Type	Method and Description
protected boolean	areAllResourcesFreedOnClose() INTERNAL: Indicates whether all the resources used by connection are freed after close method returns.
public void	close() Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.close. INTERNAL: This method is called when connection in no longer used and it's resources should be freed.
protected abstract void	closeInternal() INTERNAL: This method is called by close method.
protected void	createDisplayString() INTERNAL:
public Object	executeCommand(Command command) Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand. INTERNAL: Publish the remote command.
public Object	executeCommand(byte[] command) Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand. INTERNAL: Publish the remote command.
protected abstract Object	executeCommandInternal(Object command) INTERNAL: Publish the remote command.
protected void	failDeserializeMessage(String messageId, Exception exception) INTERNAL: Call this message in case there is failure to extract the object (to be passed to processReceivedObject) from the message.
protected Object[]	getInfo() INTERNAL:
protected Object[]	getInfoExt() INTERNAL:
public String	getState() INTERNAL: State of the connection.
public String	getTopicName() INTERNAL:
public boolean	isActive() INTERNAL: Connection is open for business.
public boolean	isClosed() INTERNAL: Connection is closed - all resources were freed.
public boolean	isClosing() INTERNAL: close method has been called.
protected void	logDebugAfterPublish(Object[] debugInfo, String messageId) INTERNAL: Called from executeCommandInternal to log debugInfo right after sending the message.
protected Object[]	logDebugBeforePublish(String messageId) INTERNAL: Called from executeCommandInternal to log debugInfo right before sending the message.
protected void	logDebugOnReceiveMessage(String messageId) INTERNAL: Called when a message is received to log debugInfo: { toString(), messageId }.
protected void	processReceivedObject(Object object, String messageId) INTERNAL: Process the object extracted from the received message.
protected boolean	Returns: boolean shouldCheckServiceId() INTERNAL: Return whether a BroadcastConnection should check a ServiceId against its own ServiceId to avoid the processing of Commands with the same ServiceId.
public String	toString() Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.toString. INTERNAL:

Inherited from org.eclipse.persistence.internal.sessions.coordination.RemoteConnection:: getServiceId setServiceId

displayString	back to summary
protected String displayString

info	back to summary
protected Object[] info

infoExt	back to summary
protected Object[] infoExt

rcm	back to summary
protected RemoteCommandManager rcm

state	back to summary
protected String state

STATE_ACTIVE	back to summary
public static final String STATE_ACTIVE

STATE_CLOSED	back to summary
public static final String STATE_CLOSED

STATE_CLOSING	back to summary
public static final String STATE_CLOSING

topicName	back to summary
protected String topicName

BroadcastRemoteConnection	back to summary
protected BroadcastRemoteConnection(RemoteCommandManager rcm)

Method Detail

areAllResourcesFreedOnClose	back to summary
protected boolean areAllResourcesFreedOnClose() INTERNAL: Indicates whether all the resources used by connection are freed after close method returns. Usually that's the case. However in case of local (listening) JMSTopicRemoteConnection close merely indicates to the listening thread that it should free TopicConnection and exit. Note that it may take a while: the listening thread waits until subscriber.receive method either returns a message or throws an exception.

areAllResourcesFreedOnClose

back to summary

protected boolean areAllResourcesFreedOnClose()

INTERNAL: Indicates whether all the resources used by connection are freed after close method returns. Usually that's the case. However in case of local (listening) JMSTopicRemoteConnection close merely indicates to the listening thread that it should free TopicConnection and exit. Note that it may take a while: the listening thread waits until subscriber.receive method either returns a message or throws an exception.

close	back to summary
public void close() Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.close. INTERNAL: This method is called when connection in no longer used and it's resources should be freed. As soon as this method is called the state is CLOSING. Usually the state is CLOSED just before the method returns, but there are some special cases (see comment to areAllResourcesFreedOnClose method) when the state is still CLOSING after the method returns. Annotations @Override

back to summary

public void close()

Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.close.

INTERNAL: This method is called when connection in no longer used and it's resources should be freed. As soon as this method is called the state is CLOSING. Usually the state is CLOSED just before the method returns, but there are some special cases (see comment to areAllResourcesFreedOnClose method) when the state is still CLOSING after the method returns.

Annotations

@Override

closeInternal	back to summary
protected abstract void closeInternal() throws Exception INTERNAL: This method is called by close method. This method usually (but not always see comment to areAllResourcesFreedOnClose method) frees all the resources.

createDisplayString	back to summary
protected void createDisplayString() INTERNAL:

executeCommand	back to summary
public Object executeCommand(Command command) throws CommunicationException Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand. INTERNAL: Publish the remote command. The result of execution is returned. This method is used only by external (publishing) connection. Annotations @Override

executeCommand

back to summary

public Object executeCommand(Command command) throws CommunicationException

Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand.

INTERNAL: Publish the remote command. The result of execution is returned. This method is used only by external (publishing) connection.

Annotations

@Override

executeCommand	back to summary
public Object executeCommand(byte[] command) throws CommunicationException Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand. INTERNAL: Publish the remote command. The result of execution is returned. This method is used only by external (publishing) connection. Annotations @Override

executeCommand

back to summary

public Object executeCommand(byte[] command) throws CommunicationException

Implements abstract org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.executeCommand.

INTERNAL: Publish the remote command. The result of execution is returned. This method is used only by external (publishing) connection.

Annotations

@Override

executeCommandInternal	back to summary
protected abstract Object executeCommandInternal(Object command) throws Exception INTERNAL: Publish the remote command. The result of execution is returned. This method is used only by external (publishing) connection.

failDeserializeMessage	back to summary
protected void failDeserializeMessage(String messageId, Exception exception) INTERNAL: Call this message in case there is failure to extract the object (to be passed to processReceivedObject) from the message. Pass to this method debugInfo created by logDebugOnReceiveMessage method. This method is used by local (listening) connection only.

getInfo	back to summary
protected Object[] getInfo() INTERNAL:

getInfoExt	back to summary
protected Object[] getInfoExt() INTERNAL:

getState	back to summary
public String getState() INTERNAL: State of the connection.

getTopicName	back to summary
public String getTopicName() INTERNAL:

isActive	back to summary
public boolean isActive() INTERNAL: Connection is open for business.

isClosed	back to summary
public boolean isClosed() INTERNAL: Connection is closed - all resources were freed.

isClosing	back to summary
public boolean isClosing() INTERNAL: close method has been called.

logDebugAfterPublish	back to summary
protected void logDebugAfterPublish(Object[] debugInfo, String messageId) INTERNAL: Called from executeCommandInternal to log debugInfo right after sending the message. Only call this method in case logDebugBeforePublish returned non-null this is indication that debug logging is enabled. Pass to this method debugInfo returned by logDebugBeforePublish. Need to pass messageId only in case it has changed since logDebugBeforePublish: some broadcasting protocols (JMS) don't generate messageId until the message is published.

logDebugAfterPublish

back to summary

protected void logDebugAfterPublish(Object[] debugInfo, String messageId)

INTERNAL: Called from executeCommandInternal to log debugInfo right after sending the message. Only call this method in case logDebugBeforePublish returned non-null this is indication that debug logging is enabled. Pass to this method debugInfo returned by logDebugBeforePublish. Need to pass messageId only in case it has changed since logDebugBeforePublish: some broadcasting protocols (JMS) don't generate messageId until the message is published.

logDebugBeforePublish	back to summary
protected Object[] logDebugBeforePublish(String messageId) INTERNAL: Called from executeCommandInternal to log debugInfo right before sending the message. Returns array {toString(), messageId }. In case messageId is null returns getInfoExt() avoiding creation of a new array.

logDebugOnReceiveMessage	back to summary
protected void logDebugOnReceiveMessage(String messageId) INTERNAL: Called when a message is received to log debugInfo: { toString(), messageId }. This method is used by local (listening) connection only.

processReceivedObject	back to summary
protected void processReceivedObject(Object object, String messageId) INTERNAL: Process the object extracted from the received message. Pass to this method messageInfo created by logDebugOnReceiveMessage method. This method is used by local (listening) connection only.

shouldCheckServiceId	back to summary
protected boolean shouldCheckServiceId() INTERNAL: Return whether a BroadcastConnection should check a ServiceId against its own ServiceId to avoid the processing of Commands with the same ServiceId. Returns:boolean boolean

shouldCheckServiceId

back to summary

protected boolean shouldCheckServiceId()

INTERNAL: Return whether a BroadcastConnection should check a ServiceId against its own ServiceId to avoid the processing of Commands with the same ServiceId.

Returns:boolean: boolean

toString	back to summary
public String toString() Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.toString. INTERNAL: Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides org.eclipse.persistence.internal.sessions.coordination.RemoteConnection.toString.

INTERNAL:

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

public abstract Class BroadcastRemoteConnection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail