org.apache.camel.component.jpa.JpaConstants Maven / Gradle / Ivy

Go to download
/*
 * 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.component.jpa;

import org.apache.camel.spi.Metadata;

/**
 * JPA constants
 */
public final class JpaConstants {

    @Metadata(description = "The JPA `EntityManager` object.", javaType = "jakarta.persistence.EntityManager")
    public static final String ENTITY_MANAGER = "CamelEntityManager";
    @Metadata(label = "producer", description = "Alternative way for passing query parameters as an Exchange header.",
              javaType = "Map")
    public static final String JPA_PARAMETERS_HEADER = "CamelJpaParameters";
    @Metadata(label = "producer", description = "Defines the maximum number of results to retrieve on the query; " +
                                                "takes precedence over the value set on the endpoint, if any.")
    public static final String JPA_MAXIMUM_RESULTS = "CamelJpaMaximumResults";
    @Metadata(label = "producer", description = "Defines the position of the first result to retrieve; " +
                                                "takes precedence over the value set on the endpoint, if any.")
    public static final String JPA_FIRST_RESULT = "CamelJpaFirstResult";

    /**
     * @deprecated use {@link #ENTITY_MANAGER}
     */
    @Deprecated
    public static final String ENTITYMANAGER = ENTITY_MANAGER;

    private JpaConstants() {
        // utility class
    }

}