FileDocCategorySizeDatePackage
SipServerConnection.javaAPI DocphoneME MR2 API (J2ME)2302Wed May 02 18:00:42 BST 2007javax.microedition.sip

SipServerConnection.java

/*
 * Portions Copyright  2000-2007 Sun Microsystems, Inc. All Rights
 * Reserved.  Use is subject to license terms.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 * 
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 */

package javax.microedition.sip;

/**
 * SipServerConnection represents SIP server transaction.
 * @see JSR180 spec, v 1.0.1, p 33-36
 *
 */
public interface SipServerConnection extends SipConnection {
    
    /**
     * Initializes SipServerConnection with a specific SIP response to the
     * received request.
     * @see JSR180 spec, v 1.0.1, p 36
     *
     * @param code - Response status code 1xx - 6xx
     * @throws IllegalArgumentException - if the status code is out of
     * range 100-699 (RFC 3261 p.28-29)
     * @throws SipException - INVALID_STATE if the response can not be
     * initialized, because of wrong state.
     */
    public void initResponse(int code)
    throws IllegalArgumentException, SipException;
    
    /**
     * Changes the default reason phrase.
     * @param phrase - the default reason phrase.
     * @throws SipException - INVALID_STATE if the response can not
     * be initialized,
     * because of wrong state. INVALID_OPERATION if the reason phrase can not
     * be set.
     * @throws IllegalArgumentException - if the reason phrase is illegal.
     */
    public void setReasonPhrase(java.lang.String phrase)
    throws SipException, IllegalArgumentException;
}