org.wisdom.api.content.BodyParser Maven / Gradle / Ivy
/*
* #%L
* Wisdom-Framework
* %%
* Copyright (C) 2013 - 2014 Wisdom Framework
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.wisdom.api.content;
import org.wisdom.api.http.Context;
import java.lang.reflect.Type;
import java.util.List;
public interface BodyParser {
/**
* Invokes the parser and get back a Java object populated with the content of this request.
*
* MUST BE THREAD SAFE TO CALL!
*
* @param context The context
* @param classOfT The class we expect
* @return The object instance populated with all values from raw request
*/
T invoke(Context context, Class classOfT);
/**
* Invokes the parser and get back a Java object populated with the content of this request. This
* method supports generic types, and so let you build parameterized type.
*
* MUST BE THREAD SAFE TO CALL!
*
* @param context The context
* @param classOfT The class we expect
* @param genericType the generic type (maybe null)
* @return The object instance populated with all values from raw request
* @since 0.8.1
*/
T invoke(Context context, Class classOfT, Type genericType);
/**
* Invoke the parser and get back a Java object populated
* with the content of this request.
*
* MUST BE THREAD SAFE TO CALL!
*
* @param bytes the content
* @param classOfT The class we expect
* @return The object instance populated with all values from raw request
*/
T invoke(byte[] bytes, Class classOfT);
/**
* The content types this BodyParserEngine can handle
*
* MUST BE THREAD SAFE TO CALL!
*
* @return the content types. this parser can handle - eg. "[application/json]"
*/
List getContentTypes();
}