[java-shib-profile] branch main updated: Add ParameterName annotations to factory methods.
Scott Cantor
cantor.2 at osu.edu
Wed Aug 2 19:59:59 UTC 2023
This is an automated email from the git hooks/post-receive script.
scantor pushed a commit to branch main
in repository java-shib-profile.
View the commit online:
http://git.shibboleth.net/view/?p=java-shib-profile.git;a=commit;h=83c6501fe12e9899e984f2c3e681b0df77a2a2ec
The following commit(s) were added to refs/heads/main by this push:
new 83c6501 Add ParameterName annotations to factory methods.
83c6501 is described below
commit 83c6501fe12e9899e984f2c3e681b0df77a2a2ec
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Wed Aug 2 15:59:56 2023 -0400
Add ParameterName annotations to factory methods.
---
.../navigate/ScriptedContextLookupFunction.java | 76 ++++++++++++++--------
1 file changed, 48 insertions(+), 28 deletions(-)
diff --git a/shib-profile-api/src/main/java/net/shibboleth/profile/context/navigate/ScriptedContextLookupFunction.java b/shib-profile-api/src/main/java/net/shibboleth/profile/context/navigate/ScriptedContextLookupFunction.java
index ad7aed7..a830a1f 100644
--- a/shib-profile-api/src/main/java/net/shibboleth/profile/context/navigate/ScriptedContextLookupFunction.java
+++ b/shib-profile-api/src/main/java/net/shibboleth/profile/context/navigate/ScriptedContextLookupFunction.java
@@ -21,6 +21,7 @@ import javax.annotation.Nullable;
import javax.script.ScriptContext;
import javax.script.ScriptException;
+import net.shibboleth.shared.annotation.ParameterName;
import net.shibboleth.shared.annotation.constraint.NotEmpty;
import net.shibboleth.shared.component.ComponentInitializationException;
import net.shibboleth.shared.logic.Constraint;
@@ -123,8 +124,9 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull final Resource resource) throws ScriptException,
- IOException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @ParameterName(name="resource") final Resource resource)
+ throws ScriptException, IOException, ComponentInitializationException {
return resourceScript(engineName, resource, null);
}
@@ -141,8 +143,10 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull final Resource resource,
- @Nullable final Class<?> outputType) throws ScriptException, IOException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @ParameterName(name="resource") final Resource resource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
+ throws ScriptException, IOException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(resource);
@@ -160,9 +164,9 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws IOException if the file doesn't exist.
* @throws ComponentInitializationException if the scripting initialization fails
*/
- @Nonnull
- public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull final Resource resource)
- throws ScriptException, IOException, ComponentInitializationException {
+ @Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(
+ @Nonnull @ParameterName(name="resource") final Resource resource)
+ throws ScriptException, IOException, ComponentInitializationException {
return resourceScript(DEFAULT_ENGINE, resource, null);
}
@@ -177,9 +181,10 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws IOException if the file doesn't exist.
* @throws ComponentInitializationException if the scripting initialization fails
*/
- @Nonnull
- public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull final Resource resource,
- @Nullable final Class<?> outputType) throws ScriptException, IOException, ComponentInitializationException {
+ @Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(
+ @Nonnull @ParameterName(name="resource") final Resource resource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
+ throws ScriptException, IOException, ComponentInitializationException {
return resourceScript(DEFAULT_ENGINE, resource, outputType);
}
@@ -193,8 +198,9 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull @NotEmpty final String scriptSource)
- throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource)
+ throws ScriptException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(scriptSource);
@@ -213,8 +219,10 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull @NotEmpty final String scriptSource,
- @Nullable final Class<?> outputType) throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
+ throws ScriptException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(scriptSource);
@@ -231,7 +239,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(
- @Nonnull @NotEmpty final String scriptSource) throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource)
+ throws ScriptException, ComponentInitializationException {
return inlineScript(DEFAULT_ENGINE, scriptSource);
}
@@ -245,7 +254,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(
- @Nonnull @NotEmpty final String scriptSource, @Nullable final Class<?> outputType)
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
throws ScriptException, ComponentInitializationException {
return inlineScript(DEFAULT_ENGINE, scriptSource, outputType);
}
@@ -261,8 +271,9 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull final Resource resource) throws ScriptException,
- IOException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @ParameterName(name="resource") final Resource resource)
+ throws ScriptException, IOException, ComponentInitializationException {
return resourceMessageContextScript(engineName, resource, null);
}
@@ -278,8 +289,10 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull final Resource resource,
- @Nullable final Class<?> outputType) throws ScriptException, IOException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @ParameterName(name="resource") final Resource resource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
+ throws ScriptException, IOException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(resource);
@@ -298,7 +311,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(
- @Nonnull final Resource resource) throws ScriptException, IOException, ComponentInitializationException {
+ @Nonnull @ParameterName(name="resource") final Resource resource)
+ throws ScriptException, IOException, ComponentInitializationException {
return resourceMessageContextScript(DEFAULT_ENGINE, resource, null);
}
@@ -313,7 +327,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(
- @Nonnull final Resource resource, @Nullable final Class<?> outputType)
+ @Nonnull @ParameterName(name="resource") final Resource resource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
throws ScriptException, IOException, ComponentInitializationException {
return resourceMessageContextScript(DEFAULT_ENGINE, resource, outputType);
}
@@ -328,8 +343,9 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull @NotEmpty final String scriptSource)
- throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource)
+ throws ScriptException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(scriptSource);
@@ -348,8 +364,10 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(
- @Nonnull @NotEmpty final String engineName, @Nonnull @NotEmpty final String scriptSource,
- @Nullable final Class<?> outputType) throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="engineName") final String engineName,
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
+ throws ScriptException, ComponentInitializationException {
final EvaluableScript script = new EvaluableScript();
script.setEngineName(engineName);
script.setScript(scriptSource);
@@ -366,7 +384,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(
- @Nonnull @NotEmpty final String scriptSource) throws ScriptException, ComponentInitializationException {
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource)
+ throws ScriptException, ComponentInitializationException {
return inlineMessageContextScript(DEFAULT_ENGINE, scriptSource);
}
@@ -380,7 +399,8 @@ public class ScriptedContextLookupFunction<T extends BaseContext> extends Abstra
* @throws ComponentInitializationException if the scripting initialization fails
*/
@Nonnull public static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(
- @Nonnull @NotEmpty final String scriptSource, @Nullable final Class<?> outputType)
+ @Nonnull @NotEmpty @ParameterName(name="scriptSource") final String scriptSource,
+ @Nullable @ParameterName(name="outputType") final Class<?> outputType)
throws ScriptException, ComponentInitializationException {
return inlineMessageContextScript(DEFAULT_ENGINE, scriptSource, outputType);
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list