gov.nist.javax.sip.header
クラス AuthenticationHeader

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.ParametersHeader
                  gov.nist.javax.sip.header.AuthenticationHeader

すべての実装されたインタフェース:

SIPHeaderNames, java.io.Serializable, java.lang.Cloneable, javax.sip.header.Header, javax.sip.header.Parameters

直系の既知のサブクラス:

Authorization, ProxyAuthenticate, ProxyAuthorization, WWWAuthenticate

public abstract class AuthenticationHeader
extends ParametersHeader

The generic AuthenticationHeader

バージョン:

JAIN-SIP-1.1 $Revision: 1.2 $ $Date: 2004/01/22 13:26:29 $ This code is in the public domain.

作成者:

Olivier Deruelle , M. Ranganathan

関連項目:

直列化された形式

フィールドの概要

static java.lang.String	ALGORITHM
static java.lang.String	CNONCE
static java.lang.String	DOMAIN
static java.lang.String	NC
static java.lang.String	NONCE
static java.lang.String	OPAQUE
static java.lang.String	QOP
static java.lang.String	REALM
static java.lang.String	RESPONSE
static java.lang.String	SIGNATURE
static java.lang.String	SIGNED_BY
static java.lang.String	STALE
static java.lang.String	URI
static java.lang.String	USERNAME

インタフェース gov.nist.javax.sip.header.SIPHeaderNames から継承されたフィールド

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

コンストラクタの概要

AuthenticationHeader()

AuthenticationHeader(java.lang.String name)

メソッドの概要

java.lang.String	encodeBody() Encode in canonical form.
java.lang.String	getAlgorithm() Returns the Algorithm value of this WWWAuthenicateHeader.
java.lang.String	getCNonce() Get the CNonce.
java.lang.String	getDomain() Returns the Domain value of this WWWAuthenicateHeader.
java.lang.String	getNonce() Returns the Nonce value of this WWWAuthenicateHeader.
int	getNonceCount()
java.lang.String	getOpaque() Returns the Opaque value of this WWWAuthenicateHeader.
java.lang.String	getQop() Returns the Qop value of this WWWAuthenicateHeader.
java.lang.String	getRealm() Returns the Realm value of this WWWAuthenicateHeader.
java.lang.String	getResponse() Get the RESPONSE value (or null if it does not exist).
java.lang.String	getScheme() Returns the scheme of the challenge information for this AuthenticationHeaderHeader.
javax.sip.address.URI	getURI() Returns the URI value of this WWWAuthenicateHeader, for example DigestURI.
java.lang.String	getUsername() Returns the Username value of this AuthorizationHeader.
boolean	isStale() Returns the boolean value of the state paramater of this WWWAuthenicateHeader.
void	setAlgorithm(java.lang.String algorithm) Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm parameter value.
void	setChallenge(Challenge challenge) This is only used for the parser interface.
void	setCNonce(java.lang.String cnonce) Set the CNonce.
void	setDomain(java.lang.String domain) Sets the Domain of the WWWAuthenicateHeader to the domain parameter value.
void	setNonce(java.lang.String nonce) Sets the Nonce of the WWWAuthenicateHeader to the nonce parameter value.
void	setNonceCount(int param) Set the nonce count pakrameter.
void	setOpaque(java.lang.String opaque) Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value.
void	setParameter(java.lang.String name, java.lang.String value) set the specified parameter.
void	setQop(java.lang.String qop) Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value.
void	setRealm(java.lang.String realm) Sets the Realm of the WWWAuthenicateHeader to the realm parameter value.
void	setResponse(java.lang.String response) Set the Response.
void	setScheme(java.lang.String scheme) Sets the scheme of the challenge information for this AuthenticationHeaderHeader.
void	setStale(boolean stale) Sets the value of the stale parameter of the WWWAuthenicateHeader to the stale parameter value.
void	setURI(javax.sip.address.URI uri) Sets the URI of the WWWAuthenicateHeader to the uri parameter value.
void	setUsername(java.lang.String username) Sets the Username of the AuthorizationHeader to the username parameter value.

クラス gov.nist.javax.sip.header.ParametersHeader から継承されたメソッド

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameters, setQuotedParameter

クラス gov.nist.javax.sip.header.SIPHeader から継承されたメソッド

encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

クラス gov.nist.javax.sip.header.SIPObject から継承されたメソッド

clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString

クラス gov.nist.core.GenericObject から継承されたメソッド

getClassFromName, getMatcher, isMySubclass, setMatcher

クラス java.lang.Object から継承されたメソッド

getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェース javax.sip.header.Header から継承されたメソッド

clone, equals, toString

フィールドの詳細

DOMAIN

public static java.lang.String DOMAIN

REALM

public static java.lang.String REALM

OPAQUE

public static java.lang.String OPAQUE

ALGORITHM

public static java.lang.String ALGORITHM

QOP

public static java.lang.String QOP

STALE

public static java.lang.String STALE

SIGNATURE

public static java.lang.String SIGNATURE

RESPONSE

public static java.lang.String RESPONSE

SIGNED_BY

public static java.lang.String SIGNED_BY

NC

public static java.lang.String NC

URI

public static java.lang.String URI

USERNAME

public static java.lang.String USERNAME

CNONCE

public static java.lang.String CNONCE

NONCE

public static java.lang.String NONCE

コンストラクタの詳細

AuthenticationHeader

public AuthenticationHeader(java.lang.String name)

AuthenticationHeader

public AuthenticationHeader()

メソッドの詳細

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
                  throws java.text.ParseException

set the specified parameter. Bug reported by Dominic Sparks.

定義:

インタフェース javax.sip.header.Parameters 内の setParameter

