[java-shib-shared] branch main updated: IDP-2126 - Admin flow to report on config settings

[Scott Cantor]

This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=9784258ca84ff0353fe1b11085276b6cf2abb72b

The following commit(s) were added to refs/heads/main by this push:
     new 9784258c IDP-2126 - Admin flow to report on config settings
9784258c is described below

commit 9784258ca84ff0353fe1b11085276b6cf2abb72b
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Jun 12 11:36:08 2023 -0400

    IDP-2126 - Admin flow to report on config settings
    
    https://shibboleth.atlassian.net/browse/IDP-2126
    
    Add an annnotation to denote "reportable" config settings and names.
---
 .../shared/annotation/ConfigurationSetting.java    | 46 ++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/shib-support/src/main/java/net/shibboleth/shared/annotation/ConfigurationSetting.java b/shib-support/src/main/java/net/shibboleth/shared/annotation/ConfigurationSetting.java
new file mode 100644
index 00000000..84a740a7
--- /dev/null
+++ b/shib-support/src/main/java/net/shibboleth/shared/annotation/ConfigurationSetting.java
@@ -0,0 +1,46 @@
+/*
+ * Licensed to the University Corporation for Advanced Internet Development,
+ * Inc. (UCAID) under one or more contributor license agreements.  See the
+ * NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The UCAID licenses this file to You 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 net.shibboleth.shared.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Identifies a configuration setting that a method exposes.
+ * 
+ * <p>Used to inform diagnostic features that introspect settings.</p>
+ * 
+ * @since 9.0.0
+ */
+ at Documented
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target({ElementType.METHOD, })
+public @interface ConfigurationSetting {
+
+    /**
+     * The name for this configuration setting.
+     * 
+     * @return name of the setting
+     */
+    @Nonnull public String name(); 
+}
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.