View Javadoc

1   /*
2    * #%L
3    * Bitrepository Core
4    * %%
5    * Copyright (C) 2010 - 2012 The State and University Library, The Royal Library and The State Archives, Denmark
6    * %%
7    * This program is free software: you can redistribute it and/or modify
8    * it under the terms of the GNU Lesser General Public License as 
9    * published by the Free Software Foundation, either version 2.1 of the 
10   * License, or (at your option) any later version.
11   * 
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Lesser Public License for more details.
16   * 
17   * You should have received a copy of the GNU General Lesser Public 
18   * License along with this program.  If not, see
19   * <http://www.gnu.org/licenses/lgpl-2.1.html>.
20   * #L%
21   */
22  package org.bitrepository.service.contributor.handler;
23  
24  import org.bitrepository.bitrepositorymessages.MessageResponse;
25  import org.bitrepository.service.exception.RequestHandlerException;
26  
27  /**
28   * Provides functionality for handling a single type of request.
29   */
30  public interface RequestHandler<T> {
31      /** Return the request class which is handled by this handler. */
32      public Class<T> getRequestClass();
33  
34      /**
35       * Implements the concrete handling of a received request.
36       * @param request The request to handle.
37       * @throws RequestHandlerException If something goes wrong while handling the 
38       */
39      public void processRequest(T request) throws RequestHandlerException;
40  
41      /**
42       * Used for creating responses signaling general failures to handle the request.
43       * The response is missing the response info field.
44       * @return The failure response.
45       */
46      public MessageResponse generateFailedResponse(T request);
47  }