1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts.connector;
20
21 import org.springframework.extensions.surf.exception.CredentialVaultProviderException;
22
23 /**
24 * Interface for a Credential Vault provider
25 *
26 * @author muzquiano
27 */
28 public interface CredentialVaultProvider
29 {
30 /**
31 * Provide a credential vault for the given ID
32 *
33 * @param id Credential vault ID
34 *
35 * @return a new Credential Vault implementation
36 *
37 * @throws CredentialVaultProviderException
38 */
39 public CredentialVault provide(String id) throws CredentialVaultProviderException;
40
41 /**
42 * Provide a key for this Credential Vault for caching purposes
43 *
44 * @param id Credential vault ID
45 * @param userId User ID
46 *
47 * @return key as appropriate for this Credential Vault implementation
48 */
49 public String generateKey(String id, String userId);
50 }