1 package org.apache.maven.plugin.surefire.booterclient.lazytestprovider;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.surefire.api.booter.Shutdown;
23
24 /**
25 * Remote interface of forked JVM with command methods.
26 * <br>
27 * Implemented by {@link TestProvidingInputStream} and {@link TestLessInputStream} where the method
28 * {@link TestLessInputStream#provideNewTest()} purposefully does nothing. Some methods in
29 * {@link org.apache.maven.plugin.surefire.booterclient.lazytestprovider.TestLessInputStream.TestLessInputStreamBuilder}
30 * throw {@link UnsupportedOperationException}.
31 *
32 * @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
33 * @since 2.19
34 * @see TestProvidingInputStream
35 * @see TestLessInputStream
36 */
37 public interface NotifiableTestStream
38 {
39 /**
40 * Forked jvm notifies master process to provide a new test.
41 * <br>
42 * Notifies {@link TestProvidingInputStream} in order to dispatch a new test back to the forked
43 * jvm (particular fork which hits this call); or do nothing in {@link TestLessInputStream}.
44 */
45 void provideNewTest();
46
47 /**
48 * Sends an event to a fork jvm in order to skip tests.
49 * Returns immediately without blocking.
50 */
51 void skipSinceNextTest();
52
53 void shutdown( Shutdown shutdownType );
54
55 void noop();
56
57 void acknowledgeByeEventReceived();
58 }