001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.jms;
019
020import static java.lang.String.join;
021import static java.util.stream.Collectors.joining;
022import static org.slf4j.LoggerFactory.getLogger;
023
024import java.util.Set;
025import javax.jms.JMSException;
026import javax.jms.Message;
027import javax.jms.Session;
028
029import org.fcrepo.kernel.api.observer.Event;
030import org.fcrepo.kernel.api.observer.EventType;
031import org.fcrepo.event.serialization.EventSerializer;
032import org.fcrepo.event.serialization.JsonLDSerializer;
033
034import org.slf4j.Logger;
035
036/**
037 * Generates JMS {@link Message}s composed entirely of headers, based entirely
038 * on information found in the {@link Event} that triggers publication.
039 *
040 * @author ajs6f
041 * @author escowles
042 * @since Dec 2, 2013
043 */
044public class DefaultMessageFactory implements JMSEventMessageFactory {
045
046    private static final String JMS_NAMESPACE = "org.fcrepo.jms.";
047
048    public static final String TIMESTAMP_HEADER_NAME = JMS_NAMESPACE
049            + "timestamp";
050
051    public static final String IDENTIFIER_HEADER_NAME = JMS_NAMESPACE
052            + "identifier";
053
054    public static final String EVENT_TYPE_HEADER_NAME = JMS_NAMESPACE
055            + "eventType";
056
057    public static final String BASE_URL_HEADER_NAME = JMS_NAMESPACE
058            + "baseURL";
059
060    public static final String RESOURCE_TYPE_HEADER_NAME = JMS_NAMESPACE + "resourceType";
061
062    public static final String USER_HEADER_NAME = JMS_NAMESPACE + "user";
063    public static final String USER_AGENT_HEADER_NAME = JMS_NAMESPACE + "userAgent";
064    public static final String EVENT_ID_HEADER_NAME = JMS_NAMESPACE + "eventID";
065
066    @Override
067    public Message getMessage(final Event event, final Session jmsSession)
068            throws JMSException {
069
070        final EventSerializer serializer = new JsonLDSerializer();
071        final String body = serializer.serialize(event);
072        final Message message = jmsSession.createTextMessage(body);
073
074        message.setLongProperty(TIMESTAMP_HEADER_NAME, event.getDate().toEpochMilli());
075        message.setStringProperty(BASE_URL_HEADER_NAME, event.getBaseUrl());
076
077        if (event.getUserAgent() != null) {
078            message.setStringProperty(USER_AGENT_HEADER_NAME, event.getUserAgent());
079        }
080
081        message.setStringProperty(IDENTIFIER_HEADER_NAME, event.getPath());
082        message.setStringProperty(EVENT_TYPE_HEADER_NAME, getEventURIs(event.getTypes()));
083        message.setStringProperty(USER_HEADER_NAME, event.getUserID());
084        message.setStringProperty(RESOURCE_TYPE_HEADER_NAME, join(",", event.getResourceTypes()));
085        message.setStringProperty(EVENT_ID_HEADER_NAME, event.getEventID());
086
087        LOGGER.trace("getMessage() returning: {}", message);
088        return message;
089    }
090
091    private static String getEventURIs(final Set<EventType> types) {
092        final String uris = types.stream()
093                                 .map(EventType::getType)
094                                 .collect(joining(","));
095
096        LOGGER.debug("Constructed event type URIs: {}", uris);
097        return uris;
098    }
099
100    private static final Logger LOGGER = getLogger(DefaultMessageFactory.class);
101
102}