Home | History | Annotate | Download | only in ims
      1 /*
      2 * Conditions Of Use
      3 *
      4 * This software was developed by employees of the National Institute of
      5 * Standards and Technology (NIST), an agency of the Federal Government
      6 * and others.
      7 * Pursuant to title 15 Untied States Code Section 105, works of NIST
      8 * employees are not subject to copyright protection in the United States
      9 * and are considered to be in the public domain.  As a result, a formal
     10 * license is not needed to use the software.
     11 *
     12 * This software is provided by NIST as a service and is expressly
     13 * provided "AS IS."  NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
     14 * OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
     15 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
     16 * AND DATA ACCURACY.  NIST does not warrant or make any representations
     17 * regarding the use of the software or the results thereof, including but
     18 * not limited to the correctness, accuracy, reliability or usefulness of
     19 * the software.
     20 *
     21 * Permission to use this software is contingent upon your acceptance
     22 * of the terms of this agreement.
     23 *
     24 */
     25 /****************************************************************************
     26  * PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University (Portugal) *
     27  ****************************************************************************/
     28 
     29 package gov.nist.javax.sip.header.ims;
     30 
     31 import javax.sip.header.Header;
     32 import javax.sip.header.HeaderAddress;
     33 import javax.sip.header.Parameters;
     34 import javax.sip.address.URI;
     35 
     36 
     37 
     38 /**
     39  * <p>P-Associated-URI SIP Private Header. </p>
     40  * <p>An associated URI is a URI that the service provider
     41  * has allocated to a user for his own usage (address-of-record). </p>
     42  *
     43  * <p>sintax (RFC 3455): </p>
     44  * <pre>
     45  * P-Associated-URI  = "P-Associated-URI" HCOLON
     46  *                    (p-aso-uri-spec) *(COMMA p-aso-uri-spec)
     47  * p-aso-uri-spec    = name-addr *(SEMI ai-param)
     48  * ai-param          = generic-param
     49  * name-addr         =   [display-name] angle-addr
     50  * angle-addr        =   [CFWS] "<" addr-spec ">" [CFWS] / obs-angle-addr
     51  * </pre>
     52  *
     53  * @author Miguel Freitas (IT) PT-Inovacao
     54  */
     55 
     56 /*
     57 
     58  */
     59 
     60 
     61 public interface PAssociatedURIHeader
     62     extends HeaderAddress, Parameters, Header
     63 {
     64 
     65     /**
     66      * Name of PAssociatedURIHeader
     67      */
     68     public final static String NAME = "P-Associated-URI";
     69 
     70 
     71     /**
     72      * <p>Set the URI on this address</p>
     73      * @param associatedURI - GenericURI to be set in the address of this header
     74      * @throws NullPointerException when supplied URI is null
     75      */
     76     public void setAssociatedURI(URI associatedURI) throws NullPointerException;
     77 
     78     /**
     79      * <p>Get the address's URI</p>
     80      * @return URI set in the address of this header
     81      */
     82     public URI getAssociatedURI();
     83 
     84     //public void setAssociatedURI(AddressImpl associatedURI);
     85     //public AddressImpl getAssociatedURI();
     86 
     87 
     88 
     89 
     90 }
     91