[java-shib-attribute] branch main updated: Extend javadoc a bit.

[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-attribute.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-attribute.git;a=commit;h=0fae4c08267cf1fe6fef9c90dcc68ed242dc5c55

The following commit(s) were added to refs/heads/main by this push:
     new 0fae4c082 Extend javadoc a bit.
0fae4c082 is described below

commit 0fae4c08267cf1fe6fef9c90dcc68ed242dc5c55
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Fri Aug 16 11:17:44 2024 -0400

    Extend javadoc a bit.
---
 .../context/AttributeResolutionContext.java        | 26 +++++++++++++++-------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/shib-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/context/AttributeResolutionContext.java b/shib-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/context/AttributeResolutionContext.java
index a5eaa3102..0f0a0ae70 100644
--- a/shib-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/context/AttributeResolutionContext.java
+++ b/shib-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/context/AttributeResolutionContext.java
@@ -144,8 +144,8 @@ public final class AttributeResolutionContext extends BaseContext {
     /**
      * Get the optional "contextual" label associated with this attribute resolution.
      * 
-     * <p>Plugins/scripts/etc. can use this field to connect their behavior back to custom
-     * invocations of the resolver service.</p>
+     * <p>Plugins/scripts/etc. that run the resolver directly can use this field to
+     * control the resolver's behavior based on what component is requesting the resolution.</p>
      * 
      * @return label
      * 
@@ -171,7 +171,10 @@ public final class AttributeResolutionContext extends BaseContext {
     }
 
     /**
-     * Get the attribute issuer (me) associated with this resolution.
+     * Get the attribute issuer associated with this resolution.
+     * 
+     * <p>This is typically the identity of the system performing the resolution,
+     * i.e., the eventual issuer of any protocol messages containing the data.</p>
      * 
      * @return the attribute issuer associated with this resolution.
      */
@@ -180,7 +183,7 @@ public final class AttributeResolutionContext extends BaseContext {
     }
 
     /**
-     * Set the attribute issuer (me) associated with this resolution.
+     * Set the attribute issuer associated with this resolution.
      * 
      * @param value the attribute issuer associated with this resolution.
      * 
@@ -193,7 +196,11 @@ public final class AttributeResolutionContext extends BaseContext {
     }
 
     /**
-     * Get the attribute recipient (her) associated with this resolution.
+     * Get the attribute recipient associated with this resolution.
+     * 
+     * <p>This is typically the identity of the peer on whose behalf the resolution
+     * is being performed, i.e., the eventual recipient of any protocol messages
+     * containing the data.</p>
      * 
      * @return the attribute recipient associated with this resolution.
      */
@@ -202,7 +209,7 @@ public final class AttributeResolutionContext extends BaseContext {
     }
 
     /**
-     * Set the attribute recipient (her) associated with this resolution.
+     * Set the attribute recipient associated with this resolution.
      * 
      * @param value the attribute recipient associated with this resolution.
      * 
@@ -218,7 +225,7 @@ public final class AttributeResolutionContext extends BaseContext {
      * Get the attribute recipient grouping associated with this resolution.
      * 
      * <p>This is a protocol-independent way to represent an association between the attribute recipient
-     * and some larger group that may be relevant to attribute resolution.</p>
+     * and some larger group of recipients that may be relevant to attribute resolution.</p>
      * 
      * @return the attribute recipient group associated with this resolution
      * 
@@ -244,7 +251,10 @@ public final class AttributeResolutionContext extends BaseContext {
     }
 
     /**
-     * Get the principal associated with this resolution.
+     * Get the principal name associated with this resolution.
+     * 
+     * <p>This is usually, though not necessarily, a normalized value resulting from
+     * authentication by other software components.</p>
      * 
      * @return the principal
      */

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