org.apache.geode.internal.protocol.state

Interface ConnectionStateProcessor

All Known Subinterfaces:

ConnectionAuthenticatingStateProcessor

All Known Implementing Classes:

ConnectionShiroAuthorizingStateProcessor, ConnectionTerminatingStateProcessor, LegacySecurityConnectionStateProcessor, NoSecurityConnectionStateProcessor

public interface ConnectionStateProcessor

This object encapsulates any operation processing that is specific to the current state of a protocol connection. It is used to inject behavior at specific points in the processing of protocol operations as opposed to requiring an explicit state machine to drive the state transitions from outside the protocol.

Method Summary

Modifier and Type	Method and Description
default ConnectionAuthenticatingStateProcessor	allowAuthentication() This indicates whether this specific state processor is able to handle authentication requests.
default boolean	handleMessageIndependently(java.io.InputStream inputStream, java.io.OutputStream outputStream, MessageExecutionContext executionContext) Allow the state processor to take over the entire processing of a given message.
default boolean	socketProcessingIsFinished() This indicates whether this state is capable of receiving any more messages
void	validateOperation(MessageExecutionContext messageContext, OperationContext operationContext)

Method Detail

validateOperation

void validateOperation(MessageExecutionContext messageContext,
                       OperationContext operationContext)
                throws ConnectionStateException

Throws:

ConnectionStateException - if incapable of handling the given operationContext when the connection is in the state contained in the provided messageContext. Otherwise, does nothing.

allowAuthentication

default ConnectionAuthenticatingStateProcessor allowAuthentication()
                                                            throws ConnectionStateException

This indicates whether this specific state processor is able to handle authentication requests.

Returns:

specialized ConnectionAuthenticatingStateProcessor interface implementation which can move to a new state

Throws:

ConnectionStateException - if unable to handle handshakes in this state.

handleMessageIndependently

default boolean handleMessageIndependently(java.io.InputStream inputStream,
                                           java.io.OutputStream outputStream,
                                           MessageExecutionContext executionContext)
                                    throws java.io.IOException

Allow the state processor to take over the entire processing of a given message.

Returns:

- True if the message has been handled by the state processor, false to continue normal processing.

Throws:

java.io.IOException

socketProcessingIsFinished

default boolean socketProcessingIsFinished()

This indicates whether this state is capable of receiving any more messages

Returns:

True if the socket should be closed