BindMessage.java

/*
 * Copyright 2019 Providence Authors
 *
 * 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 net.morimekta.proto.jdbi.v3.annotations;

import com.google.protobuf.Message;
import net.morimekta.proto.jdbi.MorimektaJdbiOptions.SqlType;
import net.morimekta.proto.jdbi.v3.util.MessageNamedArgumentFinder;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizingAnnotation;
import org.jdbi.v3.sqlobject.customizer.SqlStatementParameterCustomizer;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.lang.reflect.Type;
import java.sql.Types;

/**
 * Bind a message as a single value, either encoding as binary ({@code VARBINARY} using its normal binary
 * encoding) and as strings ({@code VARCHAR}, using standard ASCII or UTF-8 encoding).
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@SqlStatementCustomizingAnnotation(BindMessage.Factory.class)
public @interface BindMessage {
    String value() default "";

    /**
     * When serializing the message (itself), serialize it as this SQL type.
     * See {@link Types} and {@link SqlType}
     *
     * @return The SQL type to serialize the message as.
     */
    SqlType type() default SqlType.BLOB;

    class Factory implements SqlStatementCustomizerFactory {
        @Override
        public SqlStatementParameterCustomizer createForParameter(
                Annotation annotation,
                Class<?> sqlObjectType,
                Method method,
                Parameter param,
                int index,
                Type paramType) {
            if (!(paramType instanceof Class)) {
                throw new IllegalArgumentException(
                        paramType.getTypeName() + " is not a message type");
            }
            @SuppressWarnings("rawtypes")
            Class<?> paramClass = (Class) paramType;
            if (!Message.class.isAssignableFrom(paramClass)) {
                throw new IllegalArgumentException(
                        paramClass.getName() + " is not a message class");
            }

            BindMessage bind = (BindMessage) annotation;
            return (stmt, arg) -> stmt.bindNamedArgumentFinder(
                    new MessageNamedArgumentFinder(bind.value(), index, bind.type(), (Message) arg));
        }
    }
}