1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.surefire.spi;
20
21 import javax.annotation.Nonnull;
22
23 import java.io.Closeable;
24 import java.io.IOException;
25
26 import org.apache.maven.surefire.api.booter.MasterProcessChannelDecoder;
27 import org.apache.maven.surefire.api.booter.MasterProcessChannelEncoder;
28 import org.apache.maven.surefire.api.fork.ForkNodeArguments;
29
30 /**
31 * The SPI interface, a factory of an encoder and a decoder.
32 */
33 public interface MasterProcessChannelProcessorFactory extends Closeable {
34 /**
35 * Evaluates the {@code channelConfig}.
36 *
37 * @param channelConfig a connection string used by the fork JVM
38 * @return {@code true} if {@code channelConfig} is applicable and thus this SPI is eligible in the fork
39 */
40 boolean canUse(String channelConfig);
41
42 /**
43 * Open a new connection.
44 *
45 * @param channelConfig e.g. "pipe://3" or "tcp://localhost:65035"
46 * @throws IOException if cannot connect
47 */
48 void connect(String channelConfig) throws IOException;
49
50 /**
51 * Decoder factory method.
52 * @param forkingArguments forking arguments
53 * @return a new instance of decoder
54 */
55 MasterProcessChannelDecoder createDecoder(@Nonnull ForkNodeArguments forkingArguments) throws IOException;
56
57 /**
58 * Encoder factory method.
59 * @param forkingArguments forking arguments
60 * @return a new instance of encoder
61 */
62 MasterProcessChannelEncoder createEncoder(@Nonnull ForkNodeArguments forkingArguments) throws IOException;
63 }