 | Report generated by Clover Code Coverage v2.0.3 Sun Mar 23 2008 08:29:30 GMT. |
Clover: Open Source License registered to OpenPERMIS. |
| AuthzTokenRepository | Line # 44 | 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 | package issrg.pba.repository; | |
| 33 | import issrg.pba.ParsedToken; | |
| 34 | /** | |
| 35 | *This interface specifies the way Authorisation Tokens | |
| 36 | * should be retrieved. The implementations should return | |
| 37 | * tokens that can be parsed from which the credentials | |
| 38 | * can then be extracted. | |
| 39 | * | |
| 40 | * @author A Otenko | |
| 41 | * @version 1.0 | |
| 42 | */ | |
| 43 | ||
| 44 | public interface AuthzTokenRepository { | |
| 45 | ||
| 46 | /** | |
| 47 | * This method retrieves Authorisation Tokens (as directory attributes) | |
| 48 | * for a given entry from the repository. The TokenLocator (name | |
| 49 | * of the holder and some alternative name) is the locator of the Token. | |
| 50 | * Note that the returned authorisation tokens may be valid or invalid | |
| 51 | * according to the PERMIS policy, and may be authentic or not authentic ( | |
| 52 | * as determined later by the signature verification). | |
| 53 | * | |
| 54 | * @param subject is the TokenLocator of the holder of the authorisation token | |
| 55 | * | |
| 56 | * @return a collection of authorisation tokens (as directory attributes) | |
| 57 | * associated with the subject and held in its entry in the repository, | |
| 58 | * or null if no tokens were contained within the entry. Note that | |
| 59 | * implementations should throw an exception if a subject entry | |
| 60 | * does not exist in the repository. | |
| 61 | * | |
| 62 | * @throws PbaException in case of any error while retrieving the tokens | |
| 63 | */ | |
| 64 | public javax.naming.directory.Attribute getAuthTokens(issrg.utils.repository.TokenLocator subject) throws issrg.pba.PbaException; | |
| 65 | ||
| 66 | /** | |
| 67 | * This method returns the all the related tokens in a parsed form. | |
| 68 | * Implementation of this function may be able to retrieve related tokens | |
| 69 | * from a repository, and parse the retrieved tokens. | |
| 70 | * | |
| 71 | * <p>Effectively, this method should be the same as calling getAuthTokens, | |
| 72 | * then parsing them with a preconfigured AuthTokenParser, ignoring the | |
| 73 | * malformed Authorization Tokens. | |
| 74 | * | |
| 75 | * @param subject is the TokenLocator of the holder of the authorisation token | |
| 76 | * | |
| 77 | * @return an array of parsed tokens. It is never null, but some entries in | |
| 78 | * the | |
| 79 | * array may be null. Empty array may be retruned meaning that no tokens | |
| 80 | * are available. | |
| 81 | */ | |
| 82 | public ParsedToken[] getParsedAuthTokens(issrg.utils.repository.TokenLocator subject) throws issrg.pba.PbaException; | |
| 83 | } | |
| 84 | ||
|
||||||||||