Package org.nuxeo.ecm.platform.auth.saml.key

Interface KeyManager

All Superinterfaces:
org.opensaml.security.credential.CredentialResolver, net.shibboleth.shared.resolver.Resolver<org.opensaml.security.credential.Credential,net.shibboleth.shared.resolver.CriteriaSet>
All Known Implementing Classes:
KeyManagerImpl
public interface KeyManager extends org.opensaml.security.credential.CredentialResolver
A manager for KeyHolders.
Since:
6.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getAvailableCredentials()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, not used, no replacement
    X509Certificate
    getCertificate(String alias)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, not used, no replacement
    org.opensaml.security.credential.Credential
    getCredential(String keyName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, only used internally, no replacement
    default org.opensaml.security.credential.Credential
    getEncryptionCredential()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getEncryptionCredential()
    default Optional<KeyHolder>
    getKeyHolder(String name)
     
    default org.opensaml.security.credential.Credential
    getSigningCredential()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getSigningCredential()
    default org.opensaml.security.credential.Credential
    getTlsCredential()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getTlsCredential()
    Iterable<org.opensaml.security.credential.Credential>
    resolve(net.shibboleth.shared.resolver.CriteriaSet criteria)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, only used internally, no replacement
    org.opensaml.security.credential.Credential
    resolveSingle(net.shibboleth.shared.resolver.CriteriaSet criteria)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.7, only used internally, no replacement

  • Method Details

    • getKeyHolder

      default Optional<KeyHolder> getKeyHolder(String name)
      Since:
      2025.7

    • getCredential

      @Deprecated(since="2025.7", forRemoval=true) org.opensaml.security.credential.Credential getCredential(String keyName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, only used internally, no replacement

    • getAvailableCredentials

      @Deprecated(since="2025.7", forRemoval=true) Set<String> getAvailableCredentials()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, not used, no replacement

    • getCertificate

      @Deprecated(since="2025.7", forRemoval=true) X509Certificate getCertificate(String alias)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, not used, no replacement

    • getSigningCredential

      @Deprecated(since="2025.7", forRemoval=true) default org.opensaml.security.credential.Credential getSigningCredential()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getSigningCredential()

    • getEncryptionCredential

      @Deprecated(since="2025.7", forRemoval=true) default org.opensaml.security.credential.Credential getEncryptionCredential()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getEncryptionCredential()

    • getTlsCredential

      @Deprecated(since="2025.7", forRemoval=true) default org.opensaml.security.credential.Credential getTlsCredential()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, first retrieve a KeyHolder with getKeyHolder(String) and use KeyHolder.getTlsCredential()

    • resolve

      @Nonnull @Deprecated(since="2025.7", forRemoval=true) Iterable<org.opensaml.security.credential.Credential> resolve(@Nullable net.shibboleth.shared.resolver.CriteriaSet criteria) throws net.shibboleth.shared.resolver.ResolverException
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, only used internally, no replacement
      Specified by:
      resolve in interface net.shibboleth.shared.resolver.Resolver<org.opensaml.security.credential.Credential,net.shibboleth.shared.resolver.CriteriaSet>
      Throws:
      net.shibboleth.shared.resolver.ResolverException

    • resolveSingle

      @Nullable @Deprecated(since="2025.7", forRemoval=true) org.opensaml.security.credential.Credential resolveSingle(@Nullable net.shibboleth.shared.resolver.CriteriaSet criteria) throws net.shibboleth.shared.resolver.ResolverException
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.7, only used internally, no replacement
      Specified by:
      resolveSingle in interface net.shibboleth.shared.resolver.Resolver<org.opensaml.security.credential.Credential,net.shibboleth.shared.resolver.CriteriaSet>
      Throws:
      net.shibboleth.shared.resolver.ResolverException