ObjectDeltaOperation.java

/*
 * Copyright (c) 2010-2015 Evolveum
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.evolveum.midpoint.schema;

import java.util.ArrayList;
import java.util.Collection;

import com.evolveum.midpoint.prism.delta.ObjectDelta;
import com.evolveum.midpoint.prism.polystring.PolyString;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.util.DebugDumpable;
import com.evolveum.midpoint.util.DebugUtil;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType;

/**
 * @author Radovan Semancik
 *
 */
public class ObjectDeltaOperation<T extends ObjectType> implements DebugDumpable {

	private ObjectDelta<T> objectDelta;
	private OperationResult executionResult;
	private PolyString objectName;
	private String resourceOid;
	private PolyString resourceName;
	
	public ObjectDeltaOperation() {
		super();
	}
	
	public ObjectDeltaOperation(ObjectDelta<T> objectDelta) {
		super();
		this.objectDelta = objectDelta;
	}

    public ObjectDeltaOperation(ObjectDelta<T> objectDelta, OperationResult executionResult) {
        super();
        this.objectDelta = objectDelta;
        this.executionResult = executionResult;
    }

    public ObjectDelta<T> getObjectDelta() {
		return objectDelta;
	}
	
	public void setObjectDelta(ObjectDelta<T> objectDelta) {
		this.objectDelta = objectDelta;
	}
	
	public OperationResult getExecutionResult() {
		return executionResult;
	}
	
	public void setExecutionResult(OperationResult executionResult) {
		this.executionResult = executionResult;
	}

	public PolyString getObjectName() {
		return objectName;
	}

	public void setObjectName(PolyString objectName) {
		this.objectName = objectName;
	}

	public String getResourceOid() {
		return resourceOid;
	}

	public void setResourceOid(String resourceOid) {
		this.resourceOid = resourceOid;
	}

	public PolyString getResourceName() {
		return resourceName;
	}

	public void setResourceName(PolyString resourceName) {
		this.resourceName = resourceName;
	}

	public boolean containsDelta(ObjectDelta<T> delta) {
		return objectDelta.equals(delta);
	}
	
	public static <T extends ObjectType> boolean containsDelta(Collection<? extends ObjectDeltaOperation<T>> deltaOps, ObjectDelta<T> delta) {
		if (deltaOps == null) {
			return false;
		}
		for (ObjectDeltaOperation<T> deltaOp: deltaOps) {
			if (deltaOp.containsDelta(delta)) {
				return true;
			}
		}
		return false;
	}
	
	public ObjectDeltaOperation<T> clone() {
		ObjectDeltaOperation<T> clone = new ObjectDeltaOperation<T>();
		copyToClone(clone);
		return clone;
	}

	protected void copyToClone(ObjectDeltaOperation<T> clone) {
		if (this.objectDelta != null) {
			clone.objectDelta = this.objectDelta.clone();
		}
		clone.executionResult = this.executionResult;
		clone.objectName = this.objectName;
		clone.resourceOid = this.resourceOid;
		clone.resourceName = this.resourceName;
	}

	public static void checkConsistence(Collection<? extends ObjectDeltaOperation<?>> deltas) {
		for (ObjectDeltaOperation<?> delta: deltas) {
			delta.checkConsistence();
		}
	}

	public void checkConsistence() {
		if (objectDelta != null) {
			objectDelta.checkConsistence();
		}
	}
	
	public static Collection<ObjectDeltaOperation<? extends ObjectType>> cloneCollection(
			Collection<ObjectDeltaOperation<? extends ObjectType>> origCollection) {
		Collection<ObjectDeltaOperation<? extends ObjectType>> clonedCollection = new ArrayList<ObjectDeltaOperation<? extends ObjectType>>(origCollection.size());
		for (ObjectDeltaOperation<? extends ObjectType> origDeltaOp: origCollection) {
			ObjectDeltaOperation<? extends ObjectType> clonedDeltaOp = origDeltaOp.clone();
			clonedCollection.add(clonedDeltaOp);
		}
		return clonedCollection;
	}
	
	public static Collection<ObjectDeltaOperation<? extends ObjectType>> cloneDeltaCollection(
			Collection<ObjectDelta<? extends ObjectType>> origCollection) {
		Collection<ObjectDeltaOperation<? extends ObjectType>> clonedCollection = new ArrayList<ObjectDeltaOperation<? extends ObjectType>>(origCollection.size());
		for (ObjectDelta<? extends ObjectType> origDelta: origCollection) {
			ObjectDeltaOperation<? extends ObjectType> clonedDeltaOp = new ObjectDeltaOperation(origDelta.clone());
			clonedCollection.add(clonedDeltaOp);
		}
		return clonedCollection;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((executionResult == null) ? 0 : executionResult.hashCode());
		result = prime * result + ((objectDelta == null) ? 0 : objectDelta.hashCode());
		result = prime * result + ((objectName == null) ? 0 : objectName.hashCode());
		result = prime * result + ((resourceOid == null) ? 0 : resourceOid.hashCode());
		result = prime * result + ((resourceName == null) ? 0 : resourceName.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		ObjectDeltaOperation other = (ObjectDeltaOperation) obj;
		if (executionResult == null) {
			if (other.executionResult != null)
				return false;
		} else if (!executionResult.equals(other.executionResult))
			return false;
		if (objectDelta == null) {
			if (other.objectDelta != null)
				return false;
		} else if (!objectDelta.equals(other.objectDelta))
			return false;
		// TODO are the following fields relevant for equality test?
		if (objectName == null) {
			if (other.objectName != null)
				return false;
		} else if (!objectName.equals(other.objectName))
			return false;
		if (resourceOid == null) {
			if (other.resourceOid != null)
				return false;
		} else if (!resourceOid.equals(other.resourceOid))
			return false;
		if (resourceName == null) {
			if (other.resourceName != null)
				return false;
		} else if (!resourceName.equals(other.resourceName))
			return false;
		return true;
	}

	@Override
	public String toString() {
		return getDebugDumpClassName() + "(" + objectDelta
				+ ": " + executionResult + ")";
	}

	@Override
	public String debugDump() {
		return debugDump(0);
	}

	@Override
	public String debugDump(int indent) {
		StringBuilder sb = new StringBuilder();
		DebugUtil.indentDebugDump(sb, indent);
		sb.append(getDebugDumpClassName()).append("\n");
		DebugUtil.debugDumpWithLabel(sb, "Delta", objectDelta, indent + 1);
		sb.append("\n");
		DebugUtil.debugDumpWithLabel(sb, "Execution result", executionResult, indent + 1);
		sb.append("\n");
		DebugUtil.debugDumpWithLabel(sb, "Object name", objectName, indent + 1);
		if (resourceName != null || resourceOid != null) {
			sb.append("\n");
			DebugUtil.debugDumpWithLabel(sb, "Resource", resourceName + " (" + resourceOid + ")", indent + 1);
		}
		return sb.toString();
	}

    protected String getDebugDumpClassName() {
        return "ObjectDeltaOperation";
    }
}