|
|||||||||||||||||||
30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover | |||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
PipelineAssembler.java | 100% | 100% | 100% | 100% |
|
1 |
// Copyright 2004 The Apache Software Foundation
|
|
2 |
//
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
5 |
// You may obtain a copy of the License at
|
|
6 |
//
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8 |
//
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12 |
// See the License for the specific language governing permissions and
|
|
13 |
// limitations under the License.
|
|
14 |
|
|
15 |
package org.apache.hivemind.lib.pipeline;
|
|
16 |
|
|
17 |
import java.util.List;
|
|
18 |
|
|
19 |
import org.apache.commons.logging.Log;
|
|
20 |
import org.apache.hivemind.ErrorHandler;
|
|
21 |
import org.apache.hivemind.Location;
|
|
22 |
import org.apache.hivemind.impl.BaseLocatable;
|
|
23 |
import org.apache.hivemind.internal.Module;
|
|
24 |
import org.apache.hivemind.lib.DefaultImplementationBuilder;
|
|
25 |
import org.apache.hivemind.order.Orderer;
|
|
26 |
import org.apache.hivemind.service.ClassFactory;
|
|
27 |
|
|
28 |
/**
|
|
29 |
* Used by the {@link org.apache.hivemind.lib.pipeline.PipelineFactory} to
|
|
30 |
* assemble the pipeline.
|
|
31 |
*
|
|
32 |
* @author Howard Lewis Ship
|
|
33 |
*/
|
|
34 |
public class PipelineAssembler extends BaseLocatable |
|
35 |
{ |
|
36 |
|
|
37 |
private Log _log;
|
|
38 |
private ErrorHandler _errorHandler;
|
|
39 |
private String _serviceId;
|
|
40 |
private Class _serviceInterface;
|
|
41 |
private Class _filterInterface;
|
|
42 |
private ClassFactory _classFactory;
|
|
43 |
private DefaultImplementationBuilder _defaultBuilder;
|
|
44 |
private Module _module;
|
|
45 |
|
|
46 |
private Orderer _orderer;
|
|
47 |
|
|
48 |
private Object _terminator;
|
|
49 |
private Location _terminatorLocation;
|
|
50 |
|
|
51 |
/**
|
|
52 |
* @param log used for logging, typically the log for the service being assembled\
|
|
53 |
* @param errorHandler used for handling recoverable errors
|
|
54 |
* @param servceId of the service being assembled
|
|
55 |
* @param serviceInterface the main interface
|
|
56 |
* @param filterInterface the interface for filters
|
|
57 |
* @param classFactory for creating new classes
|
|
58 |
* @param defaultBuilder used to provide a placeholder terminator if no real terminator is supplied
|
|
59 |
* @param module the Module containing the service to be created
|
|
60 |
*/
|
|
61 | 9 |
public PipelineAssembler(
|
62 |
Log log, |
|
63 |
ErrorHandler errorHandler, |
|
64 |
String serviceId, |
|
65 |
Class serviceInterface, |
|
66 |
Class filterInterface, |
|
67 |
ClassFactory classFactory, |
|
68 |
DefaultImplementationBuilder defaultBuilder, |
|
69 |
Module module) |
|
70 |
{ |
|
71 |
|
|
72 | 9 |
_log = log; |
73 | 9 |
_errorHandler = errorHandler; |
74 | 9 |
_serviceId = serviceId; |
75 | 9 |
_serviceInterface = serviceInterface; |
76 | 9 |
_filterInterface = filterInterface; |
77 | 9 |
_classFactory = classFactory; |
78 | 9 |
_defaultBuilder = defaultBuilder; |
79 | 9 |
_module = module; |
80 |
|
|
81 | 9 |
_orderer = new Orderer(_log, errorHandler, "filter"); |
82 |
|
|
83 |
} |
|
84 |
|
|
85 | 8 |
public void addFilter( |
86 |
String name, |
|
87 |
String prereqs, |
|
88 |
String postreqs, |
|
89 |
Object filter, |
|
90 |
Location location) |
|
91 |
{ |
|
92 | 8 |
if (!checkInterface(_filterInterface, filter, location))
|
93 | 1 |
return;
|
94 |
|
|
95 | 7 |
FilterHolder holder = new FilterHolder(filter, location);
|
96 |
|
|
97 | 7 |
_orderer.add(holder, name, prereqs, postreqs); |
98 |
} |
|
99 |
|
|
100 | 8 |
public void setTerminator(Object terminator, Location terminatorLocation) |
101 |
{ |
|
102 | 8 |
if (_terminator != null) |
103 |
{ |
|
104 | 1 |
_errorHandler.error( |
105 |
_log, |
|
106 |
PipelineMessages.duplicateTerminator( |
|
107 |
terminator, |
|
108 |
_serviceId, |
|
109 |
_terminator, |
|
110 |
_terminatorLocation), |
|
111 |
terminatorLocation, |
|
112 |
null);
|
|
113 | 1 |
return;
|
114 |
} |
|
115 |
|
|
116 | 7 |
if (!checkInterface(_serviceInterface, terminator, terminatorLocation))
|
117 | 1 |
return;
|
118 |
|
|
119 | 6 |
_terminator = terminator; |
120 | 6 |
_terminatorLocation = terminatorLocation; |
121 |
} |
|
122 |
|
|
123 |
// For testing
|
|
124 |
|
|
125 | 2 |
Object getTerminator() |
126 |
{ |
|
127 | 2 |
return _terminator;
|
128 |
} |
|
129 |
|
|
130 | 15 |
private boolean checkInterface(Class interfaceType, Object instance, Location location) |
131 |
{ |
|
132 | 15 |
if (interfaceType.isAssignableFrom(instance.getClass()))
|
133 | 13 |
return true; |
134 |
|
|
135 | 2 |
_errorHandler.error( |
136 |
_log, |
|
137 |
PipelineMessages.incorrectInterface(instance, interfaceType, _serviceId), |
|
138 |
location, |
|
139 |
null);
|
|
140 |
|
|
141 | 2 |
return false; |
142 |
} |
|
143 |
|
|
144 |
/**
|
|
145 |
* Returns an object that implements the service interface, and integrates
|
|
146 |
* any filters for the pipeline with the
|
|
147 |
*/
|
|
148 | 6 |
public Object createPipeline()
|
149 |
{ |
|
150 | 6 |
List filterHolders = _orderer.getOrderedObjects(); |
151 | 6 |
int count = filterHolders.size();
|
152 |
|
|
153 | 6 |
BridgeBuilder bb = |
154 | 6 |
(count == 0) |
155 |
? null
|
|
156 |
: new BridgeBuilder(
|
|
157 |
_log, |
|
158 |
_serviceId, |
|
159 |
_serviceInterface, |
|
160 |
_filterInterface, |
|
161 |
_classFactory, |
|
162 |
_module); |
|
163 |
|
|
164 | 6 |
Object next = |
165 | 6 |
_terminator != null
|
166 |
? _terminator |
|
167 |
: _defaultBuilder.buildDefaultImplementation(_serviceInterface, _module); |
|
168 |
|
|
169 |
// Like service interceptors, we work deepest (last) to shallowest (first).
|
|
170 |
|
|
171 | 6 |
for (int i = count - 1; i >= 0; i--) |
172 |
{ |
|
173 | 7 |
FilterHolder h = (FilterHolder) filterHolders.get(i); |
174 | 7 |
Object filter = h.getFilter(); |
175 |
|
|
176 | 7 |
next = bb.instantiateBridge(next, filter); |
177 |
} |
|
178 |
|
|
179 | 6 |
return next;
|
180 |
} |
|
181 |
} |
|
182 |
|
|