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.api.booter;
20
21 import javax.annotation.Nonnull;
22
23 import java.io.IOException;
24
25 /**
26 * An abstraction for physical decoder of commands. The commands are sent from master Maven process and
27 * received by the child forked Surefire process. The session must be open after the MasterProcessChannelDecoderFactory
28 * has created the decoder instance. The session can be closed on the decoder instance.
29 */
30 public interface MasterProcessChannelDecoder extends AutoCloseable {
31 /**
32 * Reads the bytes from a channel, waiting until the command is read completely or
33 * the channel throws {@link java.io.EOFException}.
34 * <br>
35 * This method is called in a single Thread. The constructor can be called within another thread.
36 *
37 * @return decoded command
38 * @throws IOException exception in channel
39 */
40 @Nonnull
41 Command decode() throws IOException;
42
43 @Override
44 void close() throws IOException;
45 }