View Javadoc
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.fork;
20  
21  import javax.annotation.Nonnegative;
22  import javax.annotation.Nonnull;
23  
24  import java.io.File;
25  
26  import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;
27  
28  /**
29   * The properties related to the current JVM.
30   *
31   * @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
32   * @since 3.0.0-M5
33   */
34  public interface ForkNodeArguments {
35      @Nonnull
36      String getSessionId();
37  
38      /**
39       * The index of the forked JVM, from 1 to N.
40       *
41       * @return index of the forked JVM
42       */
43      @Nonnegative
44      int getForkChannelId();
45  
46      @Nonnull
47      File dumpStreamText(@Nonnull String text);
48  
49      @Nonnull
50      File dumpStreamException(@Nonnull Throwable t);
51  
52      void logWarningAtEnd(@Nonnull String text);
53  
54      @Nonnull
55      ConsoleLogger getConsoleLogger();
56  
57      @Nonnull
58      Object getConsoleLock();
59  
60      File getEventStreamBinaryFile();
61  
62      File getCommandStreamBinaryFile();
63  }