tech.sirwellington.alchemy.arguments.assertions.NetworkAssertions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemy-arguments Show documentation

Part of the Alchemy Collection. Easy, Simple, and Robust argument checking logic for your Services, Libraries, and Scripts.

There is a newer version: 2.3

Show newest version

 /*
  * Copyright 2016 Aroma Tech.
  *
  * 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 tech.sirwellington.alchemy.arguments.assertions;

import java.net.URL;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tech.sirwellington.alchemy.annotations.access.NonInstantiable;
import tech.sirwellington.alchemy.arguments.AlchemyAssertion;
import tech.sirwellington.alchemy.arguments.FailedAssertionException;

import static tech.sirwellington.alchemy.arguments.assertions.StringAssertions.nonEmptyString;

/**
 *
 * @author SirWellington
 */
@NonInstantiable
public final class NetworkAssertions
{
    
    private final static Logger LOG = LoggerFactory.getLogger(NetworkAssertions.class);
    
    /** The maximum allowable Port number */
    private static final int MAX_PORT = 65535;
    
    NetworkAssertions() throws IllegalAccessException
    {
        throw new IllegalAccessException("cannot instantiate");
    }
    
    /**
     * Checks that a URL is valid, according to the {@link URL} class.
     * 
     * @return 
     */
    public static AlchemyAssertion validURL()
    {
        return string ->
        {
            nonEmptyString().check(string);
            
            try
            {
                URL url = new URL(string);
            }
            catch (Exception ex)
            {
                throw new FailedAssertionException("Invalid URL: " + string, ex);
            }
        };
    }
    
    
    /**
     * Asserts that a Port number is valid and acceptable.
     * 
     * @return 
     * @see https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers
     */
    public static AlchemyAssertion validPort()
    {
        return port ->
        {
            if (port <= 0)
            {
                throw new FailedAssertionException("Network port must be > 0");
            }
            
            if (port > MAX_PORT)
            {
                throw new FailedAssertionException("Network port must <" + MAX_PORT);
            }
        };
    }
}