001: /**
002: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
003: * Unpublished - rights reserved under the Copyright Laws of the United States.
004: * Copyright © 2003 Sun Microsystems, Inc. All rights reserved.
005: * Copyright © 2005 BEA Systems, Inc. All rights reserved.
006: *
007: * Use is subject to license terms.
008: *
009: * This distribution may include materials developed by third parties.
010: *
011: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
012: *
013: * Module Name : JSIP Specification
014: * File Name : AuthenticationInfoHeader.java
015: * Author : Phelim O'Doherty
016: *
017: * HISTORY
018: * Version Date Author Comments
019: * 1.1 08/10/2002 Phelim O'Doherty Initial version
020: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
021: */package javax.sip.header;
022:
023: import java.text.ParseException;
024:
025: /**
026: * The Authentication-Info header field provides for mutual
027: * authentication with HTTP Digest. A UAS MAY include this header field
028: * in a 2xx response to a request that was successfully authenticated
029: * using digest based on the Authorization header field.
030: * <p>
031: * For Example:<br>
032: * <code>Authentication-Info: nextnonce="47364c23432d2e131a5fb210812c"</code>
033: *
034: * @author BEA Systems, NIST
035: * @version 1.2
036: */
037: public interface AuthenticationInfoHeader extends Parameters, Header {
038:
039: /**
040: * Sets the NextNonce of the AuthenticationInfoHeader to the <var>nextNonce</var>
041: * parameter value.
042: *
043: * @param nextNonce - the new nextNonce String of this AuthenticationInfoHeader.
044: * @throws ParseException which signals that an error has been reached
045: * unexpectedly while parsing the nextNonce value.
046: */
047: public void setNextNonce(String nextNonce) throws ParseException;
048:
049: /**
050: * Returns the nextNonce value of this AuthenticationInfoHeader.
051: *
052: * @return the String representing the nextNonce information, null if value is
053: * not set.
054: */
055: public String getNextNonce();
056:
057: /**
058: * Sets the Qop value of the AuthenticationInfoHeader to the new
059: * <var>qop</var> parameter value.
060: *
061: * @param qop - the new Qop string of this AuthenticationInfoHeader.
062: * @throws ParseException which signals that an error has been reached
063: * unexpectedly while parsing the Qop value.
064: */
065: public void setQop(String qop) throws ParseException;
066:
067: /**
068: * Returns the messageQop value of this AuthenticationInfoHeader.
069: *
070: * @return the string representing the messageQop information, null if the
071: * value is not set.
072: */
073: public String getQop();
074:
075: /**
076: * Sets the CNonce of the AuthenticationInfoHeader to the <var>cNonce</var>
077: * parameter value.
078: *
079: * @param cNonce - the new cNonce String of this AuthenticationInfoHeader.
080: * @throws ParseException which signals that an error has been reached
081: * unexpectedly while parsing the cNonce value.
082: */
083: public void setCNonce(String cNonce) throws ParseException;
084:
085: /**
086: * Returns the CNonce value of this AuthenticationInfoHeader.
087: *
088: * @return the String representing the cNonce information, null if value is
089: * not set.
090: */
091: public String getCNonce();
092:
093: /**
094: * Sets the Nonce Count of the AuthenticationInfoHeader to the <var>nonceCount</var>
095: * parameter value.
096: *
097: * @param nonceCount - the new nonceCount integer of this AuthenticationInfoHeader.
098: * @throws ParseException which signals that an error has been reached
099: * unexpectedly while parsing the nonceCount value.
100: */
101: public void setNonceCount(int nonceCount) throws ParseException;
102:
103: /**
104: * Returns the Nonce Count value of this AuthenticationInfoHeader.
105: *
106: * @return the integer representing the nonceCount information, -1 if value is
107: * not set.
108: */
109: public int getNonceCount();
110:
111: /**
112: * Sets the Response of the AuthenticationInfoHeader to the new <var>response</var>
113: * parameter value.
114: *
115: * @param response - the new response String of this AuthenticationInfoHeader.
116: * @throws ParseException which signals that an error has been reached
117: * unexpectedly while parsing the Response.
118: */
119: public void setResponse(String response) throws ParseException;
120:
121: /**
122: * Returns the Response value of this AuthenticationInfoHeader.
123: *
124: * @return the String representing the Response information.
125: */
126: public String getResponse();
127:
128: /**
129: * Name of the AlertInfoHeader
130: */
131: public final static String NAME = "Authentication-Info";
132:
133: }
|