Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Unpublished - rights reserved under the Copyright Laws of the United States. Copyright � 2003 Sun Microsystems, Inc. All rights reserved. Copyright � 2005 BEA Systems, Inc. All rights reserved. Use is subject to license terms. This distribution may include materials developed by third parties. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Module Name : JSIP Specification File Name : AuthorizationHeader.java Author : Phelim O'Doherty HISTORY Version Date Author Comments 1.1 08/10/2002 Phelim O'Doherty ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 package javax.sip.header;
 
The Authorization header is used when a user agent wishes to authenticate itself with a server - usually, but not necessarily, after receiving an UNAUTHORIZED Response - by including an AuthorizationHeader with the Request. The AuthorizationHeader consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

This header field, along with Proxy-Authorization, breaks the general rules about multiple header field values. Although not a comma- separated list, this header field name may be present multiple times, and MUST NOT be combined into a single header line.

For Example:
Authorization: Digest username="Alice", realm="atlanta.com",
nonce="84a4cc6f3082121f32b42a2187831a9e",
response="7587245234b3434cc3412213e5f113a5432"

 
 
 public interface AuthorizationHeader extends ParametersHeader {


    
Sets the scheme of the Response information for this AuthorizationHeader. For example, Digest.

Parameters:
scheme - the new string value that identifies the response information scheme.
 
     public void setScheme(String scheme);


    
Returns the scheme of the Response information for this AuthorizationHeader.

Returns:
the string value of the response information.
 
     public String getScheme();

    
Sets the Realm of the AuthorizationHeader to the realm parameter value. Realm strings MUST be globally unique. It is RECOMMENDED that a realm string contain a hostname or domain name. Realm strings SHOULD present a human-readable identifier that can be rendered to a user.

Parameters:
realm the new Realm String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the realm.
 
     public void setRealm(String realmthrows ParseException;


    
Returns the Realm value of this AuthorizationHeader. This convenience method returns only the realm of the complete Response.

Returns:
the String representing the Realm information, null if value is not set.
 
     public String getRealm();

    
Sets the Username of the AuthorizationHeader to the username parameter value.

Parameters:
username the new Username String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the username.
    public void setUsername(String usernamethrows ParseException;

    
Returns the Username value of this AuthorizationHeader. This convenience method returns only the username of the complete Response.

Returns:
the String representing the Username information, null if value is not set.
    public String getUsername();

    
    
Sets the Nonce of the AuthorizationHeader to the nonce parameter value.

Parameters:
nonce - the new nonce String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the nonce value.
    public void setNonce(String noncethrows ParseException;

    
Returns the Nonce value of this AuthorizationHeader.

Returns:
the String representing the nonce information, null if value is not set.
    public String getNonce();    
    
    
Sets the URI of the AuthorizationHeader to the uri parameter value.

Parameters:
uri - the new URI of this AuthorizationHeader.
    public void setURI(URI uri);

    
Returns the DigestURI value of this AuthorizationHeader.

Returns:
the URI representing the URI information, null if value is not set.
Note:
The syntax allows also non-URI strings, though it is not commonly used with SIP. To avoid parsing the string and treat it as opaque, applications should use getParameter("uri") instead of this method
    public URI getURI();     
    
    
Sets the Response of the AuthorizationHeader to the new response parameter value.

Parameters:
response - the new response String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the Response.
    public void setResponse(String responsethrows ParseException;

    
Returns the Response value of this AuthorizationHeader.

Returns:
the String representing the Response information.
    public String getResponse();

    
Sets the Algorithm of the AuthorizationHeader to the new algorithm parameter value.

Parameters:
algorithm - the new algorithm String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the algorithm value.
    public void setAlgorithm(String algorithmthrows ParseException;

    
Returns the Algorithm value of this AuthorizationHeader.

Returns:
the String representing the Algorithm information, null if the value is not set.
    public String getAlgorithm();    

    
Sets the CNonce of the AuthorizationHeader to the cNonce parameter value.

Parameters:
cNonce - the new cNonce String of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the cNonce value.
    public void setCNonce(String cNoncethrows ParseException;

    
Returns the CNonce value of this AuthorizationHeader.

Returns:
the String representing the cNonce information, null if value is not set.
    public String getCNonce();        
    
    
Sets the Opaque value of the AuthorizationHeader to the new opaque parameter value.

Parameters:
opaque - the new Opaque string of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the opaque value.
    public void setOpaque(String opaquethrows ParseException;

    
Returns the Opaque value of this AuthorizationHeader.

Returns:
the String representing the Opaque information, null if the value is not set.
    public String getOpaque();    

    
Sets the MessageQop value of the AuthorizationHeader to the new qop parameter value.

Parameters:
qop - the new Qop string of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the Qop value.
    public void setQop(String qopthrows ParseException;

    
Returns the Qop value of this AuthorizationHeader.

Returns:
the string representing the Qop information, null if the value is not set.
    public String getQop();    
    
    
Sets the Nonce Count of the AuthorizationHeader to the nonceCount parameter value.

Parameters:
nonceCount - the new nonceCount integer of this AuthorizationHeader.
Throws:
java.text.ParseException which signals that an error has been reached unexpectedly while parsing the nonceCount value.
    public void setNonceCount(int nonceCountthrows ParseException;

    
Returns the Nonce Count value of this AuthorizationHeader.

Returns:
the integer representing the nonceCount information, -1 if value is not set.
    public int getNonceCount();    
    
    
Name of AuthorizationHeader
    public final static String NAME = "Authorization";
New to GrepCode? Check out our FAQ X