Package org.cryptacular.pem

Class Descriptor

java.lang.Object

org.cryptacular.pem.Descriptor

public final class Descriptor
extends Object

Descriptor for PemObject

Field Summary

Fields

Modifier and Type	Field	Description
private String	explanatoryText	Explanatory text prior to the encapsulation header as defined by RFC 7468 Section 5.2
private final Format	format	The RFC PEM specification which governs the format of this PEM object.
private final String	type	The type of this PEM encoded data (i.e.

Constructor Summary

Constructors

Constructor	Description
Descriptor(Format formatParam, String explanatoryTextParam, String typeParam)	Constructor with RFC format and explanatory text.

Method Summary

Modifier and Type	Method	Description
String	getExplanatoryText()
Format	getFormat()
String	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

format

private final Format format

The RFC PEM specification which governs the format of this PEM object.

type

private final String type

The type of this PEM encoded data (i.e. PUBLIC KEY).

explanatoryText

private String explanatoryText

Explanatory text prior to the encapsulation header as defined by RFC 7468 Section 5.2

Constructor Details

Descriptor

public Descriptor(Format formatParam,
 String explanatoryTextParam,
 String typeParam)

Constructor with RFC format and explanatory text.

Parameters:

formatParam - RFC governing PEM format

explanatoryTextParam - Explanatory text if applicable

typeParam - Data type

Method Details

getFormat

public Format getFormat()

Returns:

The RFC Format governing this PEM data.

getType

public String getType()

Returns:

The encoded data type

getExplanatoryText

public String getExplanatoryText()

Returns:

The explanatory text included with this PEM as defined by RFC-7468 5.2 null is returned if this PEM file is not of Format.RFC7468