com.solacesystems.jcsmp.protocol.impl

Class ControllerChannel

java.lang.Object

com.solacesystems.jcsmp.protocol.impl.TcpChannel

com.solacesystems.jcsmp.protocol.impl.ControllerChannel

All Implemented Interfaces:

CSMPChannel, CSMPControllerChannel, JCSMPConstants

public class ControllerChannel
extends TcpChannel
implements CSMPControllerChannel

ControllerChannel

Nested Class Summary

Nested classes/interfaces inherited from class com.solacesystems.jcsmp.protocol.impl.TcpChannel

TcpChannel.KeepaliveWriteResult, TcpChannel.WriteBlockPolicy

Field Summary

Fields inherited from class com.solacesystems.jcsmp.protocol.impl.TcpChannel

_context

Fields inherited from interface com.solacesystems.jcsmp.protocol.JCSMPConstants

ATTACHMENT_HEADER_LENGTH, ATTACHMENT_TYPE, ATTACHMENT_ZERO, AUTH_BASIC, CAP_ADCTRL, CAP_ADMESSAGING, CAP_PUBCTRL, CAP_SUBCTRL, COLON, CONSUMER_DISPATCHER_QUEUE_SIZE_DEFAULT, CONSUMER_THREAD, CONTENT_LENGTH, CONTENT_TYPE, CRLF, CSMP_URI, CSMP_VERSION, CSMP_VERSION_NUMBER, CSMPISNOTOK, CSMPISOK, DEFAULT_CSMPVRID, DEFAULT_FLOW_QUEUE_CONGESTED, DEFAULT_FLOW_QUEUE_UNCONGESTED, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_MAX_METADATA_LENGTH, DEFAULT_RX_MESSAGE_PRIORITY, DEFAULT_VRIDNAME, DOCID, EMPTY_DOCID, ENVVAR_DISABLE_STATS, ENVVAR_LOCALHOST, HOST, HOST_PORT_SEPERATOR, HTTP, HTTP_200_RESPONSE, HTTP_400_RESPONSE, HTTP_401_RESPONSE, HTTP_403_RESPONSE, HTTP_500_RESPONSE, HTTP_501_RESPONSE, HTTP_503_RESPONSE, HTTP_HEADER, HTTP_STR_OK, HTTP_URL_INSECURE, HTTP_URL_SECURE, HTTP1_1_CRLF, HTTPS, INVALID_VIRTUAL_ROUTER, ISO_CHARSET, LGM_MSG_ID, LGM_NUM_SEGMENTS, LGM_SEG_DEST_PREFIX, LGM_SEG_ID, LGM_TOTAL_SIZE, MAX_AD_APPACK_PER_MSG, MAX_CONSUMED_MESSAGEFLOWS_PER_XA_TRANSACTION, MAX_CONSUMED_MESSAGES_PER_FLOW_PER_XA_TRANSACTION, MAX_LGM_NUM_SEGMENTS, MAX_NACK_COUNTER, MAX_PORT_NUMBER, MAX_RECONNECTS_ALLOWED_BY_FREQ_MANAGER_DEFAULT, MAX_SENDMULTIPLE_VECTOR_LEN, MAX_USERDATA_LENGTH, MESSAGE_ROUTER_SW_VERSION_LATEST, MSGTYPECODE_DIRECT, MSGTYPECODE_NONPERSISTENT, MSGTYPECODE_PERSISTENT, NACK_HOLD_DOWN_TIME_IN_MILLIS, OK_RESPONSE, PERSISTENT, POST, PREV_DOCID, PRI, PRODUCER_DISPATCHER_QUEUE_SIZE_DEFAULT, PUB_HTTP_KA_THREAD, PUB_KEEPALIVE_URI, PUBCTRL_URI, PUBCTRL_VERSION, PUBCTRL_VERSION_NUMBER, PUBMSG_URI, PUBPRI, REDELIVERED, RESP_AD_NOT_READY, RESP_UNKNOWN_PROTOCOL, ROUTER_SW_VERSION, SLASH, SMF_507_RESPONSE, SOLACE_ATTACHMENT, STREAM_PUB_RESP_THREAD, SUB_HTTP_ENQUEUE_THREAD, SUB_HTTP_FQ_THREAD, SUB_HTTP_KA_THREAD, SUB_HTTP_NACK_HOLDDOWN_THREAD, SUB_KEEPALIVE_URI, SUB_UDPMULTI_ENQUEUE_THREAD, SUB_UDPUNI_ENQUEUE_THREAD, SUBCTRL_URI, SUBCTRL_VERSION, SUBCTRL_VERSION_NUMBER, SUPPORTED_PROTOCOL_CSMP, SUPPORTED_PROTOCOL_HTTP, SUPPORTED_PROTOCOL_HTTPS, SUPPORTED_PROTOCOL_MULTICAST, SUPPORTED_PROTOCOL_SMF, SUPPORTED_PROTOCOL_SMFS, SUPPORTED_PROTOCOL_TCP, SUPPORTED_PROTOCOL_UDP, SUPPORTED_PROTOCOL_UNICAST, SYSPROP_JAAS_LOGIN_CONTEXT, SYSPROP_USE_DIRECT_BUF_MSG, SYSPROP_XA_RECOVER_NUM_XIDS, TEXT_XML_CONTENT, TTL, URI_AMP_SEPERATOR, URI_EQUAL_SEPERATOR, URI_QMARK_SEPERATOR, USER_DATA, UTF8_CHARSET, ZERO_LENGTH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
ControllerChannel(JCSMPProperties properties, SecureProperties secureProps, JCSMPSessionStats sessionStats, ContextImpl context)

