Netty 4.1.107.Final · io.netty.handler.ssl.PemPrivateKey

Modifier and Type	Field and Description
private static final byte[]	BEGIN_PRIVATE_KEY
private final ByteBuf	content
private static final byte[]	END_PRIVATE_KEY
private static final String	PKCS8_FORMAT
private static final long	serialVersionUID Hides java.security.PrivateKey.serialVersionUID.

Access	Constructor and Description
private	PemPrivateKey(ByteBuf content)

Method Summary

Modifier and Type	Method and Description
public ByteBuf	content() Implements io.netty.buffer.ByteBufHolder.content. Return the data which is held by this `ByteBufHolder`.
public PemPrivateKey	copy() Implements io.netty.handler.ssl.PemEncoded.copy. Creates a deep copy of this `ByteBufHolder`.
protected void	deallocate() Implements abstract io.netty.util.AbstractReferenceCounted.deallocate. Called once `refCnt()` is equals 0.
public void	destroy() Overrides default javax.security.auth.Destroyable.destroy. Note This is a JDK8 interface/method.
public PemPrivateKey	duplicate() Implements io.netty.handler.ssl.PemEncoded.duplicate. Duplicates this `ByteBufHolder`.
public String	getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the standard algorithm name for this key.
public byte[]	getEncoded() Implements java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding.
public String	getFormat() Implements java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding.
public boolean	isDestroyed() Overrides default javax.security.auth.Destroyable.isDestroyed. Note This is a JDK8 interface/method.
public boolean	isSensitive() Implements io.netty.handler.ssl.PemEncoded.isSensitive. Returns `true` if the PEM encoded value is considered sensitive information such as a private key.
public PemPrivateKey	replace(ByteBuf content) Implements io.netty.handler.ssl.PemEncoded.replace. Returns a new `ByteBufHolder` which contains the specified `content`.
public PemPrivateKey	retain() Overrides io.netty.util.AbstractReferenceCounted.retain. Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain. Increases the reference count by `1`.
public PemPrivateKey	retain(int increment) Overrides io.netty.util.AbstractReferenceCounted.retain. Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain. Increases the reference count by the specified `increment`.
public PemPrivateKey	retainedDuplicate() Implements io.netty.handler.ssl.PemEncoded.retainedDuplicate. Duplicates this `ByteBufHolder`.
pack-priv static PemEncoded	toPEM(ByteBufAllocator allocator, boolean useDirect, PrivateKey key) Creates a `PemEncoded` value from the `PrivateKey`.
pack-priv static PemEncoded	toPEM(ByteBufAllocator allocator, boolean useDirect, byte[] bytes)
public PemPrivateKey	touch() Overrides io.netty.util.AbstractReferenceCounted.touch. Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch. Records the current access location of this object for debugging purposes.
public PemPrivateKey	touch(Object hint) Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch. Records the current access location of this object with an additional arbitrary information for debugging purposes.
public static PemPrivateKey	valueOf(byte[] key) Creates a `PemPrivateKey` from raw `byte[]`.
public static PemPrivateKey	valueOf(ByteBuf key) Creates a `PemPrivateKey` from raw `ByteBuf`.

Inherited from io.netty.util.AbstractReferenceCounted:: refCnt release release setRefCnt

BEGIN_PRIVATE_KEY	back to summary
private static final byte[] BEGIN_PRIVATE_KEY

content	back to summary
private final ByteBuf content

END_PRIVATE_KEY	back to summary
private static final byte[] END_PRIVATE_KEY

PKCS8_FORMAT	back to summary
private static final String PKCS8_FORMAT

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.PrivateKey.serialVersionUID.

PemPrivateKey	back to summary
private PemPrivateKey(ByteBuf content)

Method Detail

content back to summary

content	back to summary
public ByteBuf content() Implements io.netty.buffer.ByteBufHolder.content. Doc from io.netty.buffer.ByteBufHolder.content. Return the data which is held by this `ByteBufHolder`. Annotations @Override

