com.strategicgains.restexpress.exception.MethodNotAllowedException Maven / Gradle / Ivy

Go to download

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

Internet scale, high-performance RESTful Services in Java

There is a newer version: 0.11.3

/*
    Copyright 2012, Strategic Gains, Inc.

	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.strategicgains.restexpress.exception;

import java.util.Collections;
import java.util.List;

import org.jboss.netty.handler.codec.http.HttpHeaders;
import org.jboss.netty.handler.codec.http.HttpMethod;
import org.jboss.netty.handler.codec.http.HttpResponseStatus;

import com.strategicgains.restexpress.Response;
import com.strategicgains.restexpress.util.StringUtils;

/**
 * @author toddf
 * @since May 15, 2012
 */
public class MethodNotAllowedException
extends ServiceException
{
    private static final long serialVersionUID = 4116758162425337982L;
	private static final HttpResponseStatus STATUS = HttpResponseStatus.METHOD_NOT_ALLOWED;
	
	private List allowedMethods;

	public MethodNotAllowedException(List allowed)
	{
		super(STATUS);
		setAllowedMethods(allowed);
	}

	/**
	 * @param message
	 */
	public MethodNotAllowedException(String message, List allowed)
	{
		super(STATUS, message);
		setAllowedMethods(allowed);
	}

	/**
	 * @param cause
	 */
	public MethodNotAllowedException(Throwable cause, List allowed)
	{
		super(STATUS, cause);
		setAllowedMethods(allowed);
	}

	/**
	 * @param message
	 * @param cause
	 */
	public MethodNotAllowedException(String message, Throwable cause, List allowed)
	{
		super(STATUS, message, cause);
		setAllowedMethods(allowed);
	}
	
	public void setAllowedMethods(List allowed)
	{
		this.allowedMethods = Collections.unmodifiableList(allowed);
	}
	
	public List getAllowedMethods()
	{
		return allowedMethods;
	}
	
	/**
	 * Adds Allow HTTP header to the response with a list of the appropriate HTTP methods for the route.
	 */
	@Override
	public void augmentResponse(Response response)
	{
		response.addHeader(HttpHeaders.Names.ALLOW, StringUtils.join(",", getAllowedMethods()));
	}
}