de.captaingoldfish.scim.sdk.server.endpoints.bulkid.BulkIdResolverAbstract Maven / Gradle / Ivy
// Generated by delombok at Thu Nov 02 20:38:53 CET 2023
package de.captaingoldfish.scim.sdk.server.endpoints.bulkid;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.databind.JsonNode;
import de.captaingoldfish.scim.sdk.common.constants.AttributeNames;
import de.captaingoldfish.scim.sdk.common.constants.ScimType;
import de.captaingoldfish.scim.sdk.common.exceptions.BadRequestException;
import de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode;
import de.captaingoldfish.scim.sdk.common.utils.JsonHelper;
import de.captaingoldfish.scim.sdk.server.utils.UriInfos;
/**
* author Pascal Knueppel
* created at: 21.08.2022 - 13:47
*
*/
public abstract class BulkIdResolverAbstract
{
/**
* the bulkId that is representing this bulk operation details
*/
protected final String operationBulkId;
/**
* the uri information of the currently accessed resource-type
*/
protected final UriInfos uriInfos;
/**
* the resource object that might contain some bulkId references
*/
protected final T resource;
/**
* contains all referenced bulkIds from this operation. Resolved elements will be removed from this set
*/
protected final Set referencedBulkIds = new HashSet<>();
/**
* contains all bulkId reference of the {@link #resource}. Since it might be possible that a bulkId reference
* is used to reference the same resource in different places we use this map for linking these entries from
* bulkId to found entries. Resolved elements will be removed from this map
*/
protected final Map> bulkIdReferences;
/**
* a bulk operation may be processed several times if bulkIds need to be resolved. In order to find
* unresolvable bulkIds we need to investigate each operation and must try to resolve the contained bulkIds.
* If an operation will be processed the second third or fourth time it must have set this boolean set to true
* otherwise we will assume that this operation contains an unresolvable bulkId.
*/
private boolean hadSuccessInLastRun;
public BulkIdResolverAbstract(String operationBulkId, UriInfos uriInfos, T resource)
{
this.operationBulkId = operationBulkId;
this.uriInfos = uriInfos;
this.resource = resource;
this.bulkIdReferences = new HashMap<>();
resolveBulkIdInUri();
}
/**
* this method will retrieve all bulkId references present within the {@link #resource} object
*/
protected void findAllBulkIdReferences()
{
boolean containsBulkIdReference = containsBulkIdReference(resource);
if (!containsBulkIdReference)
{
return;
}
List complexBulkIdReferences = getComplexBulkIdNodes();
List directBulkIdReferences = getDirectBulkIdNodes();
for ( BulkIdReferenceWrapper complexBulkIdReference : complexBulkIdReferences )
{
referencedBulkIds.add(complexBulkIdReference.getBulkId());
List bulkIdReferenceSet = bulkIdReferences.computeIfAbsent(complexBulkIdReference.getBulkId(),
k -> new ArrayList<>());
bulkIdReferenceSet.add(complexBulkIdReference);
}
for ( BulkIdReferenceWrapper directBulkIdReference : directBulkIdReferences )
{
referencedBulkIds.add(directBulkIdReference.getBulkId());
List bulkIdReferenceSet = bulkIdReferences.computeIfAbsent(directBulkIdReference.getBulkId(),
k -> new ArrayList<>());
bulkIdReferenceSet.add(directBulkIdReference);
}
}
/**
* will check the current context uri of a bulk operation and will add a resolver to the bulkIdReferenceSet if
* a bulkId-reference was found within the uri
*
* @param uriInfos the uriInfos of the bulk operation
*/
private void resolveBulkIdInUri()
{
String possibleBulkIdReference = uriInfos.getResourceId();
if (possibleBulkIdReference != null
&& possibleBulkIdReference.matches(String.format("%s:[\\w\\d[^/]]*$", AttributeNames.RFC7643.BULK_ID)))
{
checkForBulkIdReferenceValidity(possibleBulkIdReference);
String bulkId = possibleBulkIdReference.split(":")[1];
referencedBulkIds.add(bulkId);
List bulkIdReferenceSet = bulkIdReferences.computeIfAbsent(bulkId,
k -> new ArrayList<>());
bulkIdReferenceSet.add(new BulkIdReferenceUriWrapper(uriInfos, bulkId));
}
}
/**
* this method must return the bulkId references from the resource that are based on the complex-node bulkId
* specification
*
* @return the bulkId references that were found within the resource
*/
protected abstract List getComplexBulkIdNodes();
/**
* this method must return the bulkId references from the resource that are based on the simple-node bulkId
* specification
*
* @return the bulkId references that were found within the resource
*/
protected abstract List getDirectBulkIdNodes();
/**
* will replace the values marked with the given bulkId by the given value
*
* @param bulkId the bulkId that should be replaced
* @param value the value that should replace the bulkId reference
*/
public final void replaceBulkIdNode(String bulkId, String value)
{
List bulkIdResourceReferenceWrappers = bulkIdReferences.get(bulkId);
if (bulkIdResourceReferenceWrappers == null)
{
hadSuccessInLastRun = false;
return;
}
// if at least one element is processed we know that one bulkId was resolved, so we got a success in this run
hadSuccessInLastRun = bulkIdResourceReferenceWrappers.size() > 0;
bulkIdResourceReferenceWrappers.forEach(reference -> reference.replaceValueNode(value));
bulkIdReferences.remove(bulkId);
referencedBulkIds.remove(bulkId);
}
/**
* @return if any bulkId references have been found
*/
public final boolean hasAnyBulkIdReferences()
{
return !bulkIdReferences.isEmpty();
}
/**
* @return the bulkIds that have not been resolved yet
*/
public final Set getUnresolvedBulkIds()
{
return bulkIdReferences.keySet();
}
/**
* checks if this operation contains a self-reference
*/
public final boolean hasSelfReference()
{
return bulkIdReferences.containsKey(operationBulkId);
}
/**
* verifies if the given node does even contain a bulkId
*/
protected final boolean containsBulkIdReference(JsonNode jsonNode)
{
return StringUtils.contains(jsonNode.toString(), String.format("\"%s:", AttributeNames.RFC7643.BULK_ID));
}
protected void checkForBulkIdReferenceValidity(String bulkIdReferenceValue)
{
int bulkIdReferencePartsSize = bulkIdReferenceValue.split(":").length;
if (bulkIdReferencePartsSize != 2)
{
throw new BadRequestException(String.format("the value \'%s\' is not a valid bulkId reference",
bulkIdReferenceValue),
null, ScimType.RFC7644.INVALID_VALUE);
}
}
public R getResource(Class type)
{
return JsonHelper.copyResourceToObject(resource, type);
}
/**
* the bulkId that is representing this bulk operation details
*/
@java.lang.SuppressWarnings("all")
public String getOperationBulkId()
{
return this.operationBulkId;
}
/**
* the uri information of the currently accessed resource-type
*/
@java.lang.SuppressWarnings("all")
public UriInfos getUriInfos()
{
return this.uriInfos;
}
/**
* the resource object that might contain some bulkId references
*/
@java.lang.SuppressWarnings("all")
public T getResource()
{
return this.resource;
}
/**
* contains all referenced bulkIds from this operation. Resolved elements will be removed from this set
*/
@java.lang.SuppressWarnings("all")
public Set getReferencedBulkIds()
{
return this.referencedBulkIds;
}
/**
* a bulk operation may be processed several times if bulkIds need to be resolved. In order to find
* unresolvable bulkIds we need to investigate each operation and must try to resolve the contained bulkIds.
* If an operation will be processed the second third or fourth time it must have set this boolean set to true
* otherwise we will assume that this operation contains an unresolvable bulkId.
*/
@java.lang.SuppressWarnings("all")
public boolean isHadSuccessInLastRun()
{
return this.hadSuccessInLastRun;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy