org.ikasan.component.endpoint.filetransfer.ManagedEventFileTransferIdentifierService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ikasan-client-filetransfer Show documentation

A default client for developers to use with File transfer based connectors in the Ikasan Enterprise Integration Platform

There is a newer version: 1.5.1

Show newest version

/*
 * $Id$
 * $URL$
 *
 * ====================================================================
 * Ikasan Enterprise Integration Platform
 *
 * Distributed under the Modified BSD License.
 * Copyright notice: The copyright for this software and a full listing
 * of individual contributors are as shown in the packaged copyright.txt
 * file.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  - Neither the name of the ORGANIZATION nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 */
package org.ikasan.component.endpoint.filetransfer;

import org.ikasan.filetransfer.Payload;
import org.ikasan.spec.event.ManagedEventIdentifierException;
import org.ikasan.spec.event.ManagedEventIdentifierService;

/**
 * Manages the event identifier setting/getting for Payload content
 * Ikasan Developmnet Team.
 */
public class ManagedEventFileTransferIdentifierService implements ManagedEventIdentifierService
{
    private static String FILE_NAME_ATTRIBUTE = "fileName";
    private static String ID_ATTRIBUTE = "id";

    String modulePrefix;

    /**
     * Optional constructor for passing module prefix
     * @param modulePrefix
     */
    public ManagedEventFileTransferIdentifierService(String modulePrefix)
    {
        this.modulePrefix = modulePrefix;
    }

    /**
     * Default constructor
     */
    public ManagedEventFileTransferIdentifierService()
    {
        // nothing to do here
    }

    @Override
    public void setEventIdentifier(String identifier, Payload payload) throws ManagedEventIdentifierException
    {
        payload.setAttribute(ID_ATTRIBUTE,identifier);
    }

    @Override
    public String getEventIdentifier(Payload payload) throws ManagedEventIdentifierException
    {
        String eventId = payload.getAttribute(FILE_NAME_ATTRIBUTE);
        if(modulePrefix != null)
        {
            return modulePrefix + eventId;
        }

        return eventId;
    }
}