com.linecorp.armeria.spring.ThriftServiceRegistrationBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of armeria-spring-boot1-autoconfigure-shaded Show documentation

Asynchronous HTTP/2 RPC/REST client/server library built on top of Java 8, Netty, Thrift and gRPC (armeria-spring-boot1-autoconfigure-shaded)

There is a newer version: 0.75.0

Show newest version

/*
 * Copyright 2017 LINE Corporation
 *
 * LINE Corporation 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:
 *
 *   https://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 com.linecorp.armeria.spring;

import java.util.ArrayList;
import java.util.Collection;

import javax.validation.constraints.NotNull;

import org.apache.thrift.TBase;

import com.linecorp.armeria.common.HttpHeaders;
import com.linecorp.armeria.common.HttpRequest;
import com.linecorp.armeria.common.HttpResponse;
import com.linecorp.armeria.server.Service;
import com.linecorp.armeria.server.docs.DocService;

/**
 * A bean with information for registering a thrift service. Enables micrometer
 * monitoring of the service and registers sample requests for use in {@link DocService}.
 * {@code
 * > @Bean
 * > public ThriftServiceRegistrationBean okService() {
 * >     return new ThriftServiceRegistrationBean()
 * >             .setServiceName("myThriftService")
 * >             .setPath("/my_service")
 * >             .setService(new MyThriftService())
 * >             .setDecorators(LoggingService.newDecorator())
 * >             .setExampleHeaders(ImmutableList.of(HttpHeaders.of(AUTHORIZATION, "bearer b03c4fed1a")))
 * >             .setExampleRequests(ImmutableList.of(new MyThriftService.hello_args("Armeria")))
 * > }
 * }
 */
public class ThriftServiceRegistrationBean
        extends
        AbstractServiceRegistrationBean, ThriftServiceRegistrationBean> {

    /**
     * The url path to register the service at. If not specified, defaults to {@code /api}.
     */
    @NotNull
    private String path = "/api";

    /**
     * Sample requests to populate debug forms in {@link DocService}.
     * This should be a list of request objects (e.g., methodName_args) which correspond to methods
     * in this thrift service.
     */
    @NotNull
    private Collection> exampleRequests = new ArrayList<>();

    /**
     * Example {@link HttpHeaders} being used in debug forms.
     */
    @NotNull
    private Collection exampleHeaders = new ArrayList<>();

    /**
     * Returns the url path this service map to.
     */
    @NotNull
    public String getPath() {
        return path;
    }

    /**
     * Register the url path this service map to.
     */
    public ThriftServiceRegistrationBean setPath(@NotNull String path) {
        this.path = path;
        return this;
    }

    /**
     * Returns sample requests of {@link #getService()}.
     */
    @NotNull
    public Collection> getExampleRequests() {
        return exampleRequests;
    }

    /**
     * Sets sample requests for {@link #getService()}.
     */
    public ThriftServiceRegistrationBean setExampleRequests(
            @NotNull Collection> exampleRequests) {
        this.exampleRequests = exampleRequests;
        return this;
    }

    /**
     * Returns example {@link HttpHeaders}.
     */
    @NotNull
    public Collection getExampleHeaders() {
        return exampleHeaders;
    }

    /**
     * Sets example {@link HttpHeaders}.
     */
    public ThriftServiceRegistrationBean setExampleHeaders(@NotNull Collection exampleHeaders) {
        this.exampleHeaders = exampleHeaders;
        return this;
    }
}