1 /** 2 * Copyright (C) 2005-2009 Alfresco Software Limited. 3 * 4 * This file is part of the Spring Surf Extension project. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 package org.springframework.extensions.webscripts; 20 21 import java.util.Map; 22 23 24 /** 25 * Convert a mimetype to a Java object. 26 * 27 * @author davidc 28 * @param <Type> 29 */ 30 public interface FormatReader<Type> 31 { 32 /** 33 * Gets the source mimetype to convert from 34 * 35 * @return mimetype 36 */ 37 public String getSourceMimetype(); 38 39 /** 40 * Gets the Java Class to convert to 41 * 42 * @return Java Clas 43 */ 44 public Class<? extends Type> getDestinationClass(); 45 46 /** 47 * Converts mimetype to Java Object 48 * 49 * @param req web script request 50 * @return Java Object 51 */ 52 public Type read(WebScriptRequest req); 53 54 /** 55 * Create script parameters specific to source mimetype 56 * 57 * @param req web script request 58 * @param res web script response 59 * @return map of script objects indexed by name 60 */ 61 public Map<String, Object> createScriptParameters(WebScriptRequest req, WebScriptResponse res); 62 }