com.yelstream.topp.standard.net.SocketScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of topp-standard-core Show documentation
Topp Standard Core addressing basics of Java SE.
The newest version!
/*
 * Project: Topp Standard
 * GitHub: https://github.com/sabroe/Topp-Standard
 *
 * Copyright 2024 Morten Sabroe Mortensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.yelstream.topp.standard.net;

import com.yelstream.topp.standard.io.Printable;
import com.yelstream.topp.standard.util.concurrent.CompletableFutures;
import com.yelstream.topp.standard.util.concurrent.ManagedExecutor;
import com.yelstream.topp.standard.util.function.ex.SupplierWithException;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executors;
import java.util.function.Supplier;
import java.util.stream.IntStream;

/**
 * Scans and tests for occupied and available sockets within a range of ports.
 * 
 *     Note that this has been setup to be able to scan repeatedly.
 * 
 *
 * @author Morten Sabroe Mortensen
 * @version 1.0
 * @since 2024-07-05
 */
@lombok.Builder(builderClassName="Builder",toBuilder=true)
@AllArgsConstructor
@Slf4j
public class SocketScanner {
    /**
     * Suppliers of internet addresses.
     */
    @lombok.Singular
    private final List> addressSuppliers;

    /**
     * Supplier of port range to scan.
     */
    @lombok.Builder.Default
    private final Supplier ports=()->IntStream.range(0,65536);

    /**
     * Connectivity timeout per individual port.
     */
    @lombok.Builder.Default
    private final Duration timeout=Duration.ofMillis(2000);

    /**
     * Source of executor.
     * In normal situations, this should be left at its default.
     */
    @lombok.Builder.Default
    private final Supplier executorSupplier=()->ManagedExecutor.of(Executors.newVirtualThreadPerTaskExecutor());

    @Getter
    @ToString
    @AllArgsConstructor(staticName="of")
    @lombok.Builder(builderClassName="Builder")
    public static class Result implements Printable {

        @lombok.Singular
        private final List scans;

        @Getter
        @ToString
        @AllArgsConstructor(staticName="of")
        @lombok.Builder(builderClassName="Builder")
        public static class Scan {
            private final InetAddress address;

            @lombok.Singular
            private final List portStatuses;

            @Getter
            @ToString
            @AllArgsConstructor(staticName="of")
            @lombok.Builder(builderClassName="Builder")
            public static class PortStatus {
                private final int port;
                private final boolean success;
            }
        }

        @Override
        public void print(PrintStream out) {
            int scanIndex=1;
            for (var scan: scans) {
                out.printf("%3d Address %s:%n",scanIndex,scan.getAddress());
                int portStatusIndex=1;
                for (var portStatus: scan.portStatuses) {
                    out.printf("    %3d     %s%n",portStatusIndex,portStatus.getPort());
                    portStatusIndex++;
                }
                scanIndex++;
            }
        }
    }

    @SuppressWarnings({"java:S2583","ConstantConditions","java:S1117"})
    public Result scan() {
        log.atDebug().setMessage("Start scan.").log();
        try {
            Result.Builder resultBuilder=Result.builder();

            try (ManagedExecutor executor=executorSupplier.get()) {
                for (var addressSupplier: addressSuppliers) {
                    InetAddress address=addressSupplier.get();
                    log.atDebug().setMessage("Start scan of address {}.").addArgument(address).log();

                    log.atDebug().setMessage("Stop scan.").log();

                    Result.Scan.Builder scanBuilder=Result.Scan.builder();

                    scanBuilder.address(address);

                    List> futures=
                        ports.get().mapToObj(port -> {
                            return Sockets.TestConnects.withDetailedConnectResult(Sockets.ConnectParameter.of(new InetSocketAddress(address, port), timeout), executor);
                            //TO-DO: Note that both 'Sockets' AND 'ServerSockets' have applicable tests; to be resolved!
                        }).toList();

                    CompletableFuture> allFutures=CompletableFutures.allOf(futures);
                    List results =
                        allFutures.thenApply(v -> v.stream().filter(r -> r != null && r.success()).toList()).join();

                    List portStatuses=
                        results.stream().map(result -> {
                            return Result.Scan.PortStatus.of(SocketAddresses.getInetSocketAddress(result.getConnectParameter().getEndpoint()).getPort(), result.success());
                        }).toList();
                    scanBuilder.portStatuses(portStatuses);

                    Result.Scan scan=scanBuilder.build();
                    resultBuilder.scan(scan);
                    log.atDebug().setMessage("Stop scan of address {}.").addArgument(address).log();
                }
            } catch (IOException ex) {
                throw new IllegalStateException("Failure to scan!", ex);
            }
            return resultBuilder.build();
        } finally {
            log.atDebug().setMessage("Stop scan.").log();
        }
    }
}