You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by an...@apache.org on 2019/08/19 13:28:01 UTC
svn commit: r1865456 - in
/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal:
GroupPrincipal.java ItemBasedPrincipal.java PrincipalIterator.java
PrincipalManager.java package-info.java
Author: angela
Date: Mon Aug 19 13:28:01 2019
New Revision: 1865456
URL: http://svn.apache.org/viewvc?rev=1865456&view=rev
Log:
OAK-8547 : Nullable/Notnull Annotations for Principal Management API
Modified:
jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/GroupPrincipal.java
jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/ItemBasedPrincipal.java
jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalIterator.java
jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/package-info.java
Modified: jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/GroupPrincipal.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/GroupPrincipal.java?rev=1865456&r1=1865455&r2=1865456&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/GroupPrincipal.java (original)
+++ jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/GroupPrincipal.java Mon Aug 19 13:28:01 2019
@@ -19,6 +19,7 @@ package org.apache.jackrabbit.api.securi
import java.security.Principal;
import java.util.Enumeration;
+import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
/**
@@ -37,7 +38,7 @@ public interface GroupPrincipal extends
* @return true if the principal is a member of this group,
* false otherwise.
*/
- public boolean isMember(Principal member);
+ boolean isMember(@NotNull Principal member);
/**
* Returns an enumeration of the members in the group. This includes both
@@ -47,6 +48,7 @@ public interface GroupPrincipal extends
*
* @return an enumeration of the group members.
*/
- public Enumeration<? extends Principal> members();
+ @NotNull
+ Enumeration<? extends Principal> members();
}
Modified: jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/ItemBasedPrincipal.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/ItemBasedPrincipal.java?rev=1865456&r1=1865455&r2=1865456&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/ItemBasedPrincipal.java (original)
+++ jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/ItemBasedPrincipal.java Mon Aug 19 13:28:01 2019
@@ -16,6 +16,8 @@
*/
package org.apache.jackrabbit.api.security.principal;
+import org.jetbrains.annotations.NotNull;
+
import javax.jcr.RepositoryException;
/**
@@ -35,5 +37,6 @@ public interface ItemBasedPrincipal exte
* @throws RepositoryException If an error occurs while retrieving the
* <code>Item</code> path.
*/
+ @NotNull
String getPath() throws RepositoryException;
}
Modified: jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalIterator.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalIterator.java?rev=1865456&r1=1865455&r2=1865456&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalIterator.java (original)
+++ jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalIterator.java Mon Aug 19 13:28:01 2019
@@ -16,6 +16,8 @@
*/
package org.apache.jackrabbit.api.security.principal;
+import org.jetbrains.annotations.NotNull;
+
import javax.jcr.RangeIterator;
import java.security.Principal;
@@ -29,6 +31,7 @@ public interface PrincipalIterator exten
*
* @return the next principal
*/
+ @NotNull
Principal nextPrincipal();
}
Modified: jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java?rev=1865456&r1=1865455&r2=1865456&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java (original)
+++ jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java Mon Aug 19 13:28:01 2019
@@ -16,6 +16,9 @@
*/
package org.apache.jackrabbit.api.security.principal;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
import java.security.Principal;
/**
@@ -75,7 +78,7 @@ public interface PrincipalManager {
* @return return <code>true</code> if the principal with this name is known
* to this manager; <code>false</code> otherwise.
*/
- boolean hasPrincipal(String principalName);
+ boolean hasPrincipal(@NotNull String principalName);
/**
* Returns the principal with the given name if is known to this manager
@@ -89,7 +92,8 @@ public interface PrincipalManager {
* principal with the given name does not exist or is not accessible
* for the editing session.
*/
- Principal getPrincipal(String principalName);
+ @Nullable
+ Principal getPrincipal(@NotNull String principalName);
/**
* Gets the principals matching a simple filter expression applied against
@@ -102,7 +106,8 @@ public interface PrincipalManager {
* @return a <code>PrincipalIterator</code> over the <code>Principal</code>s
* matching the given filter.
*/
- PrincipalIterator findPrincipals(String simpleFilter);
+ @NotNull
+ PrincipalIterator findPrincipals(@Nullable String simpleFilter);
/**
* Gets the principals matching a simple filter expression applied against
@@ -122,7 +127,8 @@ public interface PrincipalManager {
* @return a <code>PrincipalIterator</code> over the <code>Principal</code>s
* matching the given filter and search type.
*/
- PrincipalIterator findPrincipals(String simpleFilter, int searchType);
+ @NotNull
+ PrincipalIterator findPrincipals(@Nullable String simpleFilter, int searchType);
/**
* Returns all <code>Principal</code>s matching the specified search type.
@@ -136,6 +142,7 @@ public interface PrincipalManager {
* @return a <code>PrincipalIterator</code> over all the <code>Principal</code>s
* matching the given search type.
*/
+ @NotNull
PrincipalIterator getPrincipals(int searchType);
/**
@@ -149,7 +156,8 @@ public interface PrincipalManager {
* @param principal the principal to return it's membership from.
* @return an iterator returning all groups the given principal is member of.
*/
- PrincipalIterator getGroupMembership(Principal principal);
+ @NotNull
+ PrincipalIterator getGroupMembership(@NotNull Principal principal);
/**
* Returns the <code>Principal</code> which is implicitly applied to
@@ -157,5 +165,6 @@ public interface PrincipalManager {
*
* @return the 'everyone' principal
*/
+ @NotNull
Principal getEveryone();
}
Modified: jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/package-info.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/package-info.java?rev=1865456&r1=1865455&r2=1865456&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/package-info.java (original)
+++ jackrabbit/oak/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/package-info.java Mon Aug 19 13:28:01 2019
@@ -18,5 +18,5 @@
/**
* Jackrabbit extensions for JAAS principals.
*/
-@org.osgi.annotation.versioning.Version("2.4.0")
+@org.osgi.annotation.versioning.Version("2.4.1")
package org.apache.jackrabbit.api.security.principal;