View Javadoc
1   /*
2    * Copyright (C) 2012-2024 RRiBbit.org
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.rribbit.processing;
17  
18  import java.util.Collection;
19  
20  import org.rribbit.ListenerObject;
21  import org.rribbit.Request;
22  import org.rribbit.Response;
23  import org.rribbit.dispatching.LocalRequestDispatcher;
24  import org.rribbit.execution.ListenerObjectExecutor;
25  import org.rribbit.retrieval.ListenerObjectRetriever;
26  import org.slf4j.Logger;
27  import org.slf4j.LoggerFactory;
28  
29  /**
30   * This class processes requests on a local machine and exposes its functionality as a simple Java method call. This class is supposed to be used in conjunction with the
31   * {@link LocalRequestDispatcher}.
32   *
33   * @author G.J. Schouten
34   *
35   */
36  public class LocalRequestProcessor implements RequestProcessor {
37  
38  	private static final Logger log = LoggerFactory.getLogger(LocalRequestProcessor.class);
39  
40  	protected ListenerObjectRetriever listenerObjectRetriever;
41  	protected ListenerObjectExecutor listenerObjectExecutor;
42  
43  	/**
44  	 * Whenever you use this constructor, be sure to set the {@link ListenerObjectRetriever} AND the {@link ListenerObjectExecutor} with the setters provided by this class.
45  	 * If you don't, runtime {@link NullPointerException}s will occur.
46  	 */
47  	public LocalRequestProcessor() {}
48  
49  	/**
50  	 * This constructor is recommended, since it forces you to specify the {@link ListenerObjectRetriever} and {@link ListenerObjectExecutor}. Passing a null value for either
51  	 * of these will result in a runtime {@link NullPointerException} whenever the {@link LocalRequestProcessor} is used.
52  	 *
53  	 * @param listenerObjectRetriever
54  	 * @param listenerObjectExecutor
55  	 */
56  	public LocalRequestProcessor(ListenerObjectRetriever listenerObjectRetriever, ListenerObjectExecutor listenerObjectExecutor) {
57  		this.listenerObjectRetriever = listenerObjectRetriever;
58  		this.listenerObjectExecutor = listenerObjectExecutor;
59  	}
60  
61  	@Override
62  	public <T> Response<T> processRequest(Request request) {
63  
64  		log.info("Processing Request");
65  
66  		log.debug("Getting ListenerObjects");
67  		Collection<ListenerObject> listenerObjects;
68  		if(request.getDesiredReturnType() == null) {
69  			if(request.getHint() == null) {
70  				listenerObjects = listenerObjectRetriever.getListenerObjects();
71  			} else {
72  				listenerObjects = listenerObjectRetriever.getListenerObjects(request.getHint());
73  			}
74  		} else {
75  			if(request.getHint() == null) {
76  				listenerObjects = listenerObjectRetriever.getListenerObjects(request.getDesiredReturnType());
77  			} else {
78  				listenerObjects = listenerObjectRetriever.getListenerObjects(request.getDesiredReturnType(), request.getHint());
79  			}
80  		}
81  
82  		log.debug("Executing ListenerObjects");
83  		Response<T> response = listenerObjectExecutor.executeListeners(listenerObjects, request.getParameters());
84  		log.info("Returning Response");
85  		return response;
86  	}
87  
88  	public ListenerObjectRetriever getListenerObjectRetriever() {
89  		return listenerObjectRetriever;
90  	}
91  
92  	public void setListenerObjectRetriever(ListenerObjectRetriever listenerObjectRetriever) {
93  		this.listenerObjectRetriever = listenerObjectRetriever;
94  	}
95  
96  	public ListenerObjectExecutor getListenerObjectExecutor() {
97  		return listenerObjectExecutor;
98  	}
99  
100 	public void setListenerObjectExecutor(ListenerObjectExecutor listenerObjectExecutor) {
101 		this.listenerObjectExecutor = listenerObjectExecutor;
102 	}
103 }