Author: angela
Date: Thu Oct 15 08:20:54 2015
New Revision: 1708738
URL: http://svn.apache.org/viewvc?rev=1708738&view=rev
Log:
OAK-3518 : Consistently add annotations to DefaultSync* classes
Modified:
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncConfig.java
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncContext.java
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncResultImpl.java
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/package-info.java
Modified:
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncConfig.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncConfig.java?rev=1708738&r1=1708737&r2=1708738&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncConfig.java
(original)
+++
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncConfig.java
Thu Oct 15 08:20:54 2015
@@ -50,6 +50,7 @@ public class DefaultSyncConfig {
* @return {@code this}
* @see #getName()
*/
+ @Nonnull
public DefaultSyncConfig setName(@Nonnull String name) {
this.name = name;
return this;
@@ -123,7 +124,7 @@ public class DefaultSyncConfig {
* @see #getAutoMembership()
*/
@Nonnull
- public Authorizable setAutoMembership(String ... autoMembership) {
+ public Authorizable setAutoMembership(@Nonnull String ...
autoMembership) {
this.autoMembership = new HashSet<String>();
for (String groupName: autoMembership) {
if (!groupName.trim().isEmpty()) {
@@ -164,7 +165,7 @@ public class DefaultSyncConfig {
* @see #getPropertyMapping()
*/
@Nonnull
- public Authorizable setPropertyMapping(Map<String, String>
propertyMapping) {
+ public Authorizable setPropertyMapping(@Nonnull Map<String, String>
propertyMapping) {
this.propertyMapping = propertyMapping;
return this;
}
@@ -186,7 +187,7 @@ public class DefaultSyncConfig {
* @see #getPathPrefix()
*/
@Nonnull
- public Authorizable setPathPrefix(String pathPrefix) {
+ public Authorizable setPathPrefix(@Nonnull String pathPrefix) {
this.pathPrefix = pathPrefix;
return this;
}
Modified:
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncContext.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncContext.java?rev=1708738&r1=1708737&r2=1708738&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncContext.java
(original)
+++
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncContext.java
Thu Oct 15 08:20:54 2015
@@ -95,7 +95,7 @@ public class DefaultSyncContext implemen
protected final Value nowValue;
- public DefaultSyncContext(DefaultSyncConfig config,
ExternalIdentityProvider idp, UserManager userManager, ValueFactory
valueFactory) {
+ public DefaultSyncContext(@Nonnull DefaultSyncConfig config, @Nonnull
ExternalIdentityProvider idp, @Nonnull UserManager userManager, @Nonnull
ValueFactory valueFactory) {
this.config = config;
this.idp = idp;
this.userManager = userManager;
@@ -225,6 +225,7 @@ public class DefaultSyncContext implemen
return forceGroupSync;
}
+ @Override
@Nonnull
public SyncContext setForceGroupSync(boolean forceGroupSync) {
this.forceGroupSync = forceGroupSync;
@@ -357,7 +358,7 @@ public class DefaultSyncContext implemen
* @throws SyncException if the repository contains a colliding
authorizable with the same name.
*/
@CheckForNull
- protected <T extends Authorizable> T getAuthorizable(@Nonnull
ExternalIdentity external, Class<T> type)
+ protected <T extends Authorizable> T getAuthorizable(@Nonnull
ExternalIdentity external, @Nonnull Class<T> type)
throws RepositoryException, SyncException {
Authorizable authorizable =
userManager.getAuthorizable(external.getId());
if (authorizable == null) {
@@ -469,7 +470,7 @@ public class DefaultSyncContext implemen
* @param depth recursion depth.
* @throws RepositoryException
*/
- protected void syncMembership(ExternalIdentity external, Authorizable
auth, long depth)
+ protected void syncMembership(@Nonnull ExternalIdentity external, @Nonnull
Authorizable auth, long depth)
throws RepositoryException {
if (depth <= 0) {
return;
@@ -568,7 +569,7 @@ public class DefaultSyncContext implemen
* @param member the authorizable
* @param groups set of groups.
*/
- protected void applyMembership(Authorizable member, Set<String> groups)
throws RepositoryException {
+ protected void applyMembership(@Nonnull Authorizable member, @Nonnull
Set<String> groups) throws RepositoryException {
for (String groupName: groups) {
Authorizable group = userManager.getAuthorizable(groupName);
if (group == null) {
@@ -590,7 +591,7 @@ public class DefaultSyncContext implemen
* @param mapping the property mapping
* @throws RepositoryException if an error occurs
*/
- protected void syncProperties(ExternalIdentity ext, Authorizable auth,
Map<String, String> mapping)
+ protected void syncProperties(@Nonnull ExternalIdentity ext, @Nonnull
Authorizable auth, @Nonnull Map<String, String> mapping)
throws RepositoryException {
Map<String, ?> properties = ext.getProperties();
for (Map.Entry<String, String> entry: mapping.entrySet()) {
@@ -625,7 +626,7 @@ public class DefaultSyncContext implemen
* @param type debug message type
* @return {@code true} if the authorizable needs sync
*/
- protected boolean isExpired(Authorizable auth, long expirationTime, String
type) throws RepositoryException {
+ protected boolean isExpired(@Nonnull Authorizable auth, long
expirationTime, @Nonnull String type) throws RepositoryException {
Value[] values = auth.getProperty(REP_LAST_SYNCED);
if (values == null || values.length == 0) {
if (log.isDebugEnabled()) {
@@ -688,7 +689,7 @@ public class DefaultSyncContext implemen
* @throws RepositoryException if an error occurs
*/
@CheckForNull
- protected Value[] createValues(Collection<?> propValues) throws
RepositoryException {
+ protected Value[] createValues(@Nonnull Collection<?> propValues) throws
RepositoryException {
List<Value> values = new ArrayList<Value>();
for (Object obj : propValues) {
Value v = createValue(obj);
Modified:
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncResultImpl.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncResultImpl.java?rev=1708738&r1=1708737&r2=1708738&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncResultImpl.java
(original)
+++
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/DefaultSyncResultImpl.java
Thu Oct 15 08:20:54 2015
@@ -18,6 +18,7 @@ package org.apache.jackrabbit.oak.spi.se
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import
org.apache.jackrabbit.oak.spi.security.authentication.external.SyncResult;
@@ -30,22 +31,24 @@ public class DefaultSyncResultImpl imple
private Status status = Status.NOP;
- public DefaultSyncResultImpl(DefaultSyncedIdentity id, Status status) {
+ public DefaultSyncResultImpl(@Nullable DefaultSyncedIdentity id, @Nonnull
Status status) {
this.id = id;
this.status = status;
}
+ @Override
@CheckForNull
public DefaultSyncedIdentity getIdentity() {
return id;
}
+ @Override
@Nonnull
public Status getStatus() {
return status;
}
- public void setStatus(Status status) {
+ public void setStatus(@Nonnull Status status) {
this.status = status;
}
}
\ No newline at end of file
Modified:
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/package-info.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/package-info.java?rev=1708738&r1=1708737&r2=1708738&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/package-info.java
(original)
+++
jackrabbit/oak/trunk/oak-auth-external/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/external/basic/package-info.java
Thu Oct 15 08:20:54 2015
@@ -14,7 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-@Version("1.0.0")
+@Version("1.0.1")
@Export
package org.apache.jackrabbit.oak.spi.security.authentication.external.basic;
