diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPool.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPool.java index 23b0f330..eae5a995 100644 --- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPool.java +++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPool.java @@ -20,6 +20,7 @@ * "Portions Copyrighted [year] [name of copyright owner]" * ==================== * Portions Copyrighted 2010-2015 ForgeRock AS. + * Portions Copyright 2018 Wren Security. */ package org.identityconnectors.framework.impl.api.local; @@ -346,8 +347,8 @@ private PooledObject borrowIdleObject() throws InterruptedException { /** * Closes any idle objects in the pool. - *
- * Existing active objects will remain alive and be allowed to shutdown + * + *Existing active objects will remain alive and be allowed to shutdown
* gracefully, but no more objects will be allocated.
*/
public void shutdown() {
diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPoolHandler.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPoolHandler.java
index 1890340f..0a39c6c3 100644
--- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPoolHandler.java
+++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/ObjectPoolHandler.java
@@ -20,6 +20,7 @@
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
* Portions Copyrighted 2010-2013 ForgeRock AS.
+ * Portions Copyright 2018 Wren Security.
*/
package org.identityconnectors.framework.impl.api.local;
@@ -31,9 +32,9 @@ public interface ObjectPoolHandler This class can validate and if necessary it changes the
+ * {@code original} configuration.
*
* @param original
* custom configured instance.
@@ -43,8 +44,8 @@ public interface ObjectPoolHandler This method is called whenever a new instance is needed.
*
* @return new instance of T.
*/
@@ -52,8 +53,8 @@ public interface ObjectPoolHandler This method is invoked on head instances to make sure they can be
* borrowed from the pool.
*
* @param object
@@ -63,8 +64,8 @@ public interface ObjectPoolHandler This method is invoked on every instance when it is being "dropped" from
* the pool (whether due to the response from {@link #testObject(Object)},
* or for reasons specific to the pool implementation.)
*
@@ -75,8 +76,8 @@ public interface ObjectPoolHandler Existing active objects will remain alive and be allowed to shutdown
* gracefully, but no more objects will be allocated.
*/
public void shutdown();
diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/AuthenticationImpl.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/AuthenticationImpl.java
index 152a5803..f7e3491e 100644
--- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/AuthenticationImpl.java
+++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/AuthenticationImpl.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -44,8 +45,6 @@ public AuthenticationImpl(final ConnectorOperationalContext context,
/**
* Authenticate using the basic credentials.
- *
- * @see AuthenticationOpTests#authenticate(String, String)
*/
public Uid authenticate(final ObjectClass objectClass, final String username,
final GuardedString password,
diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/BatchImpl.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/BatchImpl.java
index 07d364ec..f2257a8d 100644
--- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/BatchImpl.java
+++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/api/local/operations/BatchImpl.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -69,9 +70,6 @@ public BatchImpl(final ConnectorOperationalContext context, final Connector conn
this.referenceCounter = referenceCounter;
}
- /**
- * {@inherit}
- */
public Subscription executeBatch(final List This Exception is not allowed for use by Connectors
*
- *
- * This type of exception is not allowed to be serialise because this exception
- * represents any after deserialization.
+ * This type of exception is not allowed to be serialise because this
+ * exception represents any after deserialization.
*
* This code example show how to get the remote stack trace and how to use the
* same catches to handle the exceptions regardless its origin.
@@ -64,7 +62,7 @@
* t.printStackTrace();
* }
* }
- * The messages are extracted for easy extensibility in the future.
*
* @since 1.5
*/
-package org.forgerock.openicf.common.protobuf;
\ No newline at end of file
+package org.forgerock.openicf.common.protobuf;
diff --git a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/LocalRequest.java b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/LocalRequest.java
index 1de8fa8b..d6761d2c 100644
--- a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/LocalRequest.java
+++ b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/LocalRequest.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -29,10 +30,9 @@
/**
* A LocalRequest represents a remotely requested procedure call locally.
- * The {@link RemoteRequest} and LocalRequest are the representation of the
+ * same call on caller and receiver side.
*/
public abstract class LocalRequest The {@link org.forgerock.openicf.common.rpc.RemoteRequest} may depends on
* which {@link org.forgerock.openicf.common.rpc.RemoteConnectionGroup}
* distributes the request. Instance of this class is provided to
* {@link org.forgerock.openicf.common.rpc.RemoteRequestFactory} to produce the
@@ -41,12 +42,10 @@ public interface RemoteConnectionContext RemoteConnectionGroups holds the
* {@link org.forgerock.openicf.common.rpc.RemoteConnectionHolder} which are
* connected to the remotely paired RemoteConnectionGroups.
- * The local instance of {@link RemoteConnectionGroup#remoteRequests} paired
* with the remote instance of {@link RemoteConnectionGroup#localRequests}.
*
*/
diff --git a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteConnectionHolder.java b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteConnectionHolder.java
index 3d93e0e3..07e095cc 100644
--- a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteConnectionHolder.java
+++ b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteConnectionHolder.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -29,10 +30,10 @@
/**
* A RemoteConnectionHolder is a wrapper class for the underlying communication
* chanel.
- * The API is detached from the real underlying protocol and abstracted
+ * through this interface. The message transmitted via this implementation
+ * should trigger the appropriate method on
* {@link org.forgerock.openicf.common.rpc.MessageListener}.
*
*/
diff --git a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteRequest.java b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteRequest.java
index 4222675b..c875232b 100644
--- a/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteRequest.java
+++ b/connector-framework-rpc/src/main/java/org/forgerock/openicf/common/rpc/RemoteRequest.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -36,9 +37,9 @@
/**
* A RemoteRequest represents a locally requested procedure call executed
* remotely.
- * The RemoteRequest and {@link LocalRequest} are the representation of the
+ * same call on caller and receiver side.
*
*/
public abstract class RemoteRequest The {@link org.forgerock.openicf.common.rpc.RemoteRequestFactory} is used
+ * to create a {@link org.forgerock.openicf.common.rpc.RemoteConnectionContext}
* aware {@link org.forgerock.openicf.common.rpc.RemoteRequest} which will be
* delivered.
- * The implementation may hold multiple transmission channels and try all to
* deliver the message before if fails.
- * The failed delivery signaled with null empty to avoid the expensive Throw
+ * and Catch especially when many implementation are chained together.
*
* @see org.forgerock.openicf.common.rpc.FailoverLoadBalancingAlgorithm
* @see org.forgerock.openicf.common.rpc.RoundRobinLoadBalancingAlgorithm
diff --git a/connector-framework-server/src/main/java/org/forgerock/openicf/framework/async/AsyncConnectorInfoManager.java b/connector-framework-server/src/main/java/org/forgerock/openicf/framework/async/AsyncConnectorInfoManager.java
index 2aedba60..452c8ecb 100644
--- a/connector-framework-server/src/main/java/org/forgerock/openicf/framework/async/AsyncConnectorInfoManager.java
+++ b/connector-framework-server/src/main/java/org/forgerock/openicf/framework/async/AsyncConnectorInfoManager.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -41,7 +42,7 @@ public interface AsyncConnectorInfoManager extends ConnectorInfoManager {
/**
* Add a promise which will be fulfilled with the
* {@link org.identityconnectors.framework.api.ConnectorInfo} for the given
- * {@ConnectorKey}.
+ * {@link ConnectorKey}.
*
* Add a Promise which will be fulfilled immediately if the
* {@link org.identityconnectors.framework.api.ConnectorInfo} is maintained
@@ -55,7 +56,7 @@ public interface AsyncConnectorInfoManager extends ConnectorInfoManager {
/**
* Add a promise which will be fulfilled with the
* {@link org.identityconnectors.framework.api.ConnectorInfo} for the given
- * {@ConnectorKeyRange}.
+ * {@link ConnectorKeyRange}.
*
* Add a Promise which will be fulfilled immediately if the
* {@link org.identityconnectors.framework.api.ConnectorInfo} is maintained
diff --git a/connector-framework-server/src/main/java/org/forgerock/openicf/framework/osgi/internal/AsyncOsgiConnectorInfoManagerImpl.java b/connector-framework-server/src/main/java/org/forgerock/openicf/framework/osgi/internal/AsyncOsgiConnectorInfoManagerImpl.java
index 8f30bb6c..06feea4d 100644
--- a/connector-framework-server/src/main/java/org/forgerock/openicf/framework/osgi/internal/AsyncOsgiConnectorInfoManagerImpl.java
+++ b/connector-framework-server/src/main/java/org/forgerock/openicf/framework/osgi/internal/AsyncOsgiConnectorInfoManagerImpl.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -65,7 +66,6 @@
/**
* The OSGi ConnectorInfoManager Implementation ...
- * It will try to load the class in the following order:
* This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the reader and catch
+ * any {@link IOException} which may be thrown and ignore it.
*
* @param reader
* Reader to close
@@ -90,10 +91,10 @@ public static void quietClose(final Reader reader) {
/**
* Quietly closes the stream.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the stream and catch
+ * any {@link IOException} which may be thrown.
*
* @param stream
* Stream to close
@@ -110,10 +111,10 @@ public static void quietClose(final InputStream stream) {
/**
* Quietly closes the writer.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the Writer and catch
+ * any {@link IOException} which may be thrown.
*
* @param writer
* Writer to close
@@ -130,10 +131,10 @@ public static void quietClose(final Writer writer) {
/**
* Quietly closes the stream.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the stream and catch
+ * any {@link IOException} which may be thrown.
*
* @param stream
* Stream to close
@@ -150,10 +151,10 @@ public static void quietClose(final OutputStream stream) {
/**
* Quietly closes the statement.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the statement and
+ * catch any {@link SQLException} which may be thrown.
*
* @param stmt
* Statement to close
@@ -171,10 +172,10 @@ public static void quietClose(final Statement stmt) {
/**
* Quietly closes the connection.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the connection and
+ * catch any {@link SQLException} which may be thrown.
*
* @param conn
* Connection to close
@@ -192,10 +193,10 @@ public static void quietClose(final Connection conn) {
/**
* Quietly closes the resultset.
- * This avoids having to handle exceptions, and then inside of the
+ * exception handling have a try catch block to close the connection and
+ * catch any {@link SQLException} which may be thrown.
*
* @param resultset
* ResultSet to close
diff --git a/connector-framework/src/main/java/org/identityconnectors/common/VersionRange.java b/connector-framework/src/main/java/org/identityconnectors/common/VersionRange.java
index 0978813c..84c3df05 100644
--- a/connector-framework/src/main/java/org/identityconnectors/common/VersionRange.java
+++ b/connector-framework/src/main/java/org/identityconnectors/common/VersionRange.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013-2015 ForgeRock AS. All Rights Reserved
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -26,15 +27,13 @@
/**
* A version range is an interval describing a set of {@link Version versions}.
- * A range has a left (lower) endpoint and a right (upper) endpoint. Each
* endpoint can be open (excluded from the set) or closed (included in the set).
*
- *
- * {@code VersionRange} objects are immutable.
+ * {@code VersionRange} objects are immutable.
*
* @author Laszlo Hordos
- * @Immutable
* @since 1.4
*/
public class VersionRange {
diff --git a/connector-framework/src/main/java/org/identityconnectors/common/XmlUtil.java b/connector-framework/src/main/java/org/identityconnectors/common/XmlUtil.java
index ed32ce16..22640cf1 100644
--- a/connector-framework/src/main/java/org/identityconnectors/common/XmlUtil.java
+++ b/connector-framework/src/main/java/org/identityconnectors/common/XmlUtil.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -93,8 +94,8 @@ public InputSource resolveEntity(String publicID, String systemID) {
/**
* Return the value of an attribute on an element.
- * The DOM getAttribute method returns an empty string if the attribute
* doesn't exist. Here, we detect this and return null.
*/
public static String getAttribute(Element e, String name) {
@@ -213,17 +214,17 @@ private static Text findText(Node node, boolean ignoreEmpty) {
/**
* Return the content of the given element.
- * We will descend to an arbitrary depth looking for the first text node.
+ *
+ * Note that the parser may break what was originally a single string of
* pcdata into multiple adjacent text nodes. Xerces appears to do this when
* it encounters a '$' in the text, not sure if there is specified behavior,
* or if its parser specific.
- * Here, we will congeal adjacent text nodes.
+ *
+ * We will NOT ignore text nodes that have only whitespace.
*/
public static String getContent(Element e) {
diff --git a/connector-framework/src/main/java/org/identityconnectors/common/l10n/CurrentLocale.java b/connector-framework/src/main/java/org/identityconnectors/common/l10n/CurrentLocale.java
index 5a2f4ffc..fb3bcabf 100644
--- a/connector-framework/src/main/java/org/identityconnectors/common/l10n/CurrentLocale.java
+++ b/connector-framework/src/main/java/org/identityconnectors/common/l10n/CurrentLocale.java
@@ -20,6 +20,7 @@
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
* Portions Copyrighted 2013 ConnId
+ * Portions Copyright 2018 Wren Security.
*/
package org.identityconnectors.common.l10n;
@@ -29,8 +30,8 @@
* Thread local variable that impacts localization of all messages in the
* connector framework. This is roughly equivalent to .Net's
* Thread.CurrentCulture.
- * Note that this is an inheritable thread local so it is automatically
* inherited from parent to child thread. Of course, if the child thread is part
* of a thread pool, you will still need to manually propagate from parent to
* child.
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/api/APIConfiguration.java b/connector-framework/src/main/java/org/identityconnectors/framework/api/APIConfiguration.java
index 06e65215..70d5c108 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/api/APIConfiguration.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/api/APIConfiguration.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -56,7 +57,6 @@ public interface APIConfiguration {
*
* @param changeListener
* the callback handler to receive the change event.
- * @return a closeable to unregister the change listener.
*/
void setChangeListener(ConfigurationPropertyChangeListener changeListener);
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/api/ConnectorInfoManagerFactory.java b/connector-framework/src/main/java/org/identityconnectors/framework/api/ConnectorInfoManagerFactory.java
index 995d622b..912c9d97 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/api/ConnectorInfoManagerFactory.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/api/ConnectorInfoManagerFactory.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -96,8 +97,8 @@ public static synchronized ConnectorInfoManagerFactory getInstance() {
* NOTICE: This method is an early specification of the Events API for
* 1.2.x.x version. Use carefully, this package may change before the final
* 1.2.0.0 release.
- * As now the {@code ConnectorInfoManager} MUST implement the
* {@link Runnable} to connect to the remote connector server. NOTE:
* The results from this call are automatically cached and keyed by the
* RemoteFrameworkConnectionInfo passed in. To clear the cache, call
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/api/operations/batch/CreateBatchTask.java b/connector-framework/src/main/java/org/identityconnectors/framework/api/operations/batch/CreateBatchTask.java
index d306797e..9c533559 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/api/operations/batch/CreateBatchTask.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/api/operations/batch/CreateBatchTask.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -64,16 +65,10 @@ public CreateBatchTask(ObjectClass objectClass, Set This exception is thrown by Connector if authentication failed. For
+ * example, a Use this only if the created object can not be deleted. The
+ * best-practice should always be the Connector implementation reverts the
+ * changes if the operation failed.
*
* @param message
* the detail message (which is saved for later retrieval by the
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/UnknownUidException.java b/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/UnknownUidException.java
index f8db3f32..fa70a458 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/UnknownUidException.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/UnknownUidException.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -28,8 +29,8 @@
/**
* Thrown when a {@link Uid} that is specified as input to a connector operation
* identifies no object on the target resource.
- * When implementing {@code AuthenticateOp} this exception may be thrown by a
* Connector if it is unable to locate an account necessary to perform
* authentication.
*
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Schema.java b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Schema.java
index ad4f15ed..c8288434 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Schema.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Schema.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -46,7 +47,7 @@
* Experimental type to support better event mechanism where it's
+ * possible.
*
* @see #CREATE_OR_UPDATE
* @since 1.4
@@ -58,8 +60,9 @@ public enum SyncDeltaType {
/**
* The change represents a UPDATE in the resource.
- * Experimental type to support better event mechanism where it's
+ * possible.
*
* @see #CREATE_OR_UPDATE
* @since 1.4
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Uid.java b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Uid.java
index 2a3265c3..8c489710 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Uid.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/Uid.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -36,8 +37,8 @@
* A single-valued attribute that represents the unique identifier of an
* object within the name-space of the target resource. If possible, this unique
* identifier also should be immutable.
- * When an application creates an object on a target resource, the
* {@link CreateApiOp#create create} operation returns as its result the
* Ideally, the value of {@link Uid} by definition must be a single-valued attribute. Its value
+ * must always convert to a string, regardless of the underlying type of the
+ * native identifier on the target. The string value of any native id must be
* canonical.
- * Uid is never allowed to appear in the {@link Schema}, nor may Uid appear
+ * in the attribute set of a {@link CreateApiOp#create create} operation. This
+ * is because Uid is not a true attribute of an object, but rather a reference
+ * to that object. Uid extends {@link Attribute} only so that Uid can be
+ * searchable and compatible with the filter translators.
*/
public final class Uid extends Attribute {
@@ -112,8 +113,8 @@ public String getUidValue() {
/**
* Return the string representation of the revision value of the
- * The revision number specifies a given version of the
* {@link ConnectorObject object} identified by the
* {@link org.identityconnectors.framework.common.objects.Uid#getUidValue()}
*
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/filter/AbstractFilterTranslator.java b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/filter/AbstractFilterTranslator.java
index e83e22cd..88a7eda5 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/filter/AbstractFilterTranslator.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/common/objects/filter/AbstractFilterTranslator.java
@@ -20,6 +20,7 @@
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
* Portions Copyrighted 2015 ForgeRock AS.
+ * Portions Copyright 2018 Wren Security.
*/
package org.identityconnectors.framework.common.objects.filter;
@@ -80,7 +81,7 @@ abstract public class AbstractFilterTranslator The default Configuration object instance is constructed every single time
* before the {@link Connector#init(Configuration)} is called. If the
* configuration class implements this interface then the Framework keeps one
* instance of Configuration and the {@link Connector#init(Configuration)} is
@@ -39,12 +40,11 @@
* Connector developer must quarantine that the necessary resource
* initialisation are thread-safe.
*
- * If the connector implements the {@link PoolableConnector} then this
* configuration is kept in the
- * {@link org.identityconnectors.framework.impl.api.local.ConnectorPoolManager}
- * and when the
- * {@link org.identityconnectors.framework.impl.api.local.ConnectorPoolManager#dispose()}
+ * {@code org.identityconnectors.framework.impl.api.local.ConnectorPoolManager}
+ * and when
+ * {@code ConnectorPoolManager.dispose()}
* calls the {@link #release()} method. If the connector implements only the
* {@link Connector} then this configuration is kept in the
* {@link org.identityconnectors.framework.api.ConnectorFacade} and the
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/spi/package-info.java b/connector-framework/src/main/java/org/identityconnectors/framework/spi/package-info.java
index 0ca3bd5d..3d58325f 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/spi/package-info.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/spi/package-info.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -22,31 +23,44 @@
*/
/**
- * This is the "Service Provider Interface" package. The {@link org.identityconnectors.framework.spi.Connector} developer
- * is responsible for implementing the following interfaces to build a {@link org.identityconnectors.framework.spi.Connector}.
- *
- * The {@link org.identityconnectors.framework.spi.operations operations} package
- * has many operations from which to choose. In some cases, one operation does the same thing as another
- * but exposes more options. For instance there are two update operations.
- * {@link org.identityconnectors.framework.spi.operations.UpdateOp} is simpler to implement than
+ * The {@link org.identityconnectors.framework.spi.operations operations}
+ * package has many operations from which to choose. In some cases, one
+ * operation does the same thing as another but exposes more options. For
+ * instance there are two update operations.
+ * {@link org.identityconnectors.framework.spi.operations.UpdateOp} is simpler
+ * to implement than
* {@link org.identityconnectors.framework.spi.operations.UpdateAttributeValuesOp}.
*/
package org.identityconnectors.framework.spi;
diff --git a/connector-server-grizzly/src/main/java/org/forgerock/openicf/framework/server/ConnectorServer.java b/connector-server-grizzly/src/main/java/org/forgerock/openicf/framework/server/ConnectorServer.java
index d3dc192e..73a59718 100644
--- a/connector-server-grizzly/src/main/java/org/forgerock/openicf/framework/server/ConnectorServer.java
+++ b/connector-server-grizzly/src/main/java/org/forgerock/openicf/framework/server/ConnectorServer.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -258,7 +259,7 @@ private int getServerPort(int serverPort) {
* operation must be performed in the
+ *
*
*
* @author Laszlo Hordos
diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/serializer/ObjectDecoder.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/serializer/ObjectDecoder.java
index a4713d39..d449c3bf 100644
--- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/serializer/ObjectDecoder.java
+++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/impl/serializer/ObjectDecoder.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -29,12 +30,16 @@
*/
public interface ObjectDecoder {
/**
- * Reads an object using the appropriate serializer for that object
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The subelement name for xml serialization
- * @expectedType Ignored for binary serialization. For xml serialization,
- * this must be specified if it was written in-line.
- * @dflt The default value if there is no value.
+ * Reads an object using the appropriate serializer for that object.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * subelement name for xml serialization
+ * @param expectedType
+ * Ignored for binary serialization. For xml serialization, this must be
+ * specified if it was written in-line.
+ * @param dflt
+ * The default value if there is no value.
*/
public Object readObjectField(String fieldName,
Class> expectedType,
@@ -42,57 +47,78 @@ public Object readObjectField(String fieldName,
/**
* Reads a boolean.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public boolean readBooleanField(String fieldName, boolean dflt);
/**
* Reads an int.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public int readIntField(String fieldName, int dflt);
/**
* Reads a long.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public long readLongField(String fieldName, long dflt);
/**
* Reads a float.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public float readFloatField(String fieldName, float dflt );
/**
* Reads a Class.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public Class> readClassField(String fieldName, Class> dflt );
/**
* Reads a String.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public String readStringField(String fieldName, String dflt );
/**
* Reads a double.
- * @param fieldName A hint of the field name. Ignored for binary
- * serialization. The attribute name for xml serialization
- * @dflt The default value if there is no value.
+ *
+ * @param fieldName
+ * A hint of the field name. Ignored for binary serialization. The
+ * attribute name for xml serialization
+ * @param dflt
+ * The default value if there is no value.
*/
public double readDoubleField(String fieldName, double dflt );
@@ -143,7 +169,6 @@ public Object readObjectField(String fieldName,
/**
* Returns the number of anonymous sub-objects.
- * @return
*/
public int getNumSubObjects();
diff --git a/connector-framework-internal/src/main/java/org/identityconnectors/framework/server/ConnectorServer.java b/connector-framework-internal/src/main/java/org/identityconnectors/framework/server/ConnectorServer.java
index 27420756..e4b498c3 100644
--- a/connector-framework-internal/src/main/java/org/identityconnectors/framework/server/ConnectorServer.java
+++ b/connector-framework-internal/src/main/java/org/identityconnectors/framework/server/ConnectorServer.java
@@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
@@ -355,8 +356,6 @@ public void setBundleParentClassLoader(final ClassLoader bundleParentClassLoader
/**
* Gets the time when the servers was started last time.
- *
*
*/
public final ListConnector
throws this exception if the user entered an
- * incorrect password.
+ *
+ * Connector
throws this exception if the user entered
+ * an incorrect password.
*
* @see javax.security.auth.login.FailedLoginException
*/
diff --git a/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/RetryableException.java b/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/RetryableException.java
index ff332abb..bceb7f18 100644
--- a/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/RetryableException.java
+++ b/connector-framework/src/main/java/org/identityconnectors/framework/common/exceptions/RetryableException.java
@@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013 ForgeRock AS. All Rights Reserved
+ * Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
@@ -30,8 +31,6 @@
/**
* RetryableException indicates that a failure may be temporary, and that
* retrying the same request may be able to succeed in the future.
- * Uid
and Application should call the
* {@link org.identityconnectors.framework.spi.operations.UpdateOp#update(org.identityconnectors.framework.common.objects.ObjectClass, org.identityconnectors.framework.common.objects.Uid, java.util.Set, org.identityconnectors.framework.common.objects.OperationOptions)}
* method now.
- *
- * Use this only if the created object can not be deleted. The best-practice
- * should always be the Connector implementation reverts the changes if the
- * operation failed.
+ *
+ * Uid
of the created object. An application also can use the
* {@link SearchApiOp#search search} operation to discover the Uid
@@ -46,8 +47,8 @@
* {@link GetApiOp#getObject get}, {@link DeleteApiOp#delete delete} or
* {@link UpdateApiOp#update update} that object. See the documentation for
* {@link Name} for comparison.
- * Uid
would be a Globally Unique
+ *
+ * Uid
would be a Globally Unique
* IDentifier (GUID). However, not every target resource provides a globally
* unique and immutable identifier for each of its objects. For some connector
* implementations, therefore, the Uid
value is only locally
@@ -58,17 +59,17 @@
* the Uid
of an object. The fact that changing an object might
* change its Uid
is the reason that {@link UpdateApiOp#update
* update} returns Uid
.
- * size()
* may be one of the following:
- *
+ *
+ *
*
create*
methods
* returned null.ConnectorFacade
performs a
* second level of filtering. However it is undesirable from a
* performance standpoint.
- *
- *
+ *
+ *
+ * start()
method.
*