Package org.springframework.extensions.webscripts.connector

Interface CredentialVault

  • All Known Implementing Classes:
    SimpleCredentialVault
    public interface CredentialVault
    Interface for a Credential Vault Credential vaults allow for the storage and retrieval of credentials by credential id.
    Author:
    muzquiano

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getStoredIds()
      Returns the ids for stored credentials
      boolean hasCredentials​(java.lang.String endpointId)  
      Credentials newCredentials​(java.lang.String endpointId)
      Creates new credentials which are stored in this vault
      void remove​(java.lang.String endpointId)
      Removes credentials for a given endpoint id from the vault
      Credentials retrieve​(java.lang.String endpointId)
      Retrieves credentials for a given endpoint id from the vault
      void store​(Credentials credentials)
      Places the given credentials into the vault

    • Method Detail

      • store

        void store​(Credentials credentials)
        Places the given credentials into the vault
        Parameters:
        credentials - the credentials

      • retrieve

        Credentials retrieve​(java.lang.String endpointId)
        Retrieves credentials for a given endpoint id from the vault
        Parameters:
        endpointId - the endpoint id
        Returns:
        the credentials

      • remove

        void remove​(java.lang.String endpointId)
        Removes credentials for a given endpoint id from the vault
        Parameters:
        endpointId - String

      • hasCredentials

        boolean hasCredentials​(java.lang.String endpointId)
        Returns:
        true if any credentials are stored for this endpoint id

      • newCredentials

        Credentials newCredentials​(java.lang.String endpointId)
        Creates new credentials which are stored in this vault
        Parameters:
        endpointId - String
        Returns:
        the credentials object

      • getStoredIds

        java.lang.String[] getStoredIds()
        Returns the ids for stored credentials
        Returns:
        String[]