ThriftServiceRegistrationBean.java

/*
 * 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:
 *
 *   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 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.server.Service;
import com.linecorp.armeria.server.docs.DocService;

/**
 * A bean with information for registering a thrift service. Enables Dropwizard
 * monitoring of the service and registers sample requests for use in
 * {@link DocService}.
 */
public class ThriftServiceRegistrationBean {

    /**
     * The thrift service to register.
     */
    @NotNull
    private Service<?, ?> service;

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

    /**
     * A service name to use in monitoring. Metrics will be exported prefixed by
     * 'server.serviceName.methodName`.
     */
    @NotNull
    private String serviceName;

    /**
     * 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.
     */
    private Collection<? extends TBase<?, ?>> exampleRequests = new ArrayList<>();

    /**
     * Returns the thrift {@link Service} that is registered to this bean.
     */
    public Service<?, ?> getService() {
        return service;
    }

    /**
     * Register the thrift {@link Service} to this bean.
     */
    public ThriftServiceRegistrationBean setService(Service<?, ?> service) {
        this.service = service;
        return this;
    }

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

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

    /**
     * Returns the service name to use in monitoring.
     */
    public String getServiceName() {
        return serviceName;
    }

    /**
     * Register the service name to use in monitoring.
     */
    public ThriftServiceRegistrationBean setServiceName(String serviceName) {
        this.serviceName = serviceName;
        return this;
    }

    /**
     * Returns sample requests of {@link #getService()}.
     */
    public Collection<? extends TBase<?, ?>> getExampleRequests() {
        return exampleRequests;
    }

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