com.adaptris.core.MetadataFileNameCreator.java Source code

Introduction

Here is the source code for com.adaptris.core.MetadataFileNameCreator.java

Source

/*
 * Copyright 2015 Adaptris Ltd.
 * 
 * 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 com.adaptris.core;

import org.apache.commons.lang.StringUtils;
import org.hibernate.validator.constraints.NotBlank;

import com.adaptris.annotation.AutoPopulated;
import com.adaptris.annotation.DisplayOrder;
import com.adaptris.annotation.InputFieldHint;
import com.adaptris.core.util.Args;
import com.thoughtworks.xstream.annotations.XStreamAlias;

/**
 * <p>
 * Implementation of <code>FileNameCreator</code> which obtains the file name
 * to use from message metadata.
 * </p>
 * <p>
 * In the adapter configuration file this class is aliased as <b>metadata-file-name-creator</b> which is the preferred alternative to the
 * fully qualified classname when building your configuration.
 * </p>
 */
@XStreamAlias("metadata-file-name-creator")
@DisplayOrder(order = { "metadataKey", "defaultName" })
public class MetadataFileNameCreator implements FileNameCreator {

    @NotBlank
    private String metadataKey;
    @NotBlank
    @AutoPopulated
    @InputFieldHint(style = "BLANKABLE")
    private String defaultName;

    /**
     * <p>
     * Creates a new instance.  Default name is "MetadataFileNameCreator_default".
     * </p>
     */
    public MetadataFileNameCreator() {
        this.setDefaultName("MetadataFileNameCreator_default");
    }

    public MetadataFileNameCreator(String metadataKey) {
        this();
        setMetadataKey(metadataKey);
    }

    public MetadataFileNameCreator(String metadataKey, String defaultName) {
        this();
        setMetadataKey(metadataKey);
        setDefaultName(defaultName);
    }

    /**
     * <p>
     * Obtains the value for the configured metadata key, if this is not null or
     * empty it is returned.  If the metadata value is null or empty then the
     * configured 'default name' is returned.
     * </p>
     * @see com.adaptris.core.FileNameCreator
     *   #createName(com.adaptris.core.AdaptrisMessage)
     */
    public String createName(AdaptrisMessage msg) throws CoreException {
        if (getMetadataKey() == null) {
            throw new CoreException("illegal metadata key [" + metadataKey + "]");
        }
        return StringUtils.defaultIfEmpty(msg.getMetadataValue(metadataKey), defaultName);
    }

    /**
     * <p>
     * Returns the metadata key to look up.
     * </p>
     * @return the metadata key to look up
     */
    public String getMetadataKey() {
        return metadataKey;
    }

    /**
     * <p>
     * Sets the metadata key to look up.  May not be null or empty.
     * </p>
     * @param s the metadata key to look up
     */
    public void setMetadataKey(String s) {
        metadataKey = Args.notBlank(s, "metadataKey");
    }

    /**
     * <p>
     * Sets the 'default name' which will be used if the metadata value is null
     * or empty.
     * </p>
     * @return the 'default name' which will be used if the metadata value is null
     * or empty
     */
    public String getDefaultName() {
        return defaultName;
    }

    /**
     * <p>
     * Returns the 'default name' which will be used if the metadata value is null
     * or empty.
     * </p>
     * @param s the 'default name' which will be used if the metadata value is
     * null or empty
     */
    public void setDefaultName(String s) {
        defaultName = Args.notBlank(s, "defaultName");
    }
}