PromptingKey (TrueCommons KeyManager Specification 2.5.0 API)

TrueCommons KeyManager Specification 2.5.0

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Type Parameters:
K - the type of this prompting key.

All Superinterfaces:

Cloneable, Key<K>

All Known Subinterfaces:

PromptingPbeParameters<P,S>

All Known Implementing Classes:

AbstractPromptingPbeParameters, AesPbeParameters
```
public interface PromptingKey<K extends PromptingKey<K>>
extends Key<K>
```
A prompting key for writing and reading protected resources.
Implementations need to be stateful and hence do not need to be thread-safe.

Since:

TrueCommons 2.2

Author:

Christian Schlichtherle

See Also:
PromptingKeyProvider

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`PromptingKey.Controller<K extends PromptingKey<K>>` Proxies access to the key for `PromptingKey.View` implementations.
`static interface`	`PromptingKey.View<K extends PromptingKey<K>>` Used for the actual prompting of the user for a key (a password for example) which is required to access a protected resource.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isChangeRequested()` Returns whether or not the user shall get prompted for a new key upon the next call to `PromptingKeyProvider.getKeyForWriting()`, provided that the key has been `set` before.
`void`	`setChangeRequested(boolean changeRequested)` Requests to prompt the user for a new key upon the next call to `PromptingKeyProvider.getKeyForWriting()`, provided that the key has been `set` by then.

Methods inherited from interface net.java.truecommons.key.spec.Key
clone, equals, hashCode, reset

- Method Detail
  - isChangeRequested
```
boolean isChangeRequested()
```
    Returns whether or not the user shall get prompted for a new key upon the next call to PromptingKeyProvider.getKeyForWriting(), provided that the key has been set before.
    
    Returns:
    Whether or not the user shall get prompted for a new key upon the next call to PromptingKeyProvider.getKeyForWriting(), provided that the key has been set before.
  - setChangeRequested
```
void setChangeRequested(boolean changeRequested)
```
    Requests to prompt the user for a new key upon the next call to PromptingKeyProvider.getKeyForWriting(), provided that the key has been set by then.
    
    Parameters:
    changeRequested - whether or not the user shall get prompted for a new key upon the next call to PromptingKeyProvider.getKeyForWriting(), provided that the key has been set by then.

TrueCommons KeyManager Specification 2.5.0

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012–2015 Schlichtherle IT Services. All rights reserved.