jdisc_core/src/main/java/com/yahoo/jdisc/service/ClientProvider.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.service;

import com.yahoo.jdisc.Container;
import com.yahoo.jdisc.application.BindingRepository;
import com.yahoo.jdisc.application.ContainerActivator;
import com.yahoo.jdisc.application.ContainerBuilder;
import com.yahoo.jdisc.application.Application;
import com.yahoo.jdisc.application.UriPattern;
import com.yahoo.jdisc.handler.RequestHandler;

/**
 * <p>This interface defines a component that is capable of acting as a client to an external server. To activate a
 * ClientProvider it must be {@link BindingRepository#bind(String, Object) bound} to a {@link UriPattern} within a
 * {@link ContainerBuilder}, and that builder must be {@link ContainerActivator#activateContainer(ContainerBuilder)
 * activated}.</p>
 *
 * @author Simon Thoresen Hult
 */
public interface ClientProvider extends RequestHandler {

    /**
     * <p>This is a synchronous method to configure this ClientProvider. The {@link Container} does <em>not</em> call
     * this method, instead it is a required step in the {@link Application} initialization code.</p>
     */
    void start();

}