This repository was archived by the owner on Feb 26, 2023. It is now read-only.
Add static headers from annotation #1470
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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. | ||
| */ | ||
| package org.androidannotations.rest.spring.annotations; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Use on methods in {@link Rest} annotated classes to add headers to a | ||
| * particular method. | ||
| * | ||
| * <blockquote> | ||
| * | ||
| * <b>Example :</b> | ||
| * | ||
| * <pre> | ||
| * @Rest(converters = MappingJacksonHttpMessageConverter.class) | ||
| * public interface MyRestClient { | ||
| * | ||
| * @Header(name = "keep-alive", name = "300") | ||
| * @Post("/test") | ||
| * void testRoute(); | ||
| * } | ||
| * </pre> | ||
| * | ||
| * </blockquote> | ||
| * | ||
| * @see Headers | ||
| */ | ||
| @Retention(RetentionPolicy.CLASS) | ||
| @Target(ElementType.METHOD) | ||
| public @interface Header { | ||
| String name(); | ||
|
|
||
| String value(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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. | ||
| */ | ||
| package org.androidannotations.rest.spring.annotations; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Use on methods in {@link Rest} annotated classes to add multiple headers to a | ||
| * given method. | ||
| * | ||
| * <blockquote> | ||
| * | ||
| * <b>Example :</b> | ||
| * | ||
| * <pre> | ||
| * @Rest(converters = MappingJacksonHttpMessageConverter.class) | ||
| * public interface MyRestClient { | ||
| * | ||
| * @Headers({ | ||
| * @Header(name = "keep-alive", value = "300"), | ||
| * @Header(name = "cache-control", value = "64000")}) | ||
| * @Post("/test") | ||
| * void testRoute(); | ||
| * } | ||
| * </pre> | ||
| * | ||
| * </blockquote> | ||
| * | ||
| * @see Header | ||
| */ | ||
| @Retention(RetentionPolicy.CLASS) | ||
| @Target(ElementType.METHOD) | ||
| public @interface Headers { | ||
| Header[] value(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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. | ||
| */ | ||
| package org.androidannotations.rest.spring.handler; | ||
|
|
||
| import javax.lang.model.element.Element; | ||
|
|
||
| import org.androidannotations.AndroidAnnotationsEnvironment; | ||
| import org.androidannotations.ElementValidation; | ||
| import org.androidannotations.handler.BaseAnnotationHandler; | ||
| import org.androidannotations.rest.spring.annotations.Header; | ||
| import org.androidannotations.rest.spring.annotations.Headers; | ||
| import org.androidannotations.rest.spring.helper.RestSpringValidatorHelper; | ||
| import org.androidannotations.rest.spring.holder.RestHolder; | ||
|
|
||
| public class HeaderHandler extends BaseAnnotationHandler<RestHolder> { | ||
|
|
||
| private RestSpringValidatorHelper restValidatorHelper; | ||
|
|
||
| public HeaderHandler(AndroidAnnotationsEnvironment environment) { | ||
| super(Header.class, environment); | ||
| restValidatorHelper = new RestSpringValidatorHelper(environment, getTarget()); | ||
| } | ||
|
|
||
| @Override | ||
| protected void validate(Element element, ElementValidation validation) { | ||
| restValidatorHelper.elementHasOneOfRestMethodAnnotations(element, validation); | ||
|
|
||
| validatorHelper.doesNotHaveAnnotation(element, Headers.class, validation); | ||
|
Member
Author
There was a problem hiding this comment. We must define a precedence of Header and Headers and also write it in the doc if we remove this. Do we want to do that? |
||
| } | ||
|
|
||
| @Override | ||
| public void process(Element element, RestHolder holder) throws Exception { | ||
| // empty | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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. | ||
| */ | ||
| package org.androidannotations.rest.spring.handler; | ||
|
|
||
| import javax.lang.model.element.Element; | ||
|
|
||
| import org.androidannotations.AndroidAnnotationsEnvironment; | ||
| import org.androidannotations.ElementValidation; | ||
| import org.androidannotations.handler.BaseAnnotationHandler; | ||
| import org.androidannotations.rest.spring.annotations.Header; | ||
| import org.androidannotations.rest.spring.annotations.Headers; | ||
| import org.androidannotations.rest.spring.helper.RestSpringValidatorHelper; | ||
| import org.androidannotations.rest.spring.holder.RestHolder; | ||
|
|
||
| public class HeadersHandler extends BaseAnnotationHandler<RestHolder> { | ||
|
|
||
| private RestSpringValidatorHelper restValidatorHelper; | ||
|
|
||
| public HeadersHandler(AndroidAnnotationsEnvironment environment) { | ||
| super(Headers.class, environment); | ||
| restValidatorHelper = new RestSpringValidatorHelper(environment, getTarget()); | ||
| } | ||
|
|
||
| @Override | ||
| protected void validate(Element element, ElementValidation validation) { | ||
| restValidatorHelper.elementHasOneOfRestMethodAnnotations(element, validation); | ||
|
|
||
| validatorHelper.doesNotHaveAnnotation(element, Header.class, validation); | ||
| } | ||
|
|
||
| @Override | ||
| public void process(Element element, RestHolder holder) throws Exception { | ||
| // empty | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You put
validateafterprocessagain...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, it was a messy rebase.