com.highdeal.hci

Class AdminMessageSender

java.lang.Object

com.highdeal.hci.AdminMessageSender

All Implemented Interfaces:

MessageSender

Direct Known Subclasses:

UpdaterMessageSender

public class AdminMessageSender
extends java.lang.Object
implements MessageSender

Nested Class Summary

Nested classes/interfaces inherited from interface com.highdeal.hci.MessageSender

MessageSender.IRedirectHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_INSTANCE_ID_ADDITIONAL_HEADER

Constructor Summary

Constructors

Constructor and Description
AdminMessageSender(java.lang.String instanceKey, XMLMapping adminMapping, javax.net.ssl.SSLSocketFactory sslSocketFactory, java.net.URL... dispatcherAdminUrl)
AdminMessageSender(java.lang.String instanceKey, XMLMapping adminMapping, java.net.URL... dispatcherAdminUrl)

Method Summary

Modifier and Type	Method and Description
void	activate(MessageOriginator ori) Activate the connection
void	addRedirectHandler(MessageSender.IRedirectHandler redirectHandler) Adds a redirection handler to this MessageSender; This handler is notified of redirection events.
MessageContext	asyncSend(MessageEnvelope env, ClientMessageListener listener) Sends a HCI message and receives notification of progress and upon termination of the message process via a dedicated listener.
static java.lang.String	extractSystemIdFromUrl(java.net.URL dispatcherAdminUrl) Extracts the system identifier from a dispatcher admin URL.
AdminMessageSender[]	getAdminMessageSenderByInstanceType(boolean living, MessageOriginator mo, InstanceType... instanceTypes)
AdminMessageSender	getAdminMessageSenderOnLivingUpdater(boolean fresh, MessageOriginator mo)
java.lang.String	getInstanceKey()
java.net.URL	getServerUrl() Returns the URL of the server on which the MessageSender is connected.
java.util.List<InstanceStatus>	getStatus(MessageOriginator ori, InstanceType type, boolean alive)
SystemStatus	getSystemStatus(MessageOriginator ori) Returns the current system status.
void	removeRedirectHandler(MessageSender.IRedirectHandler redirectHandler) Removes a MessageSender.IRedirectHandler from this MessageSender; The handler is not be notified anymore of redirection events.
MessageEnvelope	send(MessageEnvelope message) Sends a HCI message and receives its results via the HCI technical interface; The communications are synchronous.
MessageEnvelope	send(MessageEnvelope message, int timeout) Sends a HCI message and receives its results via the HCI technical interface; this method is protected by a timeout, that means that, if the SAP CC system does not answer within the timeout, a communication failure is sent.
static void	updateSystemStatusForKubernetes(SystemStatus systemStatusToUpdate, java.net.URL dispatcherAdminUrl) Updates a system status model to be compatible with Kubernetes if applicable.

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_INSTANCE_ID_ADDITIONAL_HEADER

public static final java.lang.String ADMIN_INSTANCE_ID_ADDITIONAL_HEADER

See Also:

Constant Field Values

Constructor Detail

AdminMessageSender

public AdminMessageSender(java.lang.String instanceKey,
                          XMLMapping adminMapping,
                          java.net.URL... dispatcherAdminUrl)

AdminMessageSender

public AdminMessageSender(java.lang.String instanceKey,
                          XMLMapping adminMapping,
                          javax.net.ssl.SSLSocketFactory sslSocketFactory,
                          java.net.URL... dispatcherAdminUrl)

Method Detail

asyncSend

public MessageContext asyncSend(MessageEnvelope env,
                                ClientMessageListener listener)
                         throws BadMessageFormatException,
                                CommunicationFailureException

Description copied from interface: MessageSender

Sends a HCI message and receives notification of progress and upon termination of the message process via a dedicated listener.

Specified by:

asyncSend in interface MessageSender

Parameters:

env - The HCI message to send

listener - A listener that will be notified of progress and upon termination of operations and message

Returns:

A message context that can be used to cancel the message or retrieve results

Throws:

BadMessageFormatException - if the message is in a bad format

CommunicationFailureException - if the SAP CC system cannot be reached

send

public MessageEnvelope send(MessageEnvelope message)
                     throws CommunicationFailureException,
                            BadMessageFormatException

Description copied from interface: MessageSender

