PemPrivateKey (Netty API Reference (4.1.115.Final))

java.lang.Object
- io.netty.util.AbstractReferenceCounted
- - io.netty.handler.ssl.PemPrivateKey

All Implemented Interfaces:

ReferenceCounted, Serializable, Key, PrivateKey, Destroyable
```
public final class PemPrivateKey
extends AbstractReferenceCounted
implements PrivateKey
```
This is a special purpose implementation of a PrivateKey which allows the user to pass PEM/PKCS#8 encoded key material straight into OpenSslContext without having to parse and re-encode bytes in Java land. All methods other than what's implemented in PemEncoded and Destroyable throw UnsupportedOperationExceptions.

See Also:

PemEncoded, OpenSslContext, valueOf(byte[]), valueOf(ByteBuf), Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuf`	`content()` Return the data which is held by this `ByteBufHolder`.
`PemPrivateKey`	`copy()` Creates a deep copy of this `ByteBufHolder`.
`protected void`	`deallocate()` Called once `AbstractReferenceCounted.refCnt()` is equals 0.
`void`	`destroy()` NOTE: This is a JDK8 interface/method.
`PemPrivateKey`	`duplicate()` Duplicates this `ByteBufHolder`.
`String`	`getAlgorithm()`
`byte[]`	`getEncoded()`
`String`	`getFormat()`
`boolean`	`isDestroyed()` NOTE: This is a JDK8 interface/method.
`boolean`	`isSensitive()` Returns `true` if the PEM encoded value is considered sensitive information such as a private key.
`PemPrivateKey`	`replace(ByteBuf content)` Returns a new `ByteBufHolder` which contains the specified `content`.
`PemPrivateKey`	`retain()` Increases the reference count by `1`.
`PemPrivateKey`	`retain(int increment)` Increases the reference count by the specified `increment`.
`PemPrivateKey`	`retainedDuplicate()` Duplicates this `ByteBufHolder`.
`PemPrivateKey`	`touch()` Records the current access location of this object for debugging purposes.
`PemPrivateKey`	`touch(Object hint)` Records the current access location of this object with an additional arbitrary information for debugging purposes.
`static PemPrivateKey`	`valueOf(byte[] key)` Creates a `PemPrivateKey` from raw `byte[]`.
`static PemPrivateKey`	`valueOf(ByteBuf key)` Creates a `PemPrivateKey` from raw `ByteBuf`.

Methods inherited from class io.netty.util.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 io.netty.util.ReferenceCounted
refCnt, release, release

- Method Detail
  - valueOf
```
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
```
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.
  - isSensitive
```
public boolean isSensitive()
```
    Returns true if the PEM encoded value is considered sensitive information such as a private key.
  - content
```
public ByteBuf content()
```
    Description copied from interface: ByteBufHolder
    
    Return the data which is held by this ByteBufHolder.
  - copy
```
public PemPrivateKey copy()
```
    Description copied from interface: ByteBufHolder
    
    Creates a deep copy of this ByteBufHolder.
  - duplicate
```
public PemPrivateKey duplicate()
```
    Description copied from interface: ByteBufHolder
    
    Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().
  - retainedDuplicate
```
public PemPrivateKey retainedDuplicate()
```
    Description copied from interface: ByteBufHolder
    
    Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().
    
    See Also:
    
    ByteBuf.retainedDuplicate()
  - replace
```
public PemPrivateKey replace(ByteBuf content)
```
    Description copied from interface: ByteBufHolder
    
    Returns a new ByteBufHolder which contains the specified content.
  - touch
```
public PemPrivateKey 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 ReferenceCounted
    
    Overrides:
    
    touch in class AbstractReferenceCounted
  - touch
```
public PemPrivateKey touch(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 ReferenceCounted
  - retain
```
public PemPrivateKey retain()
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by 1.
    
    Specified by:
    
    retain in interface ReferenceCounted
    
    Overrides:
    
    retain in class AbstractReferenceCounted
  - retain
```
public PemPrivateKey retain(int increment)
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    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
  - getEncoded
```
public byte[] getEncoded()
```
    Specified by:
    
    getEncoded in interface Key
  - getAlgorithm
```
public String getAlgorithm()
```
    Specified by:
    
    getAlgorithm in interface Key
  - getFormat
```
public String getFormat()
```
    Specified by:
    
    getFormat in interface Key
  - destroy
```
public void 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.
    
    Specified by:
    
    destroy in interface Destroyable
    
    See Also:
    
    Destroyable.destroy()
  - isDestroyed
```
public boolean 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.
    
    Specified by:
    
    isDestroyed in interface Destroyable
    
    See Also:
    
    Destroyable.isDestroyed()

Class PemPrivateKey

Method Summary

Methods inherited from class io.netty.util.AbstractReferenceCounted

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.ReferenceCounted

Method Detail

valueOf

valueOf

isSensitive

content

copy

duplicate

retainedDuplicate

replace

touch

touch

retain

retain

deallocate

getEncoded

getAlgorithm

getFormat

destroy

isDestroyed