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")
037    private Integer lineLength;
038    @XmlAttribute
039    private String lineSeparator;
040    @XmlAttribute
041    private Boolean urlSafe;
042
043    public Base64DataFormat() {
044        super("base64");
045    }
046
047    public Integer getLineLength() {
048        return lineLength;
049    }
050
051    /**
052     * To specific a maximum line length for the encoded data.
053     * <p/>
054     * By default 76 is used.
055     */
056    public void setLineLength(Integer lineLength) {
057        this.lineLength = lineLength;
058    }
059
060    public String getLineSeparator() {
061        return lineSeparator;
062    }
063
064    /**
065     * The line separators to use.
066     * <p/>
067     * Uses new line characters (CRLF) by default.
068     */
069    public void setLineSeparator(String lineSeparator) {
070        this.lineSeparator = lineSeparator;
071    }
072
073    public Boolean getUrlSafe() {
074        return urlSafe;
075    }
076
077    /**
078     * Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe
079     * is only applied to encode operations. Decoding seamlessly handles both
080     * modes. Is by default false.
081     */
082    public void setUrlSafe(Boolean urlSafe) {
083        this.urlSafe = urlSafe;
084    }
085}