Sends a HCI message and receives its results via the HCI technical interface; The communications are synchronous.

Specified by:

send in interface MessageSender

Parameters:

message - The message to send

Returns:

The resulting message

Throws:

CommunicationFailureException - if the SAP CC system cannot be reached

BadMessageFormatException - if the message received is in a bad format

send

public MessageEnvelope send(MessageEnvelope message,
                            int timeout)
                     throws CommunicationFailureException,
                            BadMessageFormatException

Description copied from interface: MessageSender

Sends a HCI message and receives its results via the HCI technical interface; this method is protected by a timeout, that means that, if the SAP CC system does not answer within the timeout, a communication failure is sent. Option: You can define a client-side timeout.

Specified by:

send in interface MessageSender

Parameters:

message - The HCI message to send

timeout - The timeout in millisecond (ms), a negative number means no timeout

Returns:

The resulting message

Throws:

CommunicationFailureException - if the SAP CC system cannot be reached or if the timeout expires

BadMessageFormatException - if the message received is in a bad format

getServerUrl

public java.net.URL getServerUrl()

Description copied from interface: MessageSender

Returns the URL of the server on which the MessageSender is connected.

Specified by:

getServerUrl in interface MessageSender

Returns:

the URL of the server on which the MessageSender is connected

getInstanceKey

public java.lang.String getInstanceKey()

getAdminMessageSenderOnLivingUpdater

public AdminMessageSender getAdminMessageSenderOnLivingUpdater(boolean fresh,
                                                               MessageOriginator mo)
                                                        throws CommunicationFailureException

Throws:

CommunicationFailureException

getAdminMessageSenderByInstanceType

public AdminMessageSender[] getAdminMessageSenderByInstanceType(boolean living,
                                                                MessageOriginator mo,
                                                                InstanceType... instanceTypes)
                                                         throws CommunicationFailureException

Throws:

CommunicationFailureException

getSystemStatus

public SystemStatus getSystemStatus(MessageOriginator ori)
                             throws OperationFailureException,
                                    CommunicationFailureException

Description copied from interface: MessageSender

Returns the current system status.

Specified by:

getSystemStatus in interface MessageSender

Parameters:

ori - a valid message originator.

Returns:

the current system status

Throws:

OperationFailureException - if the system status cannot be retrieved

CommunicationFailureException - if the server cannot be contacted

activate

public void activate(MessageOriginator ori)
              throws CommunicationFailureException,
                     OperationFailureException

Activate the connection

Parameters:

ori - a valid message originator.

Throws:

CommunicationFailureException

OperationFailureException

getStatus

public final java.util.List<InstanceStatus> getStatus(MessageOriginator ori,
                                                      InstanceType type,
                                                      boolean alive)
                                               throws CommunicationFailureException,
                                                      OperationFailureException

Throws:

CommunicationFailureException

OperationFailureException

addRedirectHandler

public final void addRedirectHandler(MessageSender.IRedirectHandler redirectHandler)

Description copied from interface: MessageSender

Adds a redirection handler to this MessageSender; This handler is notified of redirection events.

Specified by:

addRedirectHandler in interface MessageSender

Parameters:

redirectHandler - The redirection event handler to add

See Also:

MessageSender.IRedirectHandler

removeRedirectHandler

public final void removeRedirectHandler(MessageSender.IRedirectHandler redirectHandler)

Description copied from interface: MessageSender

Removes a MessageSender.IRedirectHandler from this MessageSender; The handler is not be notified anymore of redirection events.

Specified by:

removeRedirectHandler in interface MessageSender

Parameters:

redirectHandler - The redirection event handler to remove

updateSystemStatusForKubernetes

public static void updateSystemStatusForKubernetes(SystemStatus systemStatusToUpdate,
                                                   java.net.URL dispatcherAdminUrl)

Updates a system status model to be compatible with Kubernetes if applicable.

Parameters:

systemStatusToUpdate - the system status model to update

dispatcherAdminUrl - the dispatcher admin URL

extractSystemIdFromUrl

public static java.lang.String extractSystemIdFromUrl(java.net.URL dispatcherAdminUrl)

Extracts the system identifier from a dispatcher admin URL.

Parameters:

dispatcherAdminUrl - the dispatcher admin URL

Returns:

the system identifier extracted from the dispatcher admin URL if the system is deployed in Kubernetes, null otherwise