net.java.truecommons.key.spec.AbstractKeyManagerMap 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;

import net.java.truecommons.services.Container;
import net.java.truecommons.shed.UniqueObject;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.util.Map;
import java.util.ServiceConfigurationError;

/**
 * An abstract key manager map.
 * When implementing a key manager map, you should extend this class rather
 * than directly implementing the interface in order to maintain binary
 * backwards compatibility even if the interface is changed.
 * 
 * Implementations must be safe for multi-threading.
 *
 * @since TrueCommons 2.2
 * @author Christian Schlichtherle
 */
@Immutable
public abstract class AbstractKeyManagerMap
extends UniqueObject
implements KeyManagerMap, Container, KeyManager>> {

    @Override
    @SuppressWarnings("unchecked")
    public final @Nullable  KeyManager manager(final Class type) {
        final KeyManager m = get().get(type);
        if (null == m)
            throw new ServiceConfigurationError("No key manager available for " + type + ".");
        return (KeyManager) m;
    }

    /**
     * Returns an immutable map of key classes to nullable key managers.
     * Only the values of the returned map may be {@code null}.
     * 
     * This is an immutable property - multiple calls must return the same
     * object.
     *
     * @return An immutable map of key classes to nullable key managers.
     */
    @Override
    public abstract Map, KeyManager> get();

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