001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.model.dataformat;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.model.DataFormatDefinition;
025import org.apache.camel.spi.Metadata;
026
027/**
028 * The Base64 data format is used for base64 encoding and decoding.
029 */
030@Metadata(firstVersion = "2.11.0", label = "dataformat,transformation", title = "Base64")
031@XmlRootElement(name = "base64")
032@XmlAccessorType(XmlAccessType.FIELD)
033public class Base64DataFormat extends DataFormatDefinition {
034
035    @XmlAttribute
036    @Metadata(defaultValue = "76", javaType = "java.lang.Integer")
037    private String lineLength;
038    @XmlAttribute
039    private String lineSeparator;
040    @XmlAttribute
041    @Metadata(javaType = "java.lang.Boolean")
042    private String urlSafe;
043
044    public Base64DataFormat() {
045        super("base64");
046    }
047
048    public String getLineLength() {
049        return lineLength;
050    }
051
052    /**
053     * To specific a maximum line length for the encoded data.
054     * <p/>
055     * By default 76 is used.
056     */
057    public void setLineLength(String lineLength) {
058        this.lineLength = lineLength;
059    }
060
061    public String getLineSeparator() {
062        return lineSeparator;
063    }
064
065    /**
066     * The line separators to use.
067     * <p/>
068     * Uses new line characters (CRLF) by default.
069     */
070    public void setLineSeparator(String lineSeparator) {
071        this.lineSeparator = lineSeparator;
072    }
073
074    public String getUrlSafe() {
075        return urlSafe;
076    }
077
078    /**
079     * Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe
080     * is only applied to encode operations. Decoding seamlessly handles both
081     * modes. Is by default false.
082     */
083    public void setUrlSafe(String urlSafe) {
084        this.urlSafe = urlSafe;
085    }
086}