|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.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.ims.SecurityAgree
public abstract class SecurityAgree
"Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
Headers: Security-Server + Security-Client + Security-Verify
Field Summary |
---|
Fields inherited from interface 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, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE |
Constructor Summary | |
---|---|
SecurityAgree()
Default constructor |
|
SecurityAgree(String name)
Constructor |
Method Summary | |
---|---|
Object |
clone()
Clones this object. |
String |
encodeBody()
Encode the body of this header (the stuff that follows headerName). |
boolean |
equals(Object other)
An introspection based equality predicate for SIPObjects. |
String |
getAlgorithm()
Get Algorithm |
String |
getEncryptionAlgorithm()
Get Encryption Algorithm |
String |
getMode()
Get Mode |
int |
getPortClient()
Get Client Port |
int |
getPortServer()
Get Server Port |
float |
getPreference()
Get Preference |
String |
getProtocol()
Get Protocol |
String |
getSecurityMechanism()
Get Security Mechanism |
int |
getSPIClient()
Get Client SPI |
int |
getSPIServer()
Get Server SPI |
void |
setAlgorithm(String alg)
Set Algorithm (alg parameter) |
void |
setEncryptionAlgorithm(String ealg)
Set Encryption Algorithm (ealg parameter) |
void |
setMode(String mod)
Set Mode (mod parameter) |
void |
setParameter(String name,
String value)
Sets the value of the specified parameter. |
void |
setPortClient(int portC)
Set Client Port (port-c parameter) |
void |
setPortServer(int portS)
Set Server Port (port-s parameter) |
void |
setPreference(float q)
Set Preference. |
void |
setProtocol(String prot)
Set Protocol (prot paramater) |
void |
setSecurityMechanism(String secMech)
Set security mechanism. |
void |
setSPIClient(int spic)
Set Client SPI (spi-c parameter) |
void |
setSPIServer(int spis)
Set Server SPI (spi-s parameter) |
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader |
---|
getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameters, setQuotedParameter |
Methods inherited from class gov.nist.javax.sip.header.SIPHeader |
---|
encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString |
Methods inherited from class gov.nist.javax.sip.header.SIPObject |
---|
dbgPrint, debugDump, debugDump, match |
Methods inherited from class gov.nist.core.GenericObject |
---|
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SecurityAgree(String name)
name
- - name of the Security Agree header to createpublic SecurityAgree()
Method Detail |
---|
public void setParameter(String name, String value) throws ParseException
ParametersHeader
setParameter
in interface Parameters
setParameter
in class ParametersHeader
name
- - a String specifying the parameter namevalue
- - a String specifying the parameter value
ParseException
- which signals that an error has been reached
unexpectedly while parsing the parameter name or value.public String encodeBody()
SIPHeader
public void setSecurityMechanism(String secMech) throws ParseException
eg: Security-Client: ipsec-3gpp
secMech
- - security mechanism name
ParseException
public void setEncryptionAlgorithm(String ealg) throws ParseException
ealg
- - encryption algorithm value
ParseException
public void setAlgorithm(String alg) throws ParseException
alg
- - algorithm value
ParseException
public void setProtocol(String prot) throws ParseException
prot
- - protocol value
ParseException
public void setMode(String mod) throws ParseException
mod
- - mode value
ParseException
public void setSPIClient(int spic) throws InvalidArgumentException
spic
- - spi-c value
InvalidArgumentException
public void setSPIServer(int spis) throws InvalidArgumentException
spis
- - spi-s value
InvalidArgumentException
- - when value is not validpublic void setPortClient(int portC) throws InvalidArgumentException
portC
- - port-c value
InvalidArgumentException
- - when value is not validpublic void setPortServer(int portS) throws InvalidArgumentException
portS
- - port-s value
InvalidArgumentException
- - when value is not validpublic void setPreference(float q) throws InvalidArgumentException
Set Preference. The "q" parameter indicates a relative preference for the particular mechanism. The higher the value the more preferred the mechanism is. Range from 0.001 to 0.999.
q
- - q parameter value
InvalidArgumentException
- - when value is not validpublic String getSecurityMechanism()
public String getEncryptionAlgorithm()
public String getAlgorithm()
public String getProtocol()
public String getMode()
public int getSPIClient()
public int getSPIServer()
public int getPortClient()
public int getPortServer()
public float getPreference()
public boolean equals(Object other)
SIPObject
equals
in interface Header
equals
in class SIPObject
other
- the other object to test against.
public Object clone()
gov.nist.core.GenericObject
clone
in interface Header
clone
in class ParametersHeader
|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |