Skip to main content

[identity-api-spec commits] [identity-api-spec~git:ae66c413] clarified semantics of search when 0 attributeSelectors are passed as arg

  • From: monzillo@...
  • To: commits@...
  • Subject: [identity-api-spec commits] [identity-api-spec~git:ae66c413] clarified semantics of search when 0 attributeSelectors are passed as arg
  • Date: Thu, 3 Jan 2013 14:52:31 +0000

Project:    identity-api-spec
Repository: git
Revision:   ae66c4130a71e74f77c2985aee4189fb547f31ca
Author:     monzillo
Date:       2013-01-03 14:50:57 UTC
Link:       

Log Message:
------------
clarified semantics of PropertySelectors in getPredicateAttribute
added unregisterRepositoryAgent method
clarified semantics of search when 0 attributeSelectors are passed as 
arguments
clarified semantics of getAttributeReferences and getAttributes when 0 
propertySelectors are passed as arguments


Revisions:
----------
2217d45f80c35431581ef96c5bc00f767f5bfae6
3ae8a278890ce772ada2bbdc0e9cec8d6aa89c60
ae66c4130a71e74f77c2985aee4189fb547f31ca


Modified Paths:
---------------
IdentityApiGit/src/main/java/javax/security/identity/client/LookupService.java
IdentityApiGit/src/main/java/javax/security/identity/client/ProviderLookupService.java
IdentityApiGit/src/main/java/javax/security/identity/provider/AttributeLookupService.java


Diffs:
------
diff --git 
a/IdentityApiGit/src/main/java/javax/security/identity/client/LookupService.java
 
b/IdentityApiGit/src/main/java/javax/security/identity/client/LookupService.java
index 2cad7c8..49904bf 100644
--- 
a/IdentityApiGit/src/main/java/javax/security/identity/client/LookupService.java
+++ 
b/IdentityApiGit/src/main/java/javax/security/identity/client/LookupService.java
@@ -39,14 +39,16 @@ public interface LookupService extends 
ProviderLookupService, AttributeLookupSer
      *
      * @param propertySelectors an array of 0 or more predicates that 
represent
      * the property name and property value relationships that will be 
evaluated
-     * to determine the attribute value.
+     * to determine the attribute value. if no propertySelector arguments 
are 
+     * passed, then the attribute value is established based solely on the 
+     * attributeSelector.
      *
      * @return a PredicateAttribute whose value represents whether or not the
      * attributes of the referenced entity satisfy the argument selectors. 
For
      * the getAttributeValue().getValue() method of the attribute to return
      * Boolean.TRUE, at least one attribute of the referenced entity must
      * satisfy the attribute selector and contain at least one property that
