/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.camel.builder;
import java.util.Map;
import java.util.zip.Deflater;
import org.w3c.dom.Node;
import org.apache.camel.model.DataFormatDefinition;
import org.apache.camel.model.ProcessorDefinition;
import org.apache.camel.model.dataformat.AvroDataFormat;
import org.apache.camel.model.dataformat.BindyDataFormat;
import org.apache.camel.model.dataformat.BindyType;
import org.apache.camel.model.dataformat.CastorDataFormat;
import org.apache.camel.model.dataformat.CsvDataFormat;
import org.apache.camel.model.dataformat.CustomDataFormat;
import org.apache.camel.model.dataformat.GzipDataFormat;
import org.apache.camel.model.dataformat.HL7DataFormat;
import org.apache.camel.model.dataformat.JaxbDataFormat;
import org.apache.camel.model.dataformat.JibxDataFormat;
import org.apache.camel.model.dataformat.JsonDataFormat;
import org.apache.camel.model.dataformat.JsonLibrary;
import org.apache.camel.model.dataformat.PGPDataFormat;
import org.apache.camel.model.dataformat.ProtobufDataFormat;
import org.apache.camel.model.dataformat.RssDataFormat;
import org.apache.camel.model.dataformat.SerializationDataFormat;
import org.apache.camel.model.dataformat.SoapJaxbDataFormat;
import org.apache.camel.model.dataformat.StringDataFormat;
import org.apache.camel.model.dataformat.SyslogDataFormat;
import org.apache.camel.model.dataformat.TidyMarkupDataFormat;
import org.apache.camel.model.dataformat.XMLBeansDataFormat;
import org.apache.camel.model.dataformat.XMLSecurityDataFormat;
import org.apache.camel.model.dataformat.XStreamDataFormat;
import org.apache.camel.model.dataformat.XmlJsonDataFormat;
import org.apache.camel.model.dataformat.ZipDataFormat;
import org.apache.camel.util.jsse.KeyStoreParameters;
/**
* An expression for constructing the different possible {@link org.apache.camel.spi.DataFormat}
* options.
*
* @version
*/
public class DataFormatClause<T extends ProcessorDefinition<?>> {
private final T processorType;
private final Operation operation;
/**
* {@link org.apache.camel.spi.DataFormat} operations.
*/
public enum Operation {
Marshal, Unmarshal
}
public DataFormatClause(T processorType, Operation operation) {
this.processorType = processorType;
this.operation = operation;
}
/**
* Uses the Avro data format
*/
public T avro() {
return dataFormat(new AvroDataFormat());
}
public T avro(Object schema) {
AvroDataFormat dataFormat = new AvroDataFormat();
dataFormat.setSchema(schema);
return dataFormat(dataFormat);
}
public T avro(String instanceClassName) {
return dataFormat(new AvroDataFormat(instanceClassName));
}
/**
* Uses the Bindy data format
*
* @param type the type of bindy data format to use
* @param packages packages to scan for Bindy annotated POJO classes
*/
public T bindy(BindyType type, String... packages) {
BindyDataFormat bindy = new BindyDataFormat();
bindy.setType(type);
bindy.setPackages(packages);
return dataFormat(bindy);
}
/**
* Uses the Bindy data format
*
* @param type the type of bindy data format to use
* @param classType the POJO class type
*/
public T bindy(BindyType type, Class<?> classType) {
BindyDataFormat bindy = new BindyDataFormat();
bindy.setType(type);
bindy.setClassType(classType);
return dataFormat(bindy);
}
/**
* Uses the CSV data format
*/
public T csv() {
return dataFormat(new CsvDataFormat());
}
/**
* Uses the custom data format
*/
public T custom(String ref) {
return dataFormat(new CustomDataFormat(ref));
}
/**
* Uses the Castor data format
*/
public T castor() {
return dataFormat(new CastorDataFormat());
}
/**
* Uses the Castor data format
*
* @param mappingFile name of mapping file to locate in classpath
*/
public T castor(String mappingFile) {
CastorDataFormat castor = new CastorDataFormat();
castor.setMappingFile(mappingFile);
return dataFormat(castor);
}
/**
* Uses the Castor data format
*
* @param mappingFile name of mapping file to locate in classpath
* @param validation whether validation is enabled or not
*/
public T castor(String mappingFile, boolean validation) {
CastorDataFormat castor = new CastorDataFormat();
castor.setMappingFile(mappingFile);
castor.setValidation(validation);
return dataFormat(castor);
}
/**
* Uses the GZIP deflater data format
*/
public T gzip() {
GzipDataFormat gzdf = new GzipDataFormat();
return dataFormat(gzdf);
}
/**
* Uses the HL7 data format
*/
public T hl7() {
return dataFormat(new HL7DataFormat());
}
/**
* Uses the HL7 data format
*/
public T hl7(boolean validate) {
HL7DataFormat hl7 = new HL7DataFormat();
hl7.setValidate(validate);
return dataFormat(hl7);
}
/**
* Uses the PGP data format
*/
public T pgp(String keyFileName, String keyUserid) {
PGPDataFormat pgp = new PGPDataFormat();
pgp.setKeyFileName(keyFileName);
pgp.setKeyUserid(keyUserid);
return dataFormat(pgp);
}
/**
* Uses the PGP data format
*/
public T pgp(String keyFileName, String keyUserid, String password) {
PGPDataFormat pgp = new PGPDataFormat();
pgp.setKeyFileName(keyFileName);
pgp.setKeyUserid(keyUserid);
pgp.setPassword(password);
return dataFormat(pgp);
}
/**
* Uses the PGP data format
*/
public T pgp(String keyFileName, String keyUserid, String password, boolean armored, boolean integrity) {
PGPDataFormat pgp = new PGPDataFormat();
pgp.setKeyFileName(keyFileName);
pgp.setKeyUserid(keyUserid);
pgp.setPassword(password);
pgp.setArmored(armored);
pgp.setIntegrity(integrity);
return dataFormat(pgp);
}
/**
* Uses the JAXB data format
*/
public T jaxb() {
return dataFormat(new JaxbDataFormat());
}
/**
* Uses the JAXB data format with context path
*/
public T jaxb(String contextPath) {
JaxbDataFormat dataFormat = new JaxbDataFormat();
dataFormat.setContextPath(contextPath);
return dataFormat(dataFormat);
}
/**
* Uses the JAXB data format turning pretty printing on or off
*/
public T jaxb(boolean prettyPrint) {
return dataFormat(new JaxbDataFormat(prettyPrint));
}
/**
* Uses the JiBX data format.
*/
public T jibx() {
return dataFormat(new JibxDataFormat());
}
/**
* Uses the JiBX data format with unmarshall class.
*/
public T jibx(Class<?> unmarshallClass) {
return dataFormat(new JibxDataFormat(unmarshallClass));
}
/**
* Uses the JSON data format using the XStream json library
*/
public T json() {
return dataFormat(new JsonDataFormat());
}
/**
* Uses the JSON data format
*
* @param library the json library to use
*/
public T json(JsonLibrary library) {
return dataFormat(new JsonDataFormat(library));
}
/**
* Uses the JSON data format
*
* @param type the json type to use
* @param unmarshalType unmarshal type for json jackson type
*/
public T json(JsonLibrary type, Class<?> unmarshalType) {
JsonDataFormat json = new JsonDataFormat(type);
json.setUnmarshalType(unmarshalType);
return dataFormat(json);
}
/**
* Uses the protobuf data format
*/
public T protobuf() {
return dataFormat(new ProtobufDataFormat());
}
public T protobuf(Object defaultInstance) {
ProtobufDataFormat dataFormat = new ProtobufDataFormat();
dataFormat.setDefaultInstance(defaultInstance);
return dataFormat(dataFormat);
}
public T protobuf(String instanceClassName) {
return dataFormat(new ProtobufDataFormat(instanceClassName));
}
/**
* Uses the RSS data format
*/
public T rss() {
return dataFormat(new RssDataFormat());
}
/**
* Uses the Java Serialization data format
*/
public T serialization() {
return dataFormat(new SerializationDataFormat());
}
/**
* Uses the Soap JAXB data format
*/
public T soapjaxb() {
return dataFormat(new SoapJaxbDataFormat());
}
/**
* Uses the Soap JAXB data format
*/
public T soapjaxb(String contextPath) {
return dataFormat(new SoapJaxbDataFormat(contextPath));
}
/**
* Uses the Soap JAXB data format
*/
public T soapjaxb(String contextPath, String elementNameStrategyRef) {
return dataFormat(new SoapJaxbDataFormat(contextPath, elementNameStrategyRef));
}
/**
* Uses the Soap JAXB data format
*/
public T soapjaxb(String contextPath, Object elementNameStrategy) {
return dataFormat(new SoapJaxbDataFormat(contextPath, elementNameStrategy));
}
/**
* Uses the String data format
*/
public T string() {
return string(null);
}
/**
* Uses the String data format supporting encoding using given charset
*/
public T string(String charset) {
StringDataFormat sdf = new StringDataFormat();
sdf.setCharset(charset);
return dataFormat(sdf);
}
/**
* Uses the Syslog data format
*/
public T syslog() {
return dataFormat(new SyslogDataFormat());
}
/**
* Return WellFormed HTML (an XML Document) either
* {@link java.lang.String} or {@link org.w3c.dom.Node}
*/
public T tidyMarkup(Class<?> dataObjectType) {
return dataFormat(new TidyMarkupDataFormat(dataObjectType));
}
/**
* Return TidyMarkup in the default format
* as {@link org.w3c.dom.Node}
*/
public T tidyMarkup() {
return dataFormat(new TidyMarkupDataFormat(Node.class));
}
/**
* Uses the XStream data format
*/
public T xstream() {
return dataFormat(new XStreamDataFormat());
}
/**
* Uses the xstream by setting the encoding
*/
public T xstream(String encoding) {
return dataFormat(new XStreamDataFormat(encoding));
}
/**
* Uses the XML Security data format
*/
public T secureXML() {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat();
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, boolean secureTagContents) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, Map<String, String> namespaces, boolean secureTagContents) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, namespaces, secureTagContents);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, boolean secureTagContents, String passPhrase) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents, passPhrase);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, Map<String, String> namespaces, boolean secureTagContents, String passPhrase) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, namespaces, secureTagContents, passPhrase);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents, passPhrase, xmlCipherAlgorithm);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, Map<String, String> namespaces, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, namespaces, secureTagContents, passPhrase, xmlCipherAlgorithm);
return dataFormat(xsdf);
}
/**
* @deprectaed Use {@link #secureXML(String, Map, boolean, String, String, String, String) instead.
* Uses the XML Security data format
*/
@Deprecated
public T secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm,
String keyCipherAlgorithm) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents, recipientKeyAlias, xmlCipherAlgorithm, keyCipherAlgorithm);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm,
String keyCipherAlgorithm, String keyOrTrustStoreParametersId) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents, recipientKeyAlias, xmlCipherAlgorithm,
keyCipherAlgorithm, keyOrTrustStoreParametersId);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm,
String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, secureTagContents, recipientKeyAlias, xmlCipherAlgorithm,
keyCipherAlgorithm, keyOrTrustStoreParameters);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, Map<String, String> namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, namespaces, secureTagContents, recipientKeyAlias, xmlCipherAlgorithm,
keyCipherAlgorithm, keyOrTrustStoreParametersId);
return dataFormat(xsdf);
}
/**
* Uses the XML Security data format
*/
public T secureXML(String secureTag, Map<String, String> namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) {
XMLSecurityDataFormat xsdf = new XMLSecurityDataFormat(secureTag, namespaces, secureTagContents, recipientKeyAlias, xmlCipherAlgorithm,
keyCipherAlgorithm, keyOrTrustStoreParameters);
return dataFormat(xsdf);
}
/**
* Uses the xmlBeans data format
*/
public T xmlBeans() {
return dataFormat(new XMLBeansDataFormat());
}
/**
* Uses the xmljson dataformat, based on json-lib
*/
public T xmljson() {
return dataFormat(new XmlJsonDataFormat());
}
/**
* Uses the xmljson dataformat, based on json-lib, initializing custom options with a Map
*/
public T xmljson(Map<String, String> options) {
return dataFormat(new XmlJsonDataFormat(options));
}
/**
* Uses the ZIP deflater data format
*/
public T zip() {
ZipDataFormat zdf = new ZipDataFormat(Deflater.DEFAULT_COMPRESSION);
return dataFormat(zdf);
}
/**
* Uses the ZIP deflater data format
*/
public T zip(int compressionLevel) {
ZipDataFormat zdf = new ZipDataFormat(compressionLevel);
return dataFormat(zdf);
}
@SuppressWarnings("unchecked")
private T dataFormat(DataFormatDefinition dataFormatType) {
switch (operation) {
case Unmarshal:
return (T) processorType.unmarshal(dataFormatType);
case Marshal:
return (T) processorType.marshal(dataFormatType);
default:
throw new IllegalArgumentException("Unknown DataFormat operation: " + operation);
}
}
}