external-software/github_OpenIdentityPlatform_OpenDJ.git

			@@ -11,26 +11,24 @@
			* Header, with the fields enclosed by brackets [] replaced by your own identifying
			* information: "Portions Copyright [year] [name of copyright owner]".
			*
			* Copyright 2012-2013 ForgeRock AS.
			* Copyright 2012-2015 ForgeRock AS.
			*/
			package org.forgerock.opendj.rest2ldap;

			import java.util.List;
			import java.util.Set;

			import org.forgerock.json.fluent.JsonPointer;
			import org.forgerock.json.fluent.JsonValue;
			import org.forgerock.json.JsonPointer;
			import org.forgerock.json.JsonValue;
			import org.forgerock.json.resource.PatchOperation;
			import org.forgerock.json.resource.ResultHandler;
			import org.forgerock.json.resource.ResourceException;
			import org.forgerock.opendj.ldap.Attribute;
			import org.forgerock.opendj.ldap.Entry;
			import org.forgerock.opendj.ldap.Filter;
			import org.forgerock.opendj.ldap.Modification;
			import org.forgerock.util.promise.Promise;

			/**
			* An attribute mapper is responsible for converting JSON values to and from
			* LDAP attributes.
			*/
			/** An attribute mapper is responsible for converting JSON values to and from LDAP attributes. */
			public abstract class AttributeMapper {
			/*
			* This interface is an abstract class so that methods can be made package
			@@ -42,19 +40,18 @@
			}

			/**
			* Maps a JSON value to one or more LDAP attributes, invoking a completion
			* handler once the transformation has completed. This method is invoked
			* when a REST resource is created using a create request.
			* Maps a JSON value to one or more LDAP attributes, returning a promise
			* once the transformation has completed. This method is invoked when a REST
			* resource is created using a create request.
			* <p>
			* If the JSON value corresponding to this mapper is not present in the
			* resource then this method will be invoked with a value of {@code null}.
			* It is the responsibility of the mapper implementation to take appropriate
			* action in this case, perhaps by substituting default LDAP values, or by
			* rejecting the update by invoking the result handler's
			* {@link ResultHandler#handleError handleError} method.
			* returning a failed promise with an appropriate {@link ResourceException}.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param path
			* The pointer from the root of the JSON resource to this
			* attribute mapper. This may be used when constructing error
			@@ -63,10 +60,10 @@
			* The JSON value to be converted to LDAP attributes, which may
			* be {@code null} indicating that the JSON value was not present
			* in the resource.
			* @param h
			* The result handler.
			* @return A {@link Promise} containing the result of the operation.
			*/
			abstract void create(Context c, JsonPointer path, JsonValue v, ResultHandler<List<Attribute>> h);
			abstract Promise<List<Attribute>, ResourceException> create(
			RequestState requestState, JsonPointer path, JsonValue v);

			/**
			* Adds the names of the LDAP attributes required by this attribute mapper
			@@ -75,8 +72,8 @@
			* Implementations should only add the names of attributes found in the LDAP
			* entry directly associated with the resource.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param path
			* The pointer from the root of the JSON resource to this
			* attribute mapper. This may be used when constructing error
			@@ -89,21 +86,20 @@
			* The set into which the required LDAP attribute names should be
			* put.
			*/
			abstract void getLDAPAttributes(Context c, JsonPointer path, JsonPointer subPath,
			Set<String> ldapAttributes);
			abstract void getLDAPAttributes(
			RequestState requestState, JsonPointer path, JsonPointer subPath, Set<String> ldapAttributes);

			/**
			* Transforms the provided REST comparison filter parameters to an LDAP
			* filter representation, invoking a completion handler once the
			* transformation has completed.
			* filter representation, returning a promise once the transformation has
			* completed.
			* <p>
			* If an error occurred while constructing the LDAP filter, then the result
			* handler's {@link ResultHandler#handleError handleError} method must be
			* invoked with an appropriate exception indicating the problem which
			* occurred.
			* If an error occurred while constructing the LDAP filter, then a failed
			* promise must be returned with an appropriate {@link ResourceException}
			* indicating the problem which occurred.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param path
			* The pointer from the root of the JSON resource to this
			* attribute mapper. This may be used when constructing error
			@@ -121,19 +117,18 @@
			* @param valueAssertion
			* The value assertion, or {@code null} if {@code type} is
			* {@link FilterType#PRESENT}.
			* @param h
			* The result handler.
			* @return A {@link Promise} containing the result of the operation.
			*/
			abstract void getLDAPFilter(Context c, JsonPointer path, JsonPointer subPath, FilterType type,
			String operator, Object valueAssertion, ResultHandler<Filter> h);
			abstract Promise<Filter, ResourceException> getLDAPFilter(RequestState requestState, JsonPointer path,
			JsonPointer subPath, FilterType type, String operator, Object valueAssertion);

			/**
			* Maps a JSON patch operation to one or more LDAP modifications, invoking a
			* completion handler once the transformation has completed. This method is
			* invoked when a REST resource is modified using a patch request.
			* Maps a JSON patch operation to one or more LDAP modifications, returning
			* a promise once the transformation has completed. This method is invoked
			* when a REST resource is modified using a patch request.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param path
			* The pointer from the root of the JSON resource to this
			* attribute mapper. This may be used when constructing error
			@@ -143,67 +138,60 @@
			* modifications. The targeted JSON field will be relative to
			* this attribute mapper, or root if all attributes associated
			* with this mapper have been targeted.
			* @param h
			* The result handler.
			* @return A {@link Promise} containing the result of the operation.
			*/
			abstract void patch(Context c, JsonPointer path, PatchOperation operation,
			ResultHandler<List<Modification>> h);
			abstract Promise<List<Modification>, ResourceException> patch(
			RequestState requestState, JsonPointer path, PatchOperation operation);

			/**
			* Maps one or more LDAP attributes to their JSON representation, invoking a
			* completion handler once the transformation has completed.
			* Maps one or more LDAP attributes to their JSON representation, returning
			* a promise once the transformation has completed.
			* <p>
			* This method is invoked whenever an LDAP entry is converted to a REST
			* resource, i.e. when responding to read, query, create, put, or patch
			* requests.
			* <p>
			* If the LDAP attributes are not present in the entry, perhaps because they
			* are optional, then implementations should invoke the result handler's
			* {@link ResultHandler#handleResult handleResult} method with a result of
			* {@code null}. If the LDAP attributes cannot be mapped for any other
			* reason, perhaps because they are required but missing, or they contain
			* unexpected content, then the result handler's
			* {@link ResultHandler#handleError handleError} method must be invoked with
			* an appropriate exception indicating the problem which occurred.
			* are optional, then implementations should return a successful promise
			* with a result of {@code null}. If the LDAP attributes cannot be mapped
			* for any other reason, perhaps because they are required but missing, or
			* they contain unexpected content, then a failed promise must be returned
			* with an appropriate exception indicating the problem which occurred.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param path
			* The pointer from the root of the JSON resource to this
			* attribute mapper. This may be used when constructing error
			* messages.
			* @param e
			* The LDAP entry to be converted to JSON.
			* @param h
			* The result handler.
			* @return A {@link Promise} containing the result of the operation.
			*/
			abstract void read(Context c, JsonPointer path, Entry e, ResultHandler<JsonValue> h);
			abstract Promise<JsonValue, ResourceException> read(RequestState requestState, JsonPointer path, Entry e);

			/**
			* Maps a JSON value to one or more LDAP modifications, invoking a
			* completion handler once the transformation has completed. This method is
			* invoked when a REST resource is modified using an update request.
			* Maps a JSON value to one or more LDAP modifications, returning a promise
			* once the transformation has completed. This method is invoked when a REST
			* resource is modified using an update request.
			* <p>
			* If the JSON value corresponding to this mapper is not present in the
			* resource then this method will be invoked with a value of {@code null}.
			* It is the responsibility of the mapper implementation to take appropriate
			* action in this case, perhaps by substituting default LDAP values, or by
			* rejecting the update by invoking the result handler's
			* {@link ResultHandler#handleError handleError} method.
			* returning a failed promise with an appropriate {@link ResourceException}.
			*
			* @param c
			* The context.
			* @param requestState
			* The request state.
			* @param v
			* The JSON value to be converted to LDAP attributes, which may
			* be {@code null} indicating that the JSON value was not present
			* in the resource.
			* @param h
			* The result handler.
			* @return A {@link Promise} containing the result of the operation.
			*/
			abstract void update(Context c, JsonPointer path, Entry e, JsonValue v,
			ResultHandler<List<Modification>> h);
			abstract Promise<List<Modification>, ResourceException> update(
			RequestState requestState, JsonPointer path, Entry e, JsonValue v);

			// TODO: methods for obtaining schema information (e.g. name, description,
			// type information).
			// TODO: methods for obtaining schema information (e.g. name, description, type information).
			// TODO: methods for creating sort controls.
			}