org.citrusframework.rmi.client.RmiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of citrus-rmi Show documentation
The newest version!
/*
 * Copyright the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.citrusframework.rmi.client;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.rmi.NotBoundException;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.registry.Registry;
import java.util.Arrays;

import org.citrusframework.context.TestContext;
import org.citrusframework.endpoint.AbstractEndpoint;
import org.citrusframework.exceptions.CitrusRuntimeException;
import org.citrusframework.exceptions.MessageTimeoutException;
import org.citrusframework.message.DefaultMessage;
import org.citrusframework.message.Message;
import org.citrusframework.message.MessageHeaders;
import org.citrusframework.message.correlation.CorrelationManager;
import org.citrusframework.message.correlation.PollingCorrelationManager;
import org.citrusframework.messaging.Producer;
import org.citrusframework.messaging.ReplyConsumer;
import org.citrusframework.messaging.SelectiveConsumer;
import org.citrusframework.rmi.endpoint.RmiEndpointConfiguration;
import org.citrusframework.rmi.message.RmiMessageHeaders;
import org.citrusframework.rmi.model.RmiServiceInvocation;
import org.citrusframework.rmi.model.RmiServiceResult;
import org.citrusframework.util.ReflectionHelper;
import org.citrusframework.util.StringUtils;
import org.citrusframework.xml.StringResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @since 2.5
 */
public class RmiClient extends AbstractEndpoint implements Producer, ReplyConsumer {

    /** Logger */
    private static final Logger logger = LoggerFactory.getLogger(RmiClient.class);

    /** Store of reply messages */
    private CorrelationManager correlationManager;

    /**
     * Default constructor initializing endpoint configuration.
     */
    public RmiClient() {
        this(new RmiEndpointConfiguration());
    }

    /**
     * Default constructor using endpoint configuration.
     * @param endpointConfiguration
     */
    public RmiClient(RmiEndpointConfiguration endpointConfiguration) {
        super(endpointConfiguration);
        this.correlationManager = new PollingCorrelationManager<>(endpointConfiguration, "Reply message did not arrive yet");
    }

    @Override
    public RmiEndpointConfiguration getEndpointConfiguration() {
        return (RmiEndpointConfiguration) super.getEndpointConfiguration();
    }

    @Override
    public void send(final Message message, TestContext context) {
        String correlationKeyName = getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName());
        String correlationKey = getEndpointConfiguration().getCorrelator().getCorrelationKey(message);
        correlationManager.saveCorrelationKey(correlationKeyName, correlationKey, context);

        final String binding = message.getHeader(RmiMessageHeaders.RMI_BINDING) != null ? message.getHeader(RmiMessageHeaders.RMI_BINDING).toString() : getEndpointConfiguration().getBinding();
        context.setVariable(MessageHeaders.MESSAGE_REPLY_TO + "_" + correlationKeyName, binding);
        try {
            RmiServiceInvocation invocation = getEndpointConfiguration().getMessageConverter().convertOutbound(message, getEndpointConfiguration(), context);
            Registry registry = getEndpointConfiguration().getRegistry();
            final Remote remoteTarget = registry.lookup(binding);

            final Method[] method = new Method[1];
            if (StringUtils.hasText(invocation.getMethod())) {
                method[0] = ReflectionHelper.findMethod(remoteTarget.getClass(), invocation.getMethod(), invocation.getArgTypes());
            } else {
                ReflectionHelper.doWithMethods(remoteTarget.getClass(), declaredMethod -> {
                    if (!Arrays.asList(declaredMethod.getExceptionTypes()).contains(RemoteException.class) ||
                            !declaredMethod.getDeclaringClass().equals(remoteTarget.getClass())) {
                        return;
                    }

                    if (method[0] == null) {
                        method[0] = declaredMethod;
                    }
                });
            }

            if (method[0] == null) {
                throw new CitrusRuntimeException("Unable to find proper method declaration on remote target object");
            }

            if (logger.isDebugEnabled()) {
                logger.debug("Sending message to RMI server: '" + binding + "'");
                logger.debug("Message to send:\n" + message.getPayload(String.class));
            }
            context.onOutboundMessage(message);

            Object result = method[0].invoke(remoteTarget, invocation.getArgValues(context.getReferenceResolver()));
            RmiServiceResult serviceResult = new RmiServiceResult();

            if (result != null) {
                RmiServiceResult.Object serviceResultObject = new RmiServiceResult.Object();
                serviceResultObject.setType(result.getClass().getName());
                serviceResultObject.setValueObject(result);
                serviceResult.setObject(serviceResultObject);
            }

            StringResult payload = new StringResult();
            getEndpointConfiguration().getMarshaller().marshal(serviceResult, payload);
            Message response = new DefaultMessage(payload.toString());
            correlationManager.store(correlationKey, response);

            logger.info("Message was sent to RMI server: '" + binding + "'");
            if (result != null) {
                context.onInboundMessage(response);
            }
        } catch (RemoteException e) {
            throw new CitrusRuntimeException("Failed to connect to RMI server", e);
        } catch (NotBoundException e) {
            throw new CitrusRuntimeException("Failed to find service binding on RMI server", e);
        } catch (InvocationTargetException e) {
            throw new CitrusRuntimeException("Failed to invoke method on remote target", e);
        } catch (IllegalAccessException e) {
            throw new CitrusRuntimeException("Failed to invoke method on remote target, because remote method not accessible", e);
        }

        logger.info("Message was sent to RMI server: '" + binding + "'");
    }

    @Override
    public Message receive(TestContext context) {
        return receive(correlationManager.getCorrelationKey(
                getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName()), context), context);
    }

    @Override
    public Message receive(String selector, TestContext context) {
        return receive(selector, context, getEndpointConfiguration().getTimeout());
    }

    @Override
    public Message receive(TestContext context, long timeout) {
        return receive(correlationManager.getCorrelationKey(
                getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName()), context), context, timeout);
    }

    @Override
    public Message receive(String selector, TestContext context, long timeout) {
        Message message = correlationManager.find(selector, timeout);

        String binding;
        if (context.getVariables().containsKey(MessageHeaders.MESSAGE_REPLY_TO + "_" + selector)) {
            binding = context.getVariable(MessageHeaders.MESSAGE_REPLY_TO + "_" + selector);
        } else {
            binding = getName();
        }

        if (message == null) {
            throw new MessageTimeoutException(timeout, binding);
        }

        return message;
    }

    /**
     * Creates a message producer for this endpoint for sending messages
     * to this endpoint.
     */
    @Override
    public Producer createProducer() {
        return this;
    }

    /**
     * Creates a message consumer for this endpoint. Consumer receives
     * messages on this endpoint.
     *
     * @return
     */
    @Override
    public SelectiveConsumer createConsumer() {
        return this;
    }

    /**
     * Sets the correlation manager.
     * @param correlationManager
     */
    public void setCorrelationManager(CorrelationManager correlationManager) {
        this.correlationManager = correlationManager;
    }
}