ManagedKey (spring-security-oauth2-authorization-server 0.0.1 API)

java.lang.Object
- org.springframework.security.crypto.keys.ManagedKey

All Implemented Interfaces:
Serializable
```
public final class ManagedKey
extends Object
implements Serializable
```
A java.security.Key that is managed by a KeyManager.
Since:
0.0.1
See Also:
KeyManager, Serialized Form

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class ManagedKey.Builder
A builder for ManagedKey.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ManagedKey.Builder` A builder for `ManagedKey`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Instant`	`getActivatedOn()` Returns the time when this key was activated.
`String`	`getAlgorithm()` Returns the key algorithm.
`Instant`	`getDeactivatedOn()` Returns the time when this key was deactivated, `null` if still active.
`<T extends Key> T`	`getKey()` Returns a type of `java.security.Key`, e.g.
`String`	`getKeyId()` Returns the key ID.
`PublicKey`	`getPublicKey()` Returns the `java.security.PublicKey` if this is a asymmetric key, `null` otherwise.
`int`	`hashCode()`
`boolean`	`isActive()` Returns `true` if this key is active, `false` otherwise.
`boolean`	`isAsymmetric()` Returns `true` if this is a asymmetric key, `false` otherwise.
`boolean`	`isSymmetric()` Returns `true` if this is a symmetric key, `false` otherwise.
`static ManagedKey.Builder`	`withAsymmetricKey(PublicKey publicKey, PrivateKey privateKey)` Returns a new `ManagedKey.Builder`, initialized with the provided `java.security.PublicKey` and `java.security.PrivateKey`.
`static ManagedKey.Builder`	`withSymmetricKey(SecretKey secretKey)` Returns a new `ManagedKey.Builder`, initialized with the provided `javax.crypto.SecretKey`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isSymmetric
```
public boolean isSymmetric()
```
    Returns true if this is a symmetric key, false otherwise.
    Returns:
    true if this is a symmetric key, false otherwise
  - isAsymmetric
```
public boolean isAsymmetric()
```
    Returns true if this is a asymmetric key, false otherwise.
    Returns:
    true if this is a asymmetric key, false otherwise
  - getKey
```
public <T extends Key> T getKey()
```
    Returns a type of java.security.Key, e.g. javax.crypto.SecretKey or java.security.PrivateKey.
    Type Parameters:
    T - the type of java.security.Key
    Returns:
    the type of java.security.Key
  - getPublicKey
```
public PublicKey getPublicKey()
```
    Returns the java.security.PublicKey if this is a asymmetric key, null otherwise.
    Returns:
    the java.security.PublicKey if this is a asymmetric key, null otherwise
  - getKeyId
```
public String getKeyId()
```
    Returns the key ID.
    Returns:
    the key ID
  - getActivatedOn
```
public Instant getActivatedOn()
```
    Returns the time when this key was activated.
    Returns:
    the time when this key was activated
  - getDeactivatedOn
```
public Instant getDeactivatedOn()
```
    Returns the time when this key was deactivated, null if still active.
    Returns:
    the time when this key was deactivated, null if still active
  - isActive
```
public boolean isActive()
```
    Returns true if this key is active, false otherwise.
    Returns:
    true if this key is active, false otherwise
  - getAlgorithm
```
public String getAlgorithm()
```
    Returns the key algorithm.
    Returns:
    the key algorithm
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - withSymmetricKey
```
public static ManagedKey.Builder withSymmetricKey(SecretKey secretKey)
```
    Returns a new ManagedKey.Builder, initialized with the provided javax.crypto.SecretKey.
    Parameters:
    secretKey - the javax.crypto.SecretKey
    Returns:
    the ManagedKey.Builder
  - withAsymmetricKey
```
public static ManagedKey.Builder withAsymmetricKey(PublicKey publicKey,
                                                   PrivateKey privateKey)
```
    Returns a new ManagedKey.Builder, initialized with the provided java.security.PublicKey and java.security.PrivateKey.
    Parameters:
    publicKey - the java.security.PublicKey
    privateKey - the java.security.PrivateKey
    Returns:
    the ManagedKey.Builder

Class ManagedKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isSymmetric

isAsymmetric

getKey

getPublicKey

getKeyId

getActivatedOn

getDeactivatedOn

isActive

getAlgorithm

equals

hashCode

withSymmetricKey

withAsymmetricKey