Class PemValue

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.ssl.PemValue

All Implemented Interfaces:

ByteBufHolder, PemEncoded, ReferenceCounted

class PemValue
extends AbstractReferenceCounted
implements PemEncoded

A PEM encoded value.

See Also:

• PemEncoded
• PemPrivateKey.toPEM(ByteBufAllocator, boolean, java.security.PrivateKey)
• PemX509Certificate.toPEM(ByteBufAllocator, boolean, java.security.cert.X509Certificate[])

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuf	content
private final boolean	sensitive

Constructor Summary

Constructors

Constructor	Description
PemValue(ByteBuf content, boolean sensitive)

Method Summary

Modifier and Type	Method	Description
ByteBuf	content()	Return the data which is held by this ByteBufHolder.
PemValue	copy()	Creates a deep copy of this ByteBufHolder.
protected void	deallocate()	Called once AbstractReferenceCounted.refCnt() is equals 0.
PemValue	duplicate()	Duplicates this ByteBufHolder.
boolean	isSensitive()	Returns true if the PEM encoded value is considered sensitive information such as a private key.
PemValue	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
PemValue	retain()	Increases the reference count by 1.
PemValue	retain(int increment)	Increases the reference count by the specified increment.
PemValue	retainedDuplicate()	Duplicates this ByteBufHolder.
PemValue	touch()	Records the current access location of this object for debugging purposes.
PemValue	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

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

Methods inherited from interface ReferenceCounted

refCnt, release, release

Field Details

content

private final ByteBuf content

sensitive

private final boolean sensitive

Constructor Details

PemValue

PemValue(ByteBuf content,
 boolean sensitive)

Method Details

isSensitive

public boolean isSensitive()

Description copied from interface: PemEncoded

Returns true if the PEM encoded value is considered sensitive information such as a private key.

Specified by:

isSensitive in interface PemEncoded

content

public ByteBuf content()

Description copied from interface: ByteBufHolder

Return the data which is held by this ByteBufHolder.

Specified by:

content in interface ByteBufHolder

copy

public PemValue copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface PemEncoded

duplicate

public PemValue duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface PemEncoded

retainedDuplicate

public PemValue retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface PemEncoded

See Also:

• ByteBuf.retainedDuplicate()

replace

public PemValue replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface PemEncoded

touch

public PemValue touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface PemEncoded

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public PemValue touch(java.lang.Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface PemEncoded

Specified by:

touch in interface ReferenceCounted

retain

public PemValue retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface PemEncoded

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public PemValue retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface PemEncoded

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted