NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header.ims
Interface SecurityAgreeHeader

All Superinterfaces:
Cloneable, Header, Parameters, Serializable
All Known Subinterfaces:
SecurityClientHeader, SecurityServerHeader, SecurityVerifyHeader
All Known Implementing Classes:
SecurityClient, SecurityServer, SecurityVerify

public interface SecurityAgreeHeader
extends Parameters, Header

"Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).

Headers: Security-Server + Security-Client + Security-Verify

Author:
Miguel Freitas (IT) PT-Inovacao

Method Summary
 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 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 interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Method Detail

setSecurityMechanism

void setSecurityMechanism(String secMech)
                          throws ParseException
Set security mechanism.

eg: Security-Client: ipsec-3gpp

Parameters:
secMech - - security mechanism name
Throws:
ParseException

setEncryptionAlgorithm

void setEncryptionAlgorithm(String ealg)
                            throws ParseException
Set Encryption Algorithm (ealg parameter)

Parameters:
ealg - - encryption algorithm value
Throws:
ParseException

setAlgorithm

void setAlgorithm(String alg)
                  throws ParseException
Set Algorithm (alg parameter)

Parameters:
alg - - algorithm value
Throws:
ParseException

setProtocol

void setProtocol(String prot)
                 throws ParseException
Set Protocol (prot paramater)

Parameters:
prot - - protocol value
Throws:
ParseException

setMode

void setMode(String mod)
             throws ParseException
Set Mode (mod parameter)

Parameters:
mod - - mode value
Throws:
ParseException

setSPIClient

void setSPIClient(int spic)
                  throws InvalidArgumentException
Set Client SPI (spi-c parameter)

Parameters:
spic - - spi-c value
Throws:
InvalidArgumentException

setSPIServer

void setSPIServer(int spis)
                  throws InvalidArgumentException
Set Server SPI (spi-s parameter)

Parameters:
spis - - spi-s value
Throws:
InvalidArgumentException - - when value is not valid

setPortClient

void setPortClient(int portC)
                   throws InvalidArgumentException
Set Client Port (port-c parameter)

Parameters:
portC - - port-c value
Throws:
InvalidArgumentException - - when value is not valid

setPortServer

void setPortServer(int portS)
                   throws InvalidArgumentException
Set Server Port (port-s parameter)

Parameters:
portS - - port-s value
Throws:
InvalidArgumentException - - when value is not valid

setPreference

void setPreference(float q)
                   throws InvalidArgumentException
Set Preference

Parameters:
q - - q parameter value
Throws:
InvalidArgumentException - - when value is not valid

getSecurityMechanism

String getSecurityMechanism()
Get Security Mechanism

Returns:
security mechanims value

getEncryptionAlgorithm

String getEncryptionAlgorithm()
Get Encryption Algorithm

Returns:
ealg parameter value

getAlgorithm

String getAlgorithm()
Get Algorithm

Returns:
alg parameter value

getProtocol

String getProtocol()
Get Protocol

Returns:
prot parameter value

getMode

String getMode()
Get Mode

Returns:
mod parameter value

getSPIClient

int getSPIClient()
Get Client SPI

Returns:
spi-c parameter value

getSPIServer

int getSPIServer()
Get Server SPI

Returns:
spi-s parameter value

getPortClient

int getPortClient()
Get Client Port

Returns:
port-c parameter value

getPortServer

int getPortServer()
Get Server Port

Returns:
port-s parameter value

getPreference

float getPreference()
Get Preference

Returns:
q parameter value

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.