aermicioi.aedi.storage.locator

1 /**
2 
3 License:
4 	Boost Software License - Version 1.0 - August 17th, 2003
5     
6     Permission is hereby granted, free of charge, to any person or organization
7     obtaining a copy of the software and accompanying documentation covered by
8     this license (the "Software") to use, reproduce, display, distribute,
9     execute, and transmit the Software, and to prepare derivative works of the
10     Software, and to permit third-parties to whom the Software is furnished to
11     do so, all subject to the following:
12     
13     The copyright notices in the Software and this entire statement, including
14     the above license grant, this restriction and the following disclaimer,
15     must be included in all copies of the Software, in whole or in part, and
16     all derivative works of the Software, unless such copies or derivative
17     works are solely in the form of machine-executable object code generated by
18     a source language processor.
19     
20     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22     FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
23     SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
24     FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
25     ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26     DEALINGS IN THE SOFTWARE.
27 
28 Authors:
29 	Alexandru Ermicioi
30 **/
31 module aermicioi.aedi.storage.locator_aware;
32 
33 import aermicioi.aedi.storage.locator;
34 
35 /**
36 Interface for objects that are aware about an locator, and accept one of them.
37 **/
38 interface LocatorAware(Type = Object, KeyType = string) {
39 	
40 	public {
41 		
42 		/**
43 		Set a locator to object.
44 		
45 		Params:
46 			locator = the locator that is set to oject.
47 		
48 		Returns:
49 			LocatorAware.
50 		**/
51 		@property LocatorAware locator(Locator!(Type, KeyType) locator); 
52 	}
53 }
54 
55 /**
56 Denotes a Locator that can delegate resource/object location to another Locator if it is available.
57 
58 Denotes a Locator that can delegate resource/object location to another Locator if it is available.
59 It is used to denote that a Locator when it doesn't contain the requested object will try to search it in another
60 Locator if it is available, and if it doesn't contain the resource it will throw NotFoundException.
61 
62 Note:
63 	A locator when delegates the task of resource location it should first check if locator in chain contains the
64 	object first, and fetch it afterwards. Such method is used to avoid an infinite loop when several DelegatingLocator are 
65 	chained in a loop.
66 **/
67 alias DelegatingLocator = LocatorAware;