com.tangosol.net.ssl.AbstractPrivateKeyLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.09
/*
 * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.net.ssl;

import com.tangosol.internal.net.ssl.PemReader;
import com.tangosol.net.PasswordProvider;

import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;

import java.security.GeneralSecurityException;
import java.security.PrivateKey;

import java.util.Objects;

/**
 * A base class for {@link PrivateKeyLoader} implementations.
 *
 * @author Jonathan Knight  2020.01.25
 * @since 22.06
 */
public abstract class AbstractPrivateKeyLoader
        implements PrivateKeyLoader
    {
    // ----- constructors ---------------------------------------------------

    /**
     * Create a {@link AbstractPrivateKeyLoader}.
     *
     * @param sName  the name of the private key to load
     */
    protected AbstractPrivateKeyLoader(String sName)
        {
        m_sName = sName;
        }

    // ----- PrivateKeyLoader methods ---------------------------------------

    @Override
    public PrivateKey load(PasswordProvider provider) throws GeneralSecurityException, IOException
        {
        InputStream in = getInputStream();
        return in == null ? null : PemReader.readPrivateKey(in, provider);
        }

    /**
     * Return the name of the private ky to load.
     *
     * @return the name of the private ky to load
     */
    public String getName()
        {
        return m_sName;
        }

    /**
     * Open an {@link InputStream} for the specified named resource, which should
     * be the contents of a Java {@link PrivateKey} in the format required by this
     * {@link PrivateKeyLoader} implementation.
     * 
     * How the {@link InputStream} is created based on the name is purely dependent
     * on how subclasses are implemented. For example, the name could be a URL, or
     * it could refer to a name of a secret in some secrets store, etc.
     *
     * @return an {@link InputStream} containing the named resource contents,
     *         or {@code null} if no {@link InputStream} could be opened
     *
     * @throws IOException if an error occurs creating the {@link InputStream}
     */
    protected abstract InputStream getInputStream() throws IOException;

    // ----- Object methods -------------------------------------------------

    @Override
    public boolean equals(Object o)
        {
        if (this == o)
            {
            return true;
            }
        if (o == null || getClass() != o.getClass())
            {
            return false;
            }
        AbstractPrivateKeyLoader that = (AbstractPrivateKeyLoader) o;
        return Objects.equals(m_sName, that.m_sName);
        }

    @Override
    public int hashCode()
        {
        return Objects.hash(m_sName);
        }

    @Override
    public String toString()
        {
        return m_sName;
        }

    // ----- helper methods -------------------------------------------------

    /**
     * Close the specified {@link Closeable}, ignoring any errors or the fact that
     * the {@link Closeable} may be {@code null}.
     * 
     * Any exception thrown calling {@link Closeable#close()} will be ignored.
     *
     * @param closeable  the {@link Closeable} to close
     */
    protected void safeClose(Closeable closeable)
        {
        try
            {
            if (closeable != null)
                {
                closeable.close();
                }
            }
        catch (IOException e)
            {
            // ignored
            }
        }

    // ----- data members ---------------------------------------------------

    /**
     * The name of the private key to load.
     */
    protected final String m_sName;
    }