/*
 * Copyright (C) 2007-2012 Mathieu Baudier
 *
 * 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 org.argeo.slc.detached;

import java.util.Properties;

/** A request sent to the detached server. */
public class DetachedRequest implements DetachedCommunication {
	static final long serialVersionUID = 1l;

	private String uuid;
	private Properties properties = new Properties();
	private String ref;

	private Object cachedObject = null;

	public DetachedRequest() {

	}

	public DetachedRequest(String uuid) {
		this.uuid = uuid;
	}

	/** The properties configuring this request. */
	public Properties getProperties() {
		return properties;
	}

	public void setProperties(Properties inputParameters) {
		this.properties = inputParameters;
	}

	/**
	 * A reference to the underlying implementation which will process the
	 * request.
	 */
	public String getRef() {
		return ref;
	}

	public void setRef(String stepRef) {
		this.ref = stepRef;
	}

	/** The unique identifier of this request. */
	public String getUuid() {
		return uuid;
	}

	public void setUuid(String uuid) {
		this.uuid = uuid;
	}

	public String toString() {
		StringBuffer buf = new StringBuffer("detached request for ref ");
		buf.append(ref);
		buf.append(" #").append(uuid);
		buf.append(" cachedObject=").append((cachedObject != null));
		buf.append(" properties=").append(properties);
		return buf.toString();
	}

	/**
	 * Optimization. Allows the driver to eagerly cache the object in the
	 * request, in order to relieve the detached server of the task to look for
	 * it. No implementation should rely on this to be set.
	 */
	public Object getCachedObject() {
		return cachedObject;
	}

	public void setCachedObject(Object cachedObject) {
		this.cachedObject = cachedObject;
	}

}