1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.qpid.server.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
public interface PreferencesProvider extends ConfiguredObject
{
String TYPE = "type";
String CREATED = "created";
String UPDATED = "updated";
String DURABLE = "durable";
String LIFETIME_POLICY = "lifetimePolicy";
String STATE = "state";
String TIME_TO_LIVE = "timeToLive";
Collection<String> AVAILABLE_ATTRIBUTES =
Collections.unmodifiableList(
Arrays.asList(
ID,
NAME,
STATE,
TYPE,
CREATED,
UPDATED,
DURABLE,
LIFETIME_POLICY,
TIME_TO_LIVE
));
/**
* Returns preferences {@link Map} for a given user ID
* @param userId user ID to retrieve preferences for
* @return preferences {@link Map}
*/
Map<String, Object> getPreferences(String userId);
/**
* Set user preferences as specified in a given {@link Map}
* @param userId user ID to set preferences for
* @param preferences new preferences
* @return existing user preferences
*/
Map<String, Object> setPreferences(String userId, Map<String, Object> preferences);
/**
* Delete preferences for given user IDs
* @param userIDs user IDs to delete preferences for
* @return user an array with user IDs having preferences deleted
*/
String[] deletePreferences(String... userIDs);
/**
* Returns set of the user IDs having preferences set
* @return user IDs
*/
Set<String> listUserIDs();
/**
* Returns authentication provider associated with this preferences provider
* @return authentication provider
*/
AuthenticationProvider getAuthenticationProvider();
}
|
