gov.nist.javax.sip.header.ims.PAssociatedURIHeader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jain-sip-ri Show documentation
There is a newer version: 1.3.0-91
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain.  As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS."  NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY.  NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/****************************************************************************
 * PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University (Portugal) *
 ****************************************************************************/

package gov.nist.javax.sip.header.ims;

import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
import javax.sip.address.URI;



/**
 * P-Associated-URI SIP Private Header. 
 * An associated URI is a URI that the service provider
 * has allocated to a user for his own usage (address-of-record). 
 *
 * sintax (RFC 3455): 
 *  * P-Associated-URI  = "P-Associated-URI" HCOLON
 *                    (p-aso-uri-spec) *(COMMA p-aso-uri-spec)
 * p-aso-uri-spec    = name-addr *(SEMI ai-param)
 * ai-param          = generic-param
 * name-addr         =   [display-name] angle-addr
 * angle-addr        =   [CFWS] "<" addr-spec ">" [CFWS] / obs-angle-addr
 * 
 *
 * @author Miguel Freitas (IT) PT-Inovacao
 */

/*

 */


public interface PAssociatedURIHeader
    extends HeaderAddress, Parameters, Header
{

    /**
     * Name of PAssociatedURIHeader
     */
    public final static String NAME = "P-Associated-URI";


    /**
     * Set the URI on this address
     * @param associatedURI - GenericURI to be set in the address of this header
     * @throws NullPointerException when supplied URI is null
     */
    public void setAssociatedURI(URI associatedURI) throws NullPointerException;

    /**
     * Get the address's URI
     * @return URI set in the address of this header
     */
    public URI getAssociatedURI();

    //public void setAssociatedURI(AddressImpl associatedURI);
    //public AddressImpl getAssociatedURI();




}