001: /*****************************************************************************
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025:
026: * The Original Software is the CVS Client Library.
027: * The Initial Developer of the Original Software is Robert Greig.
028: * Portions created by Robert Greig are Copyright (C) 2000.
029: * All Rights Reserved.
030: *
031: * If you wish your version of this file to be governed by only the CDDL
032: * or only the GPL Version 2, indicate your decision by adding
033: * "[Contributor] elects to include this software in this distribution
034: * under the [CDDL or GPL Version 2] license." If you do not indicate a
035: * single choice of license, a recipient has the option to distribute
036: * your version of this file under either the CDDL, the GPL Version 2 or
037: * to extend the choice of license to its licensees as provided above.
038: * However, if you add GPL Version 2 code and therefore, elected the GPL
039: * Version 2 license, then the option applies only if the new code is
040: * made subject to such option by the copyright holder.
041:
042: * Contributor(s): Robert Greig.
043: *****************************************************************************/package org.netbeans.lib.cvsclient.request;
044:
045: import java.io.*;
046:
047: import org.netbeans.lib.cvsclient.connection.*;
048: import org.netbeans.lib.cvsclient.file.*;
049:
050: /**
051: * The superclass of all requests made to the CVS server
052: * @author Robert Greig
053: */
054: public abstract class Request {
055: /**
056: * Get the request String that will be passed to the server
057: * @return the request String
058: * @throws UnconfiguredRequestException if the request has not been
059: * properly configured
060: */
061: public abstract String getRequestString()
062: throws UnconfiguredRequestException;
063:
064: /**
065: * Is a response expected from the server?
066: * @return true if a response is expected, false if no response if
067: * expected
068: */
069: public abstract boolean isResponseExpected();
070:
071: /**
072: * If a file transmission is required, get the file object representing
073: * the file to transmit after the request string. The default
074: * implementation returns null, indicating no file is to be transmitted
075: * @return the file object, if one should be transmitted, or null if
076: * no file object is to be transmitted.
077: */
078: public FileDetails getFileForTransmission() {
079: return null;
080: }
081:
082: /**
083: * Modify streams on the connection if necessary
084: */
085: public void modifyOutputStream(Connection connection)
086: throws IOException {
087: // DO NOTHING
088: }
089:
090: /**
091: * Modify streams on the connection if necessary
092: */
093: public void modifyInputStream(Connection connection)
094: throws IOException {
095: // DO NOTHING
096: }
097:
098: /**
099: * Does this request modify the input stream?
100: * @return true if it does, false otherwise
101: */
102: public boolean modifiesInputStream() {
103: return false;
104: }
105: }
|