gridscale.http.methods.HttpLock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http_3 Show documentation

http

There is a newer version: 2.53

/*
 * Copyright 2009-2011 Jon Stevens et al.
 *
 * 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 gridscale.http.methods;

import org.apache.http.HttpHeaders;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;

import java.net.URI;

/**
 */
public class HttpLock extends HttpEntityEnclosingRequestBase
{
	public static final String METHOD_NAME = "LOCK";

	public HttpLock(String url)
	{
		this(URI.create(url));
	}

	public HttpLock(URI url)
	{
		this.setURI(url);
		this.setHeader(HttpHeaders.CONTENT_TYPE, "text/xml; charset=utf-8");
	}

	@Override
	public String getMethod()
	{
		return METHOD_NAME;
	}

	/**
	 * 
	 * The Depth header may be used with the LOCK method. Values other than 0 or infinity must not
	 * be used with the Depth header on a LOCK method. All resources that support the LOCK
	 * method must support the Depth header.
	 * 
	 * 
	 * If no Depth header is submitted on a LOCK request then the request must act as if
	 * a Depth:infinity had been submitted.
	 * 
	 * @param depth "0" or "infinity".
	 */
	public void setDepth(String depth)
	{
		this.setHeader(HttpHeaders.DEPTH, depth);
	}

	/**
	 * Clients may include Timeout headers in their LOCK requests. However, the server is not required to honor
	 * or even consider these requests.
	 */
	public void setTimeout(int seconds)
	{
		this.setHeader(HttpHeaders.TIMEOUT, "Second-" + seconds);
	}

	/**
	 * Desires an infinite length lock.
	 */
	public void setInfinite()
	{
		this.setHeader(HttpHeaders.TIMEOUT, "Infinite");
	}
}