オーバーライド:

クラス ParametersHeader 内の setParameter

パラメータ:

name - -- name of the parameter

value - -- value of the parameter.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the parameter name or value.

setChallenge

public void setChallenge(Challenge challenge)

This is only used for the parser interface.

パラメータ:

challenge - -- the challenge from which the parameters are extracted.

encodeBody

public java.lang.String encodeBody()

Encode in canonical form.

戻り値:

canonical string.

setScheme

public void setScheme(java.lang.String scheme)

Sets the scheme of the challenge information for this AuthenticationHeaderHeader. For example, Digest.

パラメータ:

scheme - - the new string value that identifies the challenge information scheme.

導入されたバージョン:

v1.1

getScheme

public java.lang.String getScheme()

Returns the scheme of the challenge information for this AuthenticationHeaderHeader.

戻り値:

the string value of the challenge information.

導入されたバージョン:

v1.1

setRealm

public void setRealm(java.lang.String realm)
              throws java.text.ParseException

Sets the Realm of the WWWAuthenicateHeader 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.

パラメータ:

realm - the new Realm String of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the realm.

導入されたバージョン:

v1.1

getRealm

public java.lang.String getRealm()

Returns the Realm value of this WWWAuthenicateHeader. This convenience method returns only the realm of the complete Challenge.

戻り値:

the String representing the Realm information, null if value is not set.

導入されたバージョン:

v1.1

setNonce

public void setNonce(java.lang.String nonce)
              throws java.text.ParseException

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

パラメータ:

nonce - - the new nonce String of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the nonce value.

導入されたバージョン:

v1.1

getNonce

public java.lang.String getNonce()

Returns the Nonce value of this WWWAuthenicateHeader.

戻り値:

the String representing the nonce information, null if value is not set.

導入されたバージョン:

v1.1

setURI

public void setURI(javax.sip.address.URI uri)

Sets the URI of the WWWAuthenicateHeader to the uri parameter value.

パラメータ:

uri - - the new URI of this WWWAuthenicateHeader.

導入されたバージョン:

v1.1

getURI

public javax.sip.address.URI getURI()

Returns the URI value of this WWWAuthenicateHeader, for example DigestURI.

戻り値:

the URI representing the URI information, null if value is not set.

導入されたバージョン:

v1.1

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)
                  throws java.text.ParseException

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

パラメータ:

algorithm - - the new algorithm String of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the algorithm value.

導入されたバージョン:

v1.1

getAlgorithm

public java.lang.String getAlgorithm()

Returns the Algorithm value of this WWWAuthenicateHeader.

戻り値:

the String representing the Algorithm information, null if the value is not set.

導入されたバージョン:

v1.1

setQop

public void setQop(java.lang.String qop)
            throws java.text.ParseException

Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value.

パラメータ:

qop - - the new Qop string of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the Qop value.

導入されたバージョン:

v1.1

getQop

public java.lang.String getQop()

Returns the Qop value of this WWWAuthenicateHeader.

戻り値:

the string representing the Qop information, null if the value is not set.

導入されたバージョン:

v1.1

setOpaque

public void setOpaque(java.lang.String opaque)
               throws java.text.ParseException

Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value.

パラメータ:

opaque - - the new Opaque string of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the opaque value.

導入されたバージョン:

v1.1

getOpaque

public java.lang.String getOpaque()

Returns the Opaque value of this WWWAuthenicateHeader.

戻り値:

the String representing the Opaque information, null if the value is not set.

導入されたバージョン:

v1.1

setDomain

public void setDomain(java.lang.String domain)
               throws java.text.ParseException

Sets the Domain of the WWWAuthenicateHeader to the domain parameter value.

パラメータ:

domain - - the new Domain string of this WWWAuthenicateHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the domain.

導入されたバージョン:

v1.1

getDomain

public java.lang.String getDomain()

Returns the Domain value of this WWWAuthenicateHeader.

戻り値:

the String representing the Domain information, null if value is not set.

導入されたバージョン:

v1.1

setStale

public void setStale(boolean stale)

Sets the value of the stale parameter of the WWWAuthenicateHeader to the stale parameter value.

パラメータ:

stale - - the new boolean value of the stale parameter.

導入されたバージョン:

v1.1

isStale

public boolean isStale()

Returns the boolean value of the state paramater of this WWWAuthenicateHeader.

戻り値:

the boolean representing if the challenge is stale.

導入されたバージョン:

v1.1

setCNonce

public void setCNonce(java.lang.String cnonce)
               throws java.text.ParseException

Set the CNonce.

パラメータ:

cnonce - -- a nonce string.

例外:

java.text.ParseException

getCNonce

public java.lang.String getCNonce()

Get the CNonce.

戻り値:

the cnonce value.

getNonceCount

public int getNonceCount()

setNonceCount

public void setNonceCount(int param)
                   throws java.text.ParseException

Set the nonce count pakrameter. Bug fix sent in by Andreas Bystr�m

例外:

java.text.ParseException

getResponse

public java.lang.String getResponse()

Get the RESPONSE value (or null if it does not exist).

戻り値:

String response parameter value.

setResponse

public void setResponse(java.lang.String response)
                 throws java.text.ParseException

Set the Response.

パラメータ:

response - to set.

例外:

java.text.ParseException

getUsername

public java.lang.String getUsername()

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

戻り値:

the String representing the Username information, null if value is not set.

導入されたバージョン:

JAIN SIP v1.1

setUsername

public void setUsername(java.lang.String username)
                 throws java.text.ParseException

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

パラメータ:

username - the new Username String of this AuthorizationHeader.

例外:

java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the username.

導入されたバージョン:

JAIN SIP v1.1