-     * satisfies each of the property selectors.
+     * satisfies each of the property selectors (if there are property 
selectors).
      *
      */
     PredicateAttribute getPredicateAttribute(IDEntityReference entity,
diff --git 
a/IdentityApiGit/src/main/java/javax/security/identity/client/ProviderLookupService.java
 
b/IdentityApiGit/src/main/java/javax/security/identity/client/ProviderLookupService.java
index 0c61a69..cbfd351 100644
--- 
a/IdentityApiGit/src/main/java/javax/security/identity/client/ProviderLookupService.java
+++ 
b/IdentityApiGit/src/main/java/javax/security/identity/client/ProviderLookupService.java
@@ -29,7 +29,7 @@ public interface ProviderLookupService {
     
     /**
      * Register the source of an AttributeRepository (i.e, a RepositoryAgent)
-     * with the AttributeLookupService
+     * with the ProviderLookupService
      * 
      * @param agent an implementation of the RepositoryAgent Class that is
      * able to return the AttributeRepository named in repositoryName 
parameter.
@@ -37,12 +37,25 @@ public interface ProviderLookupService {
      * @param repositoryName identifies an AttributeRepository known to the
      * RepositoryAgent that is being registered. 
      * 
-     * @return a ProviderLookupContext that can be used to request the
-     * corresponding AttributeProvider from the AttributeLookupService.
+     * @return a ProviderLookupContext that can be used to reference or 
unregister
+     * the corresponding AttributeProvider from the ProviderLookupService.
      */
     
     ProviderLookupContext registerRepositoryAgent(RepositoryAgent agent, 
String repositoryName);
-
+    
+    /**
+     * Unregister an AttributeRepository from the ProviderLookupService
+     *  
+     * @param RepositoryDescriptor that identifies the Attribute that is to 
be
+     * unregistered by RepositoryAgent(name) and RepositoryName.
+     * 
+     * @return boolean indicating whether (true) or not (false) the 
+     * the AttributeRepository corresponding to the descriptor has been
+     * unregistered.
+     */
+    
+    boolean unregisterRepositoryAgent(RepositoryDescriptor descriptor);
+    
     /**
      * Return an AttributeProvider that is bound to the range of entities
      * contained in the repository identified by the ProviderLookupContext.
diff --git 
a/IdentityApiGit/src/main/java/javax/security/identity/provider/AttributeLookupService.java
 
b/IdentityApiGit/src/main/java/javax/security/identity/provider/AttributeLookupService.java
index c233196..a6e3720 100644
--- 
a/IdentityApiGit/src/main/java/javax/security/identity/provider/AttributeLookupService.java
+++ 
b/IdentityApiGit/src/main/java/javax/security/identity/provider/AttributeLookupService.java
@@ -20,7 +20,6 @@ import javax.security.identity.IDAttribute;
 import javax.security.identity.IDAttributeReference;
 import javax.security.identity.IDEntityReference;
 import javax.security.identity.client.AttributeSelector;
-import javax.security.identity.client.PredicateAttribute;
 import javax.security.identity.client.PropertySelector;
 
 /**
@@ -38,10 +37,12 @@ public interface AttributeLookupService {
      * @param entitySelectors an array of predicates that represent the
      * attribute name and value relationships that identify the entities to 
be
      * returned. For an entity to be selected, it must contain at least one
-     * attribute that satisfies each of the existence predicates.
+     * attribute that satisfies each of the existence predicates. if no 
+     * entitySelector arguments are passed, then no entities are to be 
selected
+     * by the search.
      *
      * @return a Collection of EntityReferences that can be used to interact
-     * with the entities that satisfy the query.
+     * with the entities that satisfy the query. 
      */
     Collection<IDEntityReference> search(AttributeSelector ... 
entitySelectors);
 
@@ -62,7 +63,8 @@ public interface AttributeLookupService {
      * property name and property value relationships that must be satisfied
      * by the selected attributes. For an attribute to be selected, it must
      * contain at least one property that satisfies each of the property 
-     * selectors.
+     * selectors. if no propertySelector arguments are passed, then 
attributes
+     * are to be selected based solely on the attributeSelector.
      * 
      * @return a Collection of AttributeReferences that can be used to 
interact
      * with the attributes that satisfy the selectors.
@@ -84,7 +86,9 @@ public interface AttributeLookupService {
      * @param propertySelectors an array of predicates that represent the
      * property name and property value relationships that must be satisfied
      * by the selected attributes. For an attribute to be selected, it must
-     * contain at least one property that satisfies each of property 
selectors. 
+     * contain at least one property that satisfies each of property 
selectors.
+     * if no propertySelector arguments are passed, then attributes
+     * are to be selected based solely on the attributeSelector.
      * 
      * @return A collection containing the attributes selected from the 
entity.
      */
@@ -105,14 +109,16 @@ public interface AttributeLookupService {
      *
      * @param propertySelectors an array of 0 or more predicates that 
represent
      * the property name and property value relationships that will be 
evaluated
-     * to determine the attribute value. 
+     * to determine the attribute value. if no propertySelector arguments 
are 
+     * passed, then attributes are to be selected based solely on the
+     * attributeSelector.
      * 
      * @return a PredicateAttribute whose value represents whether or not the
      * attributes of the referenced entity satisfy the argument selectors. 
For
      * the getAttributeValue().getValue() method of the attribute to return
      * Boolean.TRUE, at least one attribute of the referenced entity must
      * satisfy the attribute selector and contain at least one property that
-     * satisfies each of the property selectors.
+     * satisfies each of the property selectors (if there are property 
selectors).
      * 
      *
     PredicateAttribute getPredicateAttribute(IDEntityReference entity, 
AttributeSelector attributeSelector, PropertySelector ... propertySelectors);




[identity-api-spec commits] [identity-api-spec~git:ae66c413] clarified semantics of search when 0 attributeSelectors are passed as arg

monzillo 01/03/2013
 
 
Close
loading
Please Confirm
Close