net.java.truecommons.key.spec.prompting.PromptingKeyManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truecommons-key-spec Show documentation

Specifies a pluggable API for key management.

The newest version!

/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.truecommons.key.spec.prompting;

import net.java.truecommons.key.spec.AbstractKeyManager;
import net.java.truecommons.key.spec.KeyProvider;
import net.java.truecommons.key.spec.prompting.PromptingKey.View;

import javax.annotation.concurrent.ThreadSafe;
import java.net.URI;

import static java.util.Objects.requireNonNull;

/**
 * A key manager which prompts the user for a secret key if required.
 *
 * @param   the type of the prompting keys.
 * @see    PromptingKeyManagerMap
 * @since  TrueCommons 2.2
 * @author Christian Schlichtherle
 */
@ThreadSafe
public final class PromptingKeyManager>
extends AbstractKeyManager {

    private final SharedKeyManager manager = new SharedKeyManager<>();
    private final View view;

    /**
     * Constructs a new prompting key manager.
     *
     * @param view the view for key prompting.
     */
    public PromptingKeyManager(View view) {
        this.view = requireNonNull(view);
    }

    View getView() { return view; }

    @Override
    public KeyProvider provider(URI uri) {
        return new PromptingKeyProvider<>(this, requireNonNull(uri),
                manager.provider(uri));
    }

    /**
     * {@inheritDoc}
     * 
     * The implementation in the class {@code PromptingKeyManager} resets the
     * state of the key provider for the given protected resource if and only
     * if prompting for the key has been cancelled.
     */
    @Override
    public void release(URI uri) {
        manager.release(requireNonNull(uri));
    }

    @Override
    public void link(URI originUri, URI targetUri) {
        manager.link(requireNonNull(originUri), requireNonNull(targetUri));
    }

    @Override
    public void unlink(URI uri) {
        manager.unlink(requireNonNull(uri));
    }

    /**
     * Returns a string representation of this object for logging and debugging
     * purposes.
     */
    @Override
    public String toString() {
        return String.format("%s[view=%s]",
                getClass().getName(),
                getView());
    }
}