Method Summary

Modifier and Type	Method and Description
void	addSubscriber()
void	clearSubscriber() Removes a subscriber from the router using the user information associated with the JCSMPSession.
void	close() Close the underlying connection
JndiMessage	executeJndiQuery(JndiMessage request)
boolean	isAutoReconnector() Checks to see if the underlying channel is an auto-reconnector.
boolean	isUserCloseable()
void	open() Open the channel (connect to the router).

Methods inherited from class com.solacesystems.jcsmp.protocol.impl.TcpChannel

cleanupBuffers, connected, getChannelProperties, getLocalIPUsed, getLocalPort, getNetworkInfoString, getRemoteAddr, getRemotePort, getSmfClient

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.solacesystems.jcsmp.protocol.CSMPChannel

cleanupBuffers, connected, getChannelProperties

Constructor Detail

ControllerChannel

public ControllerChannel(JCSMPProperties properties,
                         SecureProperties secureProps,
                         JCSMPSessionStats sessionStats,
                         ContextImpl context)

Method Detail

open

public void open()
          throws JCSMPException

Description copied from interface: CSMPChannel

Open the channel (connect to the router).

Specified by:

open in interface CSMPChannel

Overrides:

open in class TcpChannel

Throws:

JCSMPException - on error

See Also:

CSMPChannel.open()

addSubscriber

public void addSubscriber()
                   throws JCSMPException

Specified by:

addSubscriber in interface CSMPControllerChannel

Throws:

JCSMPException

See Also:

CSMPControllerChannel.addSubscriber()

close

public void close()

Description copied from class: TcpChannel

Close the underlying connection

Specified by:

close in interface CSMPChannel

Overrides:

close in class TcpChannel

executeJndiQuery

public JndiMessage executeJndiQuery(JndiMessage request)
                             throws JCSMPException

Specified by:

executeJndiQuery in interface CSMPControllerChannel

Throws:

JCSMPException

clearSubscriber

public void clearSubscriber()
                     throws JCSMPException

Description copied from interface: CSMPControllerChannel

Removes a subscriber from the router using the user information associated with the JCSMPSession.

If the user does not exist on the router, this method still returns success.

Specified by:

clearSubscriber in interface CSMPControllerChannel

Throws:

JCSMPException - if there was an error removing the subscriber

See Also:

CSMPControllerChannel.clearSubscriber()

isAutoReconnector

public boolean isAutoReconnector()

Description copied from interface: CSMPChannel

Checks to see if the underlying channel is an auto-reconnector. This is a temporary measure applicable to avoid rewriting the pub/sub reconnecting logic at the channel level during the multi-iteration consolidation on client channels. When an auto-reconnector channel delivers an Exception, it means it has already tried (and failed) reconnection tasks, and no further reconnection logic should be executed. If the channel is NOT an auto-reconnector (this method returned false), the Producer or Consumer may perform reconnection logic.

Specified by:

isAutoReconnector in interface CSMPChannel

Returns:

true if the channel is an auto-reconnector, false otherwise.

isUserCloseable

public boolean isUserCloseable()

Specified by:

isUserCloseable in interface CSMPChannel

Returns:

result