001/*
002 * Copyright 2017-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2017-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2017-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.util.ssl.cert;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class defines the parent class for a decoded private key that may appear
051 * in a PKCS #8 private key object.
052 */
053@NotExtensible()
054@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
055public abstract class DecodedPrivateKey
056       implements Serializable
057{
058  /**
059   * The serial version UID for this serializable class.
060   */
061  private static final long serialVersionUID = 2801676658381861675L;
062
063
064
065  /**
066   * Retrieves a string representation of this decoded private key.
067   *
068   * @return  A string representation of this decoded private key.
069   */
070  @Override()
071  @NotNull()
072  public final String toString()
073  {
074    final StringBuilder buffer = new StringBuilder();
075    toString(buffer);
076    return buffer.toString();
077  }
078
079
080
081  /**
082   * Appends a string representation of this decoded private key to the provided
083   * buffer.
084   *
085   * @param  buffer  The buffer to which the information should be appended.
086   */
087  public abstract void toString(@NotNull StringBuilder buffer);
088}