public ByteBuf content()

Implements io.netty.buffer.ByteBufHolder.content.

Doc from io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.

Annotations

@Override

copy back to summary

copy	back to summary
public PemPrivateKey copy() Implements io.netty.handler.ssl.PemEncoded.copy. Doc from io.netty.buffer.ByteBufHolder.copy. Creates a deep copy of this `ByteBufHolder`. Annotations @Override

public PemPrivateKey copy()

Implements io.netty.handler.ssl.PemEncoded.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations

@Override

deallocate back to summary

deallocate	back to summary
protected void deallocate() Implements abstract io.netty.util.AbstractReferenceCounted.deallocate. Doc from io.netty.util.AbstractReferenceCounted.deallocate. Called once `refCnt()` is equals 0. Annotations @Override

protected void deallocate()

Implements abstract io.netty.util.AbstractReferenceCounted.deallocate.

Doc from io.netty.util.AbstractReferenceCounted.deallocate.

Called once refCnt() is equals 0.

Annotations

@Override

destroy back to summary

destroy	back to summary
public void destroy() Overrides default javax.security.auth.Destroyable.destroy. Note This is a JDK8 interface/method. Due to backwards compatibility reasons it's not possible to slap the `@Override` annotation onto this method. Annotations @Override See Also `Destroyable#destroy()`

public void destroy()

Overrides default javax.security.auth.Destroyable.destroy.

Note

This is a JDK8 interface/method. Due to backwards compatibility reasons it's not possible to slap the @Override annotation onto this method.

Annotations

@Override

See Also

Destroyable#destroy()

duplicate back to summary

duplicate	back to summary
public PemPrivateKey duplicate() Implements io.netty.handler.ssl.PemEncoded.duplicate. Doc from io.netty.buffer.ByteBufHolder.duplicate. Duplicates this `ByteBufHolder`. Be aware that this will not automatically call `retain()`. Annotations @Override

public PemPrivateKey duplicate()

Implements io.netty.handler.ssl.PemEncoded.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

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

Annotations

@Override

getAlgorithm	back to summary
public String getAlgorithm() Implements java.security.Key.getAlgorithm. Doc from java.security.Key.getAlgorithm. Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names. Returns:String the name of the algorithm associated with this key. Annotations @Override

getAlgorithm

back to summary

public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String

the name of the algorithm associated with this key.

Annotations

@Override

getEncoded back to summary

getEncoded	back to summary
public byte[] getEncoded() Implements java.security.Key.getEncoded. Doc from java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding. Returns:byte[] the encoded key, or `null` if the key does not support encoding. Annotations @Override

public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]

the encoded key, or null if the key does not support encoding.

Annotations

@Override

getFormat back to summary

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Doc from java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is `"X.509"`. Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is `"PKCS#8"`. Returns:String the primary encoding format of the key. Annotations @Override

public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Returns:String

the primary encoding format of the key.

Annotations

@Override

isDestroyed back to summary

isDestroyed	back to summary
public boolean isDestroyed() Overrides default javax.security.auth.Destroyable.isDestroyed. Note This is a JDK8 interface/method. Due to backwards compatibility reasons it's not possible to slap the `@Override` annotation onto this method. Returns:boolean Doc from javax.security.auth.Destroyable.isDestroyed. true if this `Object` has been destroyed, false otherwise. Annotations @Override See Also `Destroyable#isDestroyed()`

public boolean isDestroyed()

Overrides default javax.security.auth.Destroyable.isDestroyed.

Note

This is a JDK8 interface/method. Due to backwards compatibility reasons it's not possible to slap the @Override annotation onto this method.

Returns:boolean

Doc from javax.security.auth.Destroyable.isDestroyed.

true if this Object has been destroyed, false otherwise.

Annotations

@Override

See Also

Destroyable#isDestroyed()

isSensitive back to summary

isSensitive	back to summary
public boolean isSensitive() Implements io.netty.handler.ssl.PemEncoded.isSensitive. Doc from io.netty.handler.ssl.PemEncoded.isSensitive. Returns `true` if the PEM encoded value is considered sensitive information such as a private key. Annotations @Override

public boolean isSensitive()

Implements io.netty.handler.ssl.PemEncoded.isSensitive.

Doc from io.netty.handler.ssl.PemEncoded.isSensitive.

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

Annotations

@Override

replace back to summary

replace	back to summary
public PemPrivateKey replace(ByteBuf content) Implements io.netty.handler.ssl.PemEncoded.replace. Doc from io.netty.buffer.ByteBufHolder.replace. Returns a new `ByteBufHolder` which contains the specified `content`. Annotations @Override

public PemPrivateKey replace(ByteBuf content)

Implements io.netty.handler.ssl.PemEncoded.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations

@Override

retain back to summary

retain	back to summary
public PemPrivateKey retain() Overrides io.netty.util.AbstractReferenceCounted.retain. Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain. Doc from io.netty.util.ReferenceCounted.retain. Increases the reference count by `1`. Annotations @Override

public PemPrivateKey retain()

Overrides io.netty.util.AbstractReferenceCounted.retain.

Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations

@Override

retain back to summary

retain	back to summary
public PemPrivateKey retain(int increment) Overrides io.netty.util.AbstractReferenceCounted.retain. Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain. Doc from io.netty.util.ReferenceCounted.retain. Increases the reference count by the specified `increment`. Annotations @Override

public PemPrivateKey retain(int increment)

Overrides io.netty.util.AbstractReferenceCounted.retain.

Implements io.netty.handler.ssl.PemEncoded.retain, io.netty.util.ReferenceCounted.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations

@Override

retainedDuplicate back to summary

retainedDuplicate	back to summary
public PemPrivateKey retainedDuplicate() Implements io.netty.handler.ssl.PemEncoded.retainedDuplicate. Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate. Duplicates this `ByteBufHolder`. This method returns a retained duplicate unlike `duplicate()`. Annotations @Override

public PemPrivateKey retainedDuplicate()

Implements io.netty.handler.ssl.PemEncoded.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

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

Annotations

@Override

toPEM	back to summary
pack-priv static PemEncoded toPEM(ByteBufAllocator allocator, boolean useDirect, PrivateKey key) Creates a `PemEncoded` value from the `PrivateKey`.

toPEM	back to summary
pack-priv static PemEncoded toPEM(ByteBufAllocator allocator, boolean useDirect, byte[] bytes)

touch back to summary

touch	back to summary
public PemPrivateKey touch() Overrides io.netty.util.AbstractReferenceCounted.touch. Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch. Doc from io.netty.util.ReferenceCounted.touch. 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)`. Annotations @Override

public PemPrivateKey touch()

Overrides io.netty.util.AbstractReferenceCounted.touch.

Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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).

Annotations

@Override

touch back to summary

touch	back to summary
public PemPrivateKey touch(Object hint) Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch. Doc from io.netty.util.ReferenceCounted.touch. 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`. Annotations @Override

public PemPrivateKey touch(Object hint)

Implements io.netty.handler.ssl.PemEncoded.touch, io.netty.util.ReferenceCounted.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations

@Override

valueOf	back to summary
public static PemPrivateKey valueOf(byte[] key) Creates a `PemPrivateKey` from raw `byte[]`. ATTENTION: It's assumed that the given argument is a PEM/PKCS#8 encoded value. No input validation is performed to validate it.

valueOf	back to summary
public static PemPrivateKey valueOf(ByteBuf key) Creates a `PemPrivateKey` from raw `ByteBuf`. ATTENTION: It's assumed that the given argument is a PEM/PKCS#8 encoded value. No input validation is performed to validate it.

public final Class PemPrivateKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail