gov.nist.javax.sip.header.Challenge Maven / Gradle / Ivy
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* 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 NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
/**
* Challenge part of the Auth header. This is only used by the parser interface
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.8 $ $Date: 2010-05-06 14:07:54 $
* @since 1.1
*
*/
public class Challenge extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 5944455875924336L;
private static String DOMAIN = ParameterNames.DOMAIN;
private static String REALM = ParameterNames.REALM;
private static String OPAQUE = ParameterNames.OPAQUE;
private static String ALGORITHM = ParameterNames.ALGORITHM;
private static String QOP = ParameterNames.QOP;
private static String STALE = ParameterNames.STALE;
private static String SIGNATURE = ParameterNames.SIGNATURE;
private static String RESPONSE = ParameterNames.RESPONSE;
private static String SIGNED_BY = ParameterNames.SIGNED_BY;
private static String URI = ParameterNames.URI;
/**
* scheme field
*/
protected String scheme;
/**
* authParms list
*/
protected NameValueList authParams;
/**
* Default constructor
*/
public Challenge() {
authParams = new NameValueList();
authParams.setSeparator(COMMA);
}
/**
* Encode the challenge in canonical form.
* @return String
*/
public String encode() {
return new StringBuilder(scheme)
.append(SP)
.append(authParams.encode())
.toString();
}
/**
* get the scheme field
* @return String
*/
public String getScheme() {
return scheme;
}
/**
* get AuthParms list.
* @return NameValueList
*/
public NameValueList getAuthParams() {
return authParams;
}
/**
* get the domain
* @return String
*/
public String getDomain() {
return (String) authParams.getValue(DOMAIN);
}
/**
* get the URI field
* @return String
*/
public String getURI() {
return (String) authParams.getValue(URI);
}
/**
* get the Opaque field
* @return String
*/
public String getOpaque() {
return (String) authParams.getValue(OPAQUE);
}
/**
* get QOP value
* @return String
*/
public String getQOP() {
return (String) authParams.getValue(QOP);
}
/**
* get the Algorithm value.
* @return String
*/
public String getAlgorithm() {
return (String) authParams.getValue(ALGORITHM);
}
/**
* get the State value.
* @return String
*/
public String getStale() {
return (String) authParams.getValue(STALE);
}
/**
* get the Signature value.
* @return String
*/
public String getSignature() {
return (String) authParams.getValue(SIGNATURE);
}
/**
* get the signedBy value.
* @return String
*/
public String getSignedBy() {
return (String) authParams.getValue(SIGNED_BY);
}
/**
* get the Response value.
* @return String
*/
public String getResponse() {
return (String) authParams.getValue(RESPONSE);
}
/**
* get the realm value.
* @return String.
*/
public String getRealm() {
return (String) authParams.getValue(REALM);
}
/**
* get the specified parameter
* @param name String to set
* @return String to set
*/
public String getParameter(String name) {
return (String) authParams.getValue(name);
}
/**
* boolean function
* @param name String to set
* @return true if this header has the specified parameter, false otherwise.
*/
public boolean hasParameter(String name) {
return authParams.getNameValue(name) != null;
}
/**
* Boolean function
* @return true if this header has some parameters.
*/
public boolean hasParameters() {
return authParams.size() != 0;
}
/**
* delete the specified parameter
* @param name String
* @return true if the specified parameter has been removed, false
* otherwise.
*/
public boolean removeParameter(String name) {
return authParams.delete(name);
}
/**
* remove all parameters
*/
public void removeParameters() {
authParams = new NameValueList();
}
/**
* set the specified parameter
* @param nv NameValue to set
*/
public void setParameter(NameValue nv) {
authParams.set(nv);
}
/**
* Set the scheme member
* @param s String to set
*/
public void setScheme(String s) {
scheme = s;
}
/**
* Set the authParams member
* @param a NameValueList to set
*/
public void setAuthParams(NameValueList a) {
authParams = a;
}
public Object clone() {
Challenge retval = (Challenge) super.clone();
if (this.authParams != null)
retval.authParams = (NameValueList) this.authParams.clone();
return retval;
}
}