org.jscep.request.Request Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2009-2010 David Grant
 * Copyright (c) 2010 ThruPoint Ltd
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.jscep.request;

import org.jscep.content.ScepContentHandler;

import java.io.IOException;
import java.io.OutputStream;


/**
 * This interface represents a SCEP request.
 * 
 * Once an instance of a Request implementation has been obtained,
 * it can be sent to a SCEP server by using an instance of 
 * {@link org.jscep.transport.Transport}.
 * 
 * @author David Grant
 * @param  the response type associated with this request
 * @see org.jscep.transport.Transport#sendRequest(Request)
 */
public abstract class Request {
	private final Operation operation;
	private final ScepContentHandler handler;
	
	public Request(Operation operation, ScepContentHandler handler) {
		this.operation = operation;
		this.handler = handler;
	}
	
	/**
	 * Returns the name of this operation.
	 * 
	 * @return the name of this operation.
	 */
	public Operation getOperation() {
		return operation;
	}
    /**
     * Returns the message for this request.
     * 
     * @return the message.
     * @throws IOException if any I/O error occurs.
     */
    public abstract String getMessage() throws IOException;
    /**
     * Returns the ScepContentHandler for the given response type.
     * 
     * @return the content handler.
     */
    public ScepContentHandler getContentHandler() {
    	return handler;
    }
    
    public void write(OutputStream out) throws IOException {
    	throw new UnsupportedOperationException();
    }
}