
001package ca.uhn.fhir.rest.server.method; 002 003/* 004 * #%L 005 * HAPI FHIR - Server Framework 006 * %% 007 * Copyright (C) 2014 - 2023 Smile CDR, Inc. 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023import ca.uhn.fhir.i18n.Msg; 024import java.lang.reflect.Method; 025import java.util.Collection; 026 027import org.apache.commons.lang3.StringUtils; 028 029import ca.uhn.fhir.context.ConfigurationException; 030import ca.uhn.fhir.model.primitive.IntegerDt; 031import ca.uhn.fhir.parser.DataFormatException; 032import ca.uhn.fhir.rest.annotation.Offset; 033import ca.uhn.fhir.rest.api.Constants; 034import ca.uhn.fhir.rest.api.server.RequestDetails; 035import ca.uhn.fhir.rest.param.ParameterUtil; 036import ca.uhn.fhir.rest.server.exceptions.InternalErrorException; 037import ca.uhn.fhir.rest.server.exceptions.InvalidRequestException; 038 039public class OffsetParameter implements IParameter { 040 041 private Class<?> myType; 042 043 @Override 044 public Object translateQueryParametersIntoServerArgument(RequestDetails theRequest, BaseMethodBinding theMethodBinding) throws InternalErrorException, InvalidRequestException { 045 String[] sinceParams = theRequest.getParameters().get(Constants.PARAM_OFFSET); 046 if (sinceParams != null) { 047 if (sinceParams.length > 0) { 048 if (StringUtils.isNotBlank(sinceParams[0])) { 049 try { 050 IntegerDt since = new IntegerDt(sinceParams[0]); 051 return ParameterUtil.fromInteger(myType, since); 052 } catch (DataFormatException e) { 053 throw new InvalidRequestException(Msg.code(461) + "Invalid " + Constants.PARAM_OFFSET + " value: " + sinceParams[0]); 054 } 055 } 056 } 057 } 058 return ParameterUtil.fromInteger(myType, null); 059 } 060 061 @Override 062 public void initializeTypes(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType) { 063 if (theOuterCollectionType != null) { 064 throw new ConfigurationException(Msg.code(462) + "Method '" + theMethod.getName() + "' in type '" +theMethod.getDeclaringClass().getCanonicalName()+ "' is annotated with @" + Offset.class.getName() + " but can not be of collection type"); 065 } 066 if (!ParameterUtil.isBindableIntegerType(theParameterType)) { 067 throw new ConfigurationException(Msg.code(463) + "Method '" + theMethod.getName() + "' in type '" +theMethod.getDeclaringClass().getCanonicalName()+ "' is annotated with @" + Offset.class.getName() + " but type '" + theParameterType + "' is an invalid type, must be one of Integer or IntegerType"); 068 } 069 myType = theParameterType; 070 } 071 072}