TokenLocator | Line # 100 | 0 | 1 | - |
-1.0
|
No Tests | |||
1 | /* | |
2 | * Copyright (c) 2000-2005, University of Salford | |
3 | * All rights reserved. | |
4 | * | |
5 | * Redistribution and use in source and binary forms, with or without | |
6 | * modification, are permitted provided that the following conditions are met: | |
7 | * | |
8 | * Redistributions of source code must retain the above copyright notice, this | |
9 | * list of conditions and the following disclaimer. | |
10 | * | |
11 | * Redistributions in binary form must reproduce the above copyright notice, | |
12 | * this list of conditions and the following disclaimer in the documentation | |
13 | * and/or other materials provided with the distribution. | |
14 | * | |
15 | * Neither the name of the University of Salford nor the names of its | |
16 | * contributors may be used to endorse or promote products derived from this | |
17 | * software without specific prior written permission. | |
18 | * | |
19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
20 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
21 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
22 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
23 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
24 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
25 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
26 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
27 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
28 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
29 | * POSSIBILITY OF SUCH DAMAGE. | |
30 | */ | |
31 | /* | |
32 | * Copyright (c) 2006, University of Kent | |
33 | * All rights reserved. | |
34 | * | |
35 | * Redistribution and use in source and binary forms, with or without | |
36 | * modification, are permitted provided that the following conditions are met: | |
37 | * | |
38 | * Redistributions of source code must retain the above copyright notice, this | |
39 | * list of conditions and the following disclaimer. | |
40 | * | |
41 | * Redistributions in binary form must reproduce the above copyright notice, | |
42 | * this list of conditions and the following disclaimer in the documentation | |
43 | * and/or other materials provided with the distribution. | |
44 | * | |
45 | * 1. Neither the name of the University of Kent nor the names of its | |
46 | * contributors may be used to endorse or promote products derived from this | |
47 | * software without specific prior written permission. | |
48 | * | |
49 | * 2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS | |
50 | * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, | |
51 | * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
52 | * PURPOSE ARE DISCLAIMED. | |
53 | * | |
54 | * 3. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
55 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
56 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
57 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
58 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
59 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
60 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
61 | * POSSIBILITY OF SUCH DAMAGE. | |
62 | * | |
63 | * 4. YOU AGREE THAT THE EXCLUSIONS IN PARAGRAPHS 2 AND 3 ABOVE ARE REASONABLE | |
64 | * IN THE CIRCUMSTANCES. IN PARTICULAR, YOU ACKNOWLEDGE (1) THAT THIS | |
65 | * SOFTWARE HAS BEEN MADE AVAILABLE TO YOU FREE OF CHARGE, (2) THAT THIS | |
66 | * SOFTWARE IS NOT "PRODUCT" QUALITY, BUT HAS BEEN PRODUCED BY A RESEARCH | |
67 | * GROUP WHO DESIRE TO MAKE THIS SOFTWARE FREELY AVAILABLE TO PEOPLE WHO WISH | |
68 | * TO USE IT, AND (3) THAT BECAUSE THIS SOFTWARE IS NOT OF "PRODUCT" QUALITY | |
69 | * IT IS INEVITABLE THAT THERE WILL BE BUGS AND ERRORS, AND POSSIBLY MORE | |
70 | * SERIOUS FAULTS, IN THIS SOFTWARE. | |
71 | * | |
72 | * 5. This license is governed, except to the extent that local laws | |
73 | * necessarily apply, by the laws of England and Wales. | |
74 | */ | |
75 | ||
76 | package issrg.utils.repository; | |
77 | ||
78 | /** | |
79 | * This interface introduces a locator for entry with the user's authorisation | |
80 | * tokens. It can return the name of the entries in the repository where the | |
81 | * authorisation tokens for the subject are stored. The tokens can be located | |
82 | * either by the user name or by the issuer name and the token identifier | |
83 | * (for example, serial number). It can also return the name of the entry, as | |
84 | * a repository-independent name (used for domain matching). | |
85 | * | |
86 | * <p>Either of the locators can be null, but not both. The repositories will | |
87 | * use all non-null locators to find the tokens. | |
88 | * | |
89 | * <p>To clarify the difference between TokenLocator and Entry: Entry gives | |
90 | * the (universal) name of the entity for domain matching, whilst TokenLocator | |
91 | * can provide (by chaining the getLocator calls on alternative locators) | |
92 | * a list of locations where | |
93 | * the Authorisation Tokens can be obtained from. The (universal) entry name | |
94 | * may be different from (some of) the token locators. | |
95 | * | |
96 | * @author A Otenko | |
97 | * @version 1.0 | |
98 | */ | |
99 | ||
100 | public interface TokenLocator { | |
101 | /** | |
102 | * This method returns the name of the entry the object locates. | |
103 | * | |
104 | * @return the Entry object representing the entry name | |
105 | */ | |
106 | public Entry getEntry(); | |
107 | ||
108 | /** | |
109 | * This method returns the main repository-specific locator of the | |
110 | * Authorisation Tokens. | |
111 | * | |
112 | * @return a principal object representing the main locator of the | |
113 | * authorisation tokens. | |
114 | */ | |
115 | public java.security.Principal getLocator(); | |
116 | ||
117 | /** | |
118 | * This method returns the repository in which the Locator makes sense. May | |
119 | * be null, if the Locator is applicable on the global scale (for example, | |
120 | * is applicable to all the default repositories). | |
121 | */ | |
122 | public AttributeRepository getRepository(); | |
123 | ||
124 | /** | |
125 | * This method returns the alternative repository-specific locator of the | |
126 | * Authorisation Tokens. This locator | |
127 | * may have another alternative locator, which in its turn can recursively | |
128 | * proceed | |
129 | * until all locators are listed. The end of the list is denoted by returning | |
130 | * null | |
131 | * as the alternative locator. | |
132 | * | |
133 | * @return a TokenLocator object representing the alternative locator of the | |
134 | * authorisation tokens | |
135 | */ | |
136 | public TokenLocator getAlternativeLocator(); | |
137 | } |
|