/**
* Copyright © 2012, Adam Retter / EXQuery
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the <organization> nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.exquery.restxq.impl.annotation;
import java.io.InputStream;
import java.util.List;
import org.exquery.http.HttpRequest;
import org.exquery.restxq.RestXqErrorCodes;
import org.exquery.restxq.RestXqErrorCodes.RestXqErrorCode;
import org.exquery.xdm.type.Base64BinaryTypedValue;
import org.exquery.xdm.type.SequenceImpl;
import org.exquery.xdm.type.StringTypedValue;
import org.exquery.xquery.Literal;
import org.exquery.xquery.Sequence;
import org.exquery.xquery.TypedArgumentValue;
/**
* Implementation of RESTXQ Form Parameter Annotation
* i.e. %rest:form-param
*
* @author Adam Retter <adam.retter@googlemail.com>
*/
public class FormParameterAnnotation extends AbstractParameterWithDefaultAnnotation {
/**
* @see AbstractParameterAnnotation#extractParameter(org.exquery.http.HttpRequest)
*/
@Override
public TypedArgumentValue extractParameter(final HttpRequest request) {
/* Taken from section 6.1, page 31 of the JAX-RS JSR-311 specification:
*
* Servlet filters may trigger consumption of a request body by accessing request parameters. In a servlet
* container the @FormParam annotation and the standard entity provider for application/x-www-form--
* urlencoded MUST obtain their values from the servlet request parameters if the request body has already
* been consumed. Servlet APIs do not differentiate between parameters in the URI and body of a request so
* URI-based query parameters may be included in the entity parameter
*/
return new TypedArgumentValue() {
@Override
public String getArgumentName() {
return getParameterAnnotationMapping().getFunctionArgumentName();
}
@Override
public Sequence getTypedValue() {
final Object formParam = request.getFormParam(getParameterAnnotationMapping().getParameterName());
if(formParam == null) {
final Literal defaultLiterals[] = getParameterAnnotationMapping().getDefaultValues();
return literalsToSequence(defaultLiterals);
}
if(formParam instanceof String) {
return new SequenceImpl(new StringTypedValue((String)formParam));
} else if(formParam instanceof List) {
final List<String> formFieldValues = (List<String>)formParam;
return collectionToSequence(formFieldValues);
} else if(formParam instanceof InputStream) {
/*try {
return BinaryValueFromInputStream.getInstance(context, new Base64BinaryValueType(), (InputStream)formParam);
} catch(XPathException xpe) {
//TODO log
return null;
}*/
return new SequenceImpl<InputStream>(new Base64BinaryTypedValue((InputStream)formParam));
}
return null;
}
};
}
//<editor-fold desc="Error Codes">
/**
* @see AbstractParameterAnnotation#getInvalidAnnotationParamsErr()
*/
@Override
protected RestXqErrorCode getInvalidAnnotationParamsErr() {
return RestXqErrorCodes.RQST0015;
}
/**
* @see AbstractParameterAnnotation#getInvalidParameterNameErr()
*/
@Override
protected RestXqErrorCode getInvalidParameterNameErr() {
return RestXqErrorCodes.RQST0016;
}
/**
* @see AbstractParameterAnnotation#getInvalidFunctionArgumentNameErr()
*/
@Override
protected RestXqErrorCode getInvalidFunctionArgumentNameErr() {
return RestXqErrorCodes.RQST0017;
}
/**
* @see AbstractParameterAnnotation#getInvalidDefaultValueErr()
*/
@Override
protected RestXqErrorCode getInvalidDefaultValueErr() {
return RestXqErrorCodes.RQST0018;
}
/**
* @see AbstractParameterAnnotation#getInvalidDefaultValueTypeErr()
*/
@Override
protected RestXqErrorCode getInvalidDefaultValueTypeErr() {
return RestXqErrorCodes.RQST0019;
}
/**
* @see AbstractParameterAnnotation#getInvalidAnnotationParametersSyntaxErr()
*/
@Override
protected RestXqErrorCode getInvalidAnnotationParametersSyntaxErr() {
return RestXqErrorCodes.RQST0020;
}
//<editor-